cdist manpages update: 4.0.0
This commit is contained in:
Darko Poljak
parent
ed66866b47
commit
4a6cbfe8a8
110 changed files with 5472 additions and 0 deletions
31
blog/cdist-4.0.0-released.mdwn
Normal file
31
blog/cdist-4.0.0-released.mdwn
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
[[!meta title="Cdist 4.0.0 released"]]
|
||||||
|
|
||||||
|
Here's a short overview about the changes found in version 4.0.0:
|
||||||
|
|
||||||
|
* Core: Fix bug with parallel hosts operation when output path is specifed (Darko Poljak)
|
||||||
|
* Type __package_pip: Add support for running as specified user (useful for pip in venv) (Darko Poljak)
|
||||||
|
* New type: __pyvenv: Manage python virtualenv (Darko Poljak)
|
||||||
|
* Core: Add CDIST_REMOTE_COPY/EXEC env variables and multiplexing options for default scp/ssh (Darko Poljak)
|
||||||
|
* Types: Remove bashisms in scripts (Darko Poljak)
|
||||||
|
* Core: Fix bug in remote command with environment (Darko Poljak)
|
||||||
|
* Core: Fix bug in local code execution (Darko Poljak)
|
||||||
|
* Documentation: Fix spelling in manual pages (Dmitry Bogatov)
|
||||||
|
* New type: __pacman_conf: Manage pacman.conf (Dominique Roux)
|
||||||
|
* New type: __pacman_conf_integrate: cdist compatible pacman.conf (Dominique Roux)
|
||||||
|
* Type __consul: Do not install unused package unzip (Steven Armstrong)
|
||||||
|
* Type __consul: Add source & cksum for 0.5.2 (Steven Armstrong)
|
||||||
|
* Core: Support object ids '.cdist' (Nico Schottelius)
|
||||||
|
* Type __apt_norecommends: Also setup autoremove options (Dmitry Bogatov)
|
||||||
|
* Type __user_groups: Add NetBSD support (Jonathan A. Kollasch)
|
||||||
|
* Type __timezone: Add NetBSD support (Jonathan A. Kollasch)
|
||||||
|
* Type __ccollect_source: Add NetBSD support (Jonathan A. Kollasch)
|
||||||
|
* Type __directory: Add NetBSD support (Jonathan A. Kollasch)
|
||||||
|
* Type __file: Add NetBSD support (Jonathan A. Kollasch)
|
||||||
|
* Type __group: Add NetBSD support (Jonathan A. Kollasch)
|
||||||
|
* Type __consul: Add new consul versions (Nico Schottelius)
|
||||||
|
* Type __apt_ppa: Do not install legacy package python-software-properties (Steven Armstrong)
|
||||||
|
|
||||||
|
|
||||||
|
For more information visit the [[cdist homepage|software/cdist]].
|
||||||
|
|
||||||
|
[[!tag cdist config unix]]
|
||||||
122
software/cdist/man/4.0.0/man1/cdist.html
Normal file
122
software/cdist/man/4.0.0/man1/cdist.html
Normal file
|
|
@ -0,0 +1,122 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist(1)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist(1)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60474448"></a>cdist(1)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_synopsis">2. SYNOPSIS</a></span></dt><dt><span class="section"><a href="#_description">3. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_general">4. GENERAL</a></span></dt><dt><span class="section"><a href="#_banner">5. BANNER</a></span></dt><dt><span class="section"><a href="#_config">6. CONFIG</a></span></dt><dt><span class="section"><a href="#_shell">7. SHELL</a></span></dt><dt><span class="section"><a href="#_examples">8. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_environment">9. ENVIRONMENT</a></span></dt><dt><span class="section"><a href="#_exit_status">10. EXIT STATUS</a></span></dt><dt><span class="section"><a href="#_see_also">11. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">12. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist - Usable Configuration Management</p></div><div class="section" title="2. SYNOPSIS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_synopsis"></a>2. SYNOPSIS</h2></div></div></div><p>cdist [-h] [-d] [-v] [-V] {banner,config,shell} …</p><p>cdist banner [-h] [-d] [-v]</p><p>cdist config [-h] [-d] [-V] [-c CONF_DIR] [-i MANIFEST] [-p] [-s] host [host …]</p><p>cdist shell [-h] [-d] [-v] [-s SHELL]</p></div><div class="section" title="3. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>3. DESCRIPTION</h2></div></div></div><p>cdist is the frontend executable to the cdist configuration management.
|
||||||
|
cdist supports different subcommands as explained below.</p></div><div class="section" title="4. GENERAL"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_general"></a>4. GENERAL</h2></div></div></div><p>All commands accept the following options:</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
-d, --debug
|
||||||
|
</span></dt><dd>
|
||||||
|
Set log level to debug
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-h, --help
|
||||||
|
</span></dt><dd>
|
||||||
|
Show the help screen
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-v, --verbose
|
||||||
|
</span></dt><dd>
|
||||||
|
Set log level to info, be more verbose
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-V, --version
|
||||||
|
</span></dt><dd>
|
||||||
|
Show version and exit
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BANNER"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_banner"></a>5. BANNER</h2></div></div></div><p>Displays the cdist banner. Useful for printing
|
||||||
|
cdist posters - a must have for every office.</p></div><div class="section" title="6. CONFIG"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_config"></a>6. CONFIG</h2></div></div></div><p>Configure one or more hosts</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
-h, --help
|
||||||
|
</span></dt><dd>
|
||||||
|
Show the help screen
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-c CONF_DIR, --conf-dir CONF_DIR
|
||||||
|
</span></dt><dd>
|
||||||
|
Add a configuration directory. Can be specified multiple times.
|
||||||
|
If configuration directories contain conflicting types, explorers or
|
||||||
|
manifests, then the last one found is used. Additionally this can also
|
||||||
|
be configured by setting the CDIST_PATH environment variable to a colon
|
||||||
|
delimited list of config directories. Directories given with the
|
||||||
|
--conf-dir argument have higher precedence over those set through the
|
||||||
|
environment variable.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-i MANIFEST, --initial-manifest MANIFEST
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to a cdist manifest or - to read from stdin
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-p, --parallel
|
||||||
|
</span></dt><dd>
|
||||||
|
Operate on multiple hosts in parallel
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
-s, --sequential
|
||||||
|
</span></dt><dd>
|
||||||
|
Operate on multiple hosts sequentially
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
--remote-copy REMOTE_COPY
|
||||||
|
</span></dt><dd>
|
||||||
|
Command to use for remote copy (should behave like scp)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
--remote-exec REMOTE_EXEC
|
||||||
|
</span></dt><dd>
|
||||||
|
Command to use for remote execution (should behave like ssh)
|
||||||
|
</dd></dl></div></div><div class="section" title="7. SHELL"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_shell"></a>7. SHELL</h2></div></div></div><p>This command allows you to spawn a shell that enables access
|
||||||
|
to the types as commands. It can be thought as an
|
||||||
|
"interactive manifest" environment. See below for example
|
||||||
|
usage. Its primary use is for debugging type parameters.</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
-s/--shell
|
||||||
|
</span></dt><dd>
|
||||||
|
Select shell to use, defaults to current shell
|
||||||
|
</dd></dl></div></div><div class="section" title="8. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>8. EXAMPLES</h2></div></div></div><pre class="screen"># Configure ikq05.ethz.ch with debug enabled
|
||||||
|
% cdist config -d ikq05.ethz.ch
|
||||||
|
|
||||||
|
# Configure hosts in parallel and use a different configuration directory
|
||||||
|
% cdist config -c ~/p/cdist-nutzung \
|
||||||
|
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
|
||||||
|
|
||||||
|
# Use custom remote exec / copy commands
|
||||||
|
% cdist config --remote-exec /path/to/my/remote/exec \
|
||||||
|
--remote-copy /path/to/my/remote/copy \
|
||||||
|
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
|
||||||
|
|
||||||
|
# Display banner
|
||||||
|
cdist banner
|
||||||
|
|
||||||
|
# Show help
|
||||||
|
% cdist --help
|
||||||
|
|
||||||
|
# Show Version
|
||||||
|
% cdist --version
|
||||||
|
|
||||||
|
# Enter a shell that has access to emulated types
|
||||||
|
% cdist shell
|
||||||
|
% __git
|
||||||
|
usage: __git --source SOURCE [--state STATE] [--branch BRANCH]
|
||||||
|
[--group GROUP] [--owner OWNER] [--mode MODE] object_id</pre></div><div class="section" title="9. ENVIRONMENT"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment"></a>9. ENVIRONMENT</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
TMPDIR, TEMP, TMP
|
||||||
|
</span></dt><dd>
|
||||||
|
Setup the base directory for the temporary directory.
|
||||||
|
See <a class="ulink" href="http://docs.python.org/py3k/library/tempfile.html" target="_top">http://docs.python.org/py3k/library/tempfile.html</a> for
|
||||||
|
more information. This is rather useful, if the standard
|
||||||
|
directory used does not allow executables.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_LOCAL_SHELL
|
||||||
|
</span></dt><dd>
|
||||||
|
Selects shell for local script execution, defaults to /bin/sh
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_REMOTE_SHELL
|
||||||
|
</span></dt><dd>
|
||||||
|
Selects shell for remote scirpt execution, defaults to /bin/sh
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_REMOTE_EXEC
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this command for remote execution (should behave like ssh)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_REMOTE_COPY
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this command for remote copy (should behave like scp)
|
||||||
|
</dd></dl></div></div><div class="section" title="10. EXIT STATUS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_exit_status"></a>10. EXIT STATUS</h2></div></div></div><p>The following exit values shall be returned:</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
0
|
||||||
|
</span></dt><dd>
|
||||||
|
Successful completion
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
1
|
||||||
|
</span></dt><dd>
|
||||||
|
One or more host configurations failed
|
||||||
|
</dd></dl></div></div><div class="section" title="11. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>11. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist.html">cdist(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-reference.html">cdist-reference(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="12. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>12. COPYING</h2></div></div></div><p>Copyright (C) 2011-2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
329
software/cdist/man/4.0.0/man1/docbook-xsl.css
Normal file
329
software/cdist/man/4.0.0/man1/docbook-xsl.css
Normal file
|
|
@ -0,0 +1,329 @@
|
||||||
|
/*
|
||||||
|
CSS stylesheet for XHTML produced by DocBook XSL stylesheets.
|
||||||
|
*/
|
||||||
|
|
||||||
|
body {
|
||||||
|
font-family: Georgia,serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
code, pre {
|
||||||
|
font-family: "Courier New", Courier, monospace;
|
||||||
|
}
|
||||||
|
|
||||||
|
span.strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
body blockquote {
|
||||||
|
margin-top: .75em;
|
||||||
|
line-height: 1.5;
|
||||||
|
margin-bottom: .75em;
|
||||||
|
}
|
||||||
|
|
||||||
|
html body {
|
||||||
|
margin: 1em 5% 1em 5%;
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
body div {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6
|
||||||
|
{
|
||||||
|
color: #527bbd;
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.toc p:first-child,
|
||||||
|
div.list-of-figures p:first-child,
|
||||||
|
div.list-of-tables p:first-child,
|
||||||
|
div.list-of-examples p:first-child,
|
||||||
|
div.example p.title,
|
||||||
|
div.sidebar p.title
|
||||||
|
{
|
||||||
|
font-weight: bold;
|
||||||
|
color: #527bbd;
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
margin-bottom: 0.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h1 {
|
||||||
|
margin: .0em 0 0 -4%;
|
||||||
|
line-height: 1.3;
|
||||||
|
border-bottom: 2px solid silver;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h2 {
|
||||||
|
margin: 0.5em 0 0 -4%;
|
||||||
|
line-height: 1.3;
|
||||||
|
border-bottom: 2px solid silver;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h3 {
|
||||||
|
margin: .8em 0 0 -3%;
|
||||||
|
line-height: 1.3;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h4 {
|
||||||
|
margin: .8em 0 0 -3%;
|
||||||
|
line-height: 1.3;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h5 {
|
||||||
|
margin: .8em 0 0 -2%;
|
||||||
|
line-height: 1.3;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h6 {
|
||||||
|
margin: .8em 0 0 -1%;
|
||||||
|
line-height: 1.3;
|
||||||
|
}
|
||||||
|
|
||||||
|
body hr {
|
||||||
|
border: none; /* Broken on IE6 */
|
||||||
|
}
|
||||||
|
div.footnotes hr {
|
||||||
|
border: 1px solid silver;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.navheader th, div.navheader td, div.navfooter td {
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
font-size: 0.9em;
|
||||||
|
font-weight: bold;
|
||||||
|
color: #527bbd;
|
||||||
|
}
|
||||||
|
div.navheader img, div.navfooter img {
|
||||||
|
border-style: none;
|
||||||
|
}
|
||||||
|
div.navheader a, div.navfooter a {
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
div.navfooter hr {
|
||||||
|
border: 1px solid silver;
|
||||||
|
}
|
||||||
|
|
||||||
|
body td {
|
||||||
|
line-height: 1.2
|
||||||
|
}
|
||||||
|
|
||||||
|
body th {
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
ol {
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul, body dir, body menu {
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
html {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
body h1, body h2, body h3, body h4, body h5, body h6 {
|
||||||
|
margin-left: 0
|
||||||
|
}
|
||||||
|
|
||||||
|
body pre {
|
||||||
|
margin: 0.5em 10% 0.5em 1em;
|
||||||
|
line-height: 1.0;
|
||||||
|
color: navy;
|
||||||
|
}
|
||||||
|
|
||||||
|
tt.literal, code.literal {
|
||||||
|
color: navy;
|
||||||
|
}
|
||||||
|
|
||||||
|
.programlisting, .screen {
|
||||||
|
border: 1px solid silver;
|
||||||
|
background: #f4f4f4;
|
||||||
|
margin: 0.5em 10% 0.5em 0;
|
||||||
|
padding: 0.5em 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sidebar {
|
||||||
|
background: #ffffee;
|
||||||
|
margin: 1.0em 10% 0.5em 0;
|
||||||
|
padding: 0.5em 1em;
|
||||||
|
border: 1px solid silver;
|
||||||
|
}
|
||||||
|
div.sidebar * { padding: 0; }
|
||||||
|
div.sidebar div { margin: 0; }
|
||||||
|
div.sidebar p.title {
|
||||||
|
margin-top: 0.5em;
|
||||||
|
margin-bottom: 0.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.bibliomixed {
|
||||||
|
margin: 0.5em 5% 0.5em 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.glossary dt {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
div.glossary dd p {
|
||||||
|
margin-top: 0.2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dl {
|
||||||
|
margin: .8em 0;
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt {
|
||||||
|
margin-top: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
dt span.term {
|
||||||
|
font-style: normal;
|
||||||
|
color: navy;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.variablelist dd p {
|
||||||
|
margin-top: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.itemizedlist li, div.orderedlist li {
|
||||||
|
margin-left: -0.8em;
|
||||||
|
margin-top: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul, ol {
|
||||||
|
list-style-position: outside;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.sidebar ul, div.sidebar ol {
|
||||||
|
margin-left: 2.8em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.itemizedlist p.title,
|
||||||
|
div.orderedlist p.title,
|
||||||
|
div.variablelist p.title
|
||||||
|
{
|
||||||
|
margin-bottom: -0.8em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.revhistory table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border: none;
|
||||||
|
}
|
||||||
|
div.revhistory th {
|
||||||
|
border: none;
|
||||||
|
color: #527bbd;
|
||||||
|
font-family: Arial,Helvetica,sans-serif;
|
||||||
|
}
|
||||||
|
div.revhistory td {
|
||||||
|
border: 1px solid silver;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Keep TOC and index lines close together. */
|
||||||
|
div.toc dl, div.toc dt,
|
||||||
|
div.list-of-figures dl, div.list-of-figures dt,
|
||||||
|
div.list-of-tables dl, div.list-of-tables dt,
|
||||||
|
div.indexdiv dl, div.indexdiv dt
|
||||||
|
{
|
||||||
|
line-height: normal;
|
||||||
|
margin-top: 0;
|
||||||
|
margin-bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Table styling does not work because of overriding attributes in
|
||||||
|
generated HTML.
|
||||||
|
*/
|
||||||
|
div.table table,
|
||||||
|
div.informaltable table
|
||||||
|
{
|
||||||
|
margin-left: 0;
|
||||||
|
margin-right: 5%;
|
||||||
|
margin-bottom: 0.8em;
|
||||||
|
}
|
||||||
|
div.informaltable table
|
||||||
|
{
|
||||||
|
margin-top: 0.4em
|
||||||
|
}
|
||||||
|
div.table thead,
|
||||||
|
div.table tfoot,
|
||||||
|
div.table tbody,
|
||||||
|
div.informaltable thead,
|
||||||
|
div.informaltable tfoot,
|
||||||
|
div.informaltable tbody
|
||||||
|
{
|
||||||
|
/* No effect in IE6. */
|
||||||
|
border-top: 3px solid #527bbd;
|
||||||
|
border-bottom: 3px solid #527bbd;
|
||||||
|
}
|
||||||
|
div.table thead, div.table tfoot,
|
||||||
|
div.informaltable thead, div.informaltable tfoot
|
||||||
|
{
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.mediaobject img {
|
||||||
|
margin-bottom: 0.8em;
|
||||||
|
}
|
||||||
|
div.figure p.title,
|
||||||
|
div.table p.title
|
||||||
|
{
|
||||||
|
margin-top: 1em;
|
||||||
|
margin-bottom: 0.4em;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.calloutlist p
|
||||||
|
{
|
||||||
|
margin-top: 0em;
|
||||||
|
margin-bottom: 0.4em;
|
||||||
|
}
|
||||||
|
|
||||||
|
a img {
|
||||||
|
border-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
@media print {
|
||||||
|
div.navheader, div.navfooter { display: none; }
|
||||||
|
}
|
||||||
|
|
||||||
|
span.aqua { color: aqua; }
|
||||||
|
span.black { color: black; }
|
||||||
|
span.blue { color: blue; }
|
||||||
|
span.fuchsia { color: fuchsia; }
|
||||||
|
span.gray { color: gray; }
|
||||||
|
span.green { color: green; }
|
||||||
|
span.lime { color: lime; }
|
||||||
|
span.maroon { color: maroon; }
|
||||||
|
span.navy { color: navy; }
|
||||||
|
span.olive { color: olive; }
|
||||||
|
span.purple { color: purple; }
|
||||||
|
span.red { color: red; }
|
||||||
|
span.silver { color: silver; }
|
||||||
|
span.teal { color: teal; }
|
||||||
|
span.white { color: white; }
|
||||||
|
span.yellow { color: yellow; }
|
||||||
|
|
||||||
|
span.aqua-background { background: aqua; }
|
||||||
|
span.black-background { background: black; }
|
||||||
|
span.blue-background { background: blue; }
|
||||||
|
span.fuchsia-background { background: fuchsia; }
|
||||||
|
span.gray-background { background: gray; }
|
||||||
|
span.green-background { background: green; }
|
||||||
|
span.lime-background { background: lime; }
|
||||||
|
span.maroon-background { background: maroon; }
|
||||||
|
span.navy-background { background: navy; }
|
||||||
|
span.olive-background { background: olive; }
|
||||||
|
span.purple-background { background: purple; }
|
||||||
|
span.red-background { background: red; }
|
||||||
|
span.silver-background { background: silver; }
|
||||||
|
span.teal-background { background: teal; }
|
||||||
|
span.white-background { background: white; }
|
||||||
|
span.yellow-background { background: yellow; }
|
||||||
|
|
||||||
|
span.big { font-size: 2em; }
|
||||||
|
span.small { font-size: 0.6em; }
|
||||||
|
|
||||||
|
span.underline { text-decoration: underline; }
|
||||||
|
span.overline { text-decoration: overline; }
|
||||||
|
span.line-through { text-decoration: line-through; }
|
||||||
148
software/cdist/man/4.0.0/man7/cdist-best-practice.html
Normal file
148
software/cdist/man/4.0.0/man7/cdist-best-practice.html
Normal file
|
|
@ -0,0 +1,148 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-best-practice(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-best-practice(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-best-practice(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_passwordless_connections">2. PASSWORDLESS CONNECTIONS</a></span></dt><dt><span class="section"><a href="#_speeding_up_ssh_connections">3. SPEEDING UP SSH CONNECTIONS</a></span></dt><dt><span class="section"><a href="#_speeding_up_shell_execution">4. SPEEDING UP SHELL EXECUTION</a></span></dt><dt><span class="section"><a href="#_multi_master_or_environment_setups">5. MULTI MASTER OR ENVIRONMENT SETUPS</a></span></dt><dt><span class="section"><a href="#_seperating_work_by_groups">6. SEPERATING WORK BY GROUPS</a></span></dt><dt><span class="section"><a href="#_maintaining_multiple_configurations">7. MAINTAINING MULTIPLE CONFIGURATIONS</a></span></dt><dt><span class="section"><a href="#_multiple_developers_with_different_trust">8. MULTIPLE DEVELOPERS WITH DIFFERENT TRUST</a></span></dt><dt><span class="section"><a href="#_templating">9. TEMPLATING</a></span></dt><dt><span class="section"><a href="#_testing_a_new_type">10. TESTING A NEW TYPE</a></span></dt><dt><span class="section"><a href="#_other_content_in_cdist_repository">11. OTHER CONTENT IN CDIST REPOSITORY</a></span></dt><dt><span class="section"><a href="#_see_also">12. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">13. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-best-practice - Practices used in real environments</p></div><div class="section" title="2. PASSWORDLESS CONNECTIONS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_passwordless_connections"></a>2. PASSWORDLESS CONNECTIONS</h2></div></div></div><p>It is recommended to run cdist with public key authentication.
|
||||||
|
This requires a private/public key pair and the entry
|
||||||
|
"PermitRootLogin without-password" in the sshd server.
|
||||||
|
See sshd_config(5) and <a href="../man1/ssh-keygen.html">ssh-keygen(1)</a>.</p></div><div class="section" title="3. SPEEDING UP SSH CONNECTIONS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_speeding_up_ssh_connections"></a>3. SPEEDING UP SSH CONNECTIONS</h2></div></div></div><p>When connecting to a new host, the initial delay with ssh connections
|
||||||
|
is pretty big. You can work around this by
|
||||||
|
"sharing of multiple sessions over a single network connection"
|
||||||
|
(quote from ssh_config(5)). The following code is suitable for
|
||||||
|
inclusion into your ~/.ssh/config:</p><pre class="screen">Host *
|
||||||
|
ControlPath ~/.ssh/master-%l-%r@%h:%p
|
||||||
|
ControlMaster auto
|
||||||
|
ControlPersist 10</pre></div><div class="section" title="4. SPEEDING UP SHELL EXECUTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_speeding_up_shell_execution"></a>4. SPEEDING UP SHELL EXECUTION</h2></div></div></div><p>On the source host, ensure that /bin/sh is <span class="strong"><strong>not</strong></span> bash: bash is quite slow for
|
||||||
|
script execution. Instead, you could use dash after installing it:</p><pre class="screen">ln -sf /bin/dash /bin/sh</pre></div><div class="section" title="5. MULTI MASTER OR ENVIRONMENT SETUPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_multi_master_or_environment_setups"></a>5. MULTI MASTER OR ENVIRONMENT SETUPS</h2></div></div></div><p>If you plan to distribute cdist among servers or use different
|
||||||
|
environments, you can do so easily with the included version
|
||||||
|
control git. For instance if you plan to use the typical three
|
||||||
|
environments production, integration and development, you can
|
||||||
|
realise this with git branches:</p><pre class="screen"># Go to cdist checkout
|
||||||
|
cd /path/to/cdist
|
||||||
|
|
||||||
|
# Create branches
|
||||||
|
git branch development
|
||||||
|
git branch integration
|
||||||
|
git branch production
|
||||||
|
|
||||||
|
# Make use of a branch, for instance production
|
||||||
|
git checkout production</pre><p>Similar if you want to have cdist checked out at multiple machines,
|
||||||
|
you can clone it multiple times:</p><pre class="screen">machine-a % git clone git://your-git-server/cdist
|
||||||
|
machine-b % git clone git://your-git-server/cdist</pre></div><div class="section" title="6. SEPERATING WORK BY GROUPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_seperating_work_by_groups"></a>6. SEPERATING WORK BY GROUPS</h2></div></div></div><p>If you are working with different groups on one cdist-configuration,
|
||||||
|
you can delegate to other manifests and have the groups edit only
|
||||||
|
their manifests. You can use the following snippet in
|
||||||
|
<span class="strong"><strong>conf/manifests/init</strong></span>:</p><pre class="screen"># Include other groups
|
||||||
|
sh -e "$__manifest/systems"
|
||||||
|
|
||||||
|
sh -e "$__manifest/cbrg"</pre></div><div class="section" title="7. MAINTAINING MULTIPLE CONFIGURATIONS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_maintaining_multiple_configurations"></a>7. MAINTAINING MULTIPLE CONFIGURATIONS</h2></div></div></div><p>When you need to manage multiple sites with cdist, like company_a, company_b
|
||||||
|
and private for instance, you can easily use git for this purpose.
|
||||||
|
Including a possible common base that is reused accross the different sites:</p><pre class="screen"># create branches
|
||||||
|
git branch company_a company_b common private
|
||||||
|
|
||||||
|
# make stuff for company a
|
||||||
|
git checkout company_a
|
||||||
|
# work, commit, etc.
|
||||||
|
|
||||||
|
# make stuff for company b
|
||||||
|
git checkout company_b
|
||||||
|
# work, commit, etc.
|
||||||
|
|
||||||
|
# make stuff relevant for all sites
|
||||||
|
git checkout common
|
||||||
|
# work, commit, etc.
|
||||||
|
|
||||||
|
# change to private and include latest common stuff
|
||||||
|
git checkout private
|
||||||
|
git merge common</pre><p>The following <span class="strong"><strong>.git/config</strong></span> is taken from a a real world scenario:</p><pre class="screen"># Track upstream, merge from time to time
|
||||||
|
[remote "upstream"]
|
||||||
|
url = git://git.schottelius.org/cdist
|
||||||
|
fetch = +refs/heads/*:refs/remotes/upstream/*
|
||||||
|
|
||||||
|
# Same as upstream, but works when being offline
|
||||||
|
[remote "local"]
|
||||||
|
fetch = +refs/heads/*:refs/remotes/local/*
|
||||||
|
url = /home/users/nico/p/cdist
|
||||||
|
|
||||||
|
# Remote containing various ETH internal branches
|
||||||
|
[remote "eth"]
|
||||||
|
url = sans.ethz.ch:/home/services/sans/git/cdist-eth
|
||||||
|
fetch = +refs/heads/*:refs/remotes/eth/*
|
||||||
|
|
||||||
|
# Public remote that contains my private changes to cdist upstream
|
||||||
|
[remote "nico"]
|
||||||
|
url = git.schottelius.org:/home/services/git/cdist-nico
|
||||||
|
fetch = +refs/heads/*:refs/remotes/nico/*
|
||||||
|
|
||||||
|
# The "nico" branch will be synced with the remote nico, branch master
|
||||||
|
[branch "nico"]
|
||||||
|
remote = nico
|
||||||
|
merge = refs/heads/master
|
||||||
|
|
||||||
|
# ETH stable contains rock solid configurations used in various places
|
||||||
|
[branch "eth-stable"]
|
||||||
|
remote = eth
|
||||||
|
merge = refs/heads/stable</pre><p>Have a look at <a href="../man1/git-remote.html">git-remote(1)</a> to adjust the remote configuration, which allows</p></div><div class="section" title="8. MULTIPLE DEVELOPERS WITH DIFFERENT TRUST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_multiple_developers_with_different_trust"></a>8. MULTIPLE DEVELOPERS WITH DIFFERENT TRUST</h2></div></div></div><p>If you are working in an environment that requires different people to
|
||||||
|
work on the same configuration, but having different privileges, you can
|
||||||
|
implement this scenario with a gateway host and sudo:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
Create a dedicated user (for instance <span class="strong"><strong>cdist</strong></span>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
Setup the ssh-pubkey for this user that has the right to configure all hosts
|
||||||
|
</li><li class="listitem">
|
||||||
|
Create a wrapper to update the cdist configuration in ~cdist/cdist
|
||||||
|
</li><li class="listitem">
|
||||||
|
Allow every developer to execute this script via sudo as the user cdist
|
||||||
|
</li><li class="listitem">
|
||||||
|
Allow run of cdist as user cdist on specific hosts on a per user/group base
|
||||||
|
</li><li class="listitem">
|
||||||
|
f.i. nico ALL=(ALL) NOPASSWD: /home/cdist/bin/cdist config hostabc
|
||||||
|
</li></ul></div><p>For more details consult sudoers(5)</p></div><div class="section" title="9. TEMPLATING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_templating"></a>9. TEMPLATING</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
create directory files/ in your type (convention)
|
||||||
|
</li><li class="listitem">
|
||||||
|
create the template as an executable file like files/basic.conf.sh, it will output text using shell variables for the values
|
||||||
|
</li></ul></div><pre class="screen">#!/bin/sh
|
||||||
|
# in the template, use cat << eof (here document) to output the text
|
||||||
|
# and use standard shell variables in the template
|
||||||
|
# output everything in the template script to stdout
|
||||||
|
cat << EOF
|
||||||
|
server {
|
||||||
|
listen 80;
|
||||||
|
server_name $SERVERNAME;
|
||||||
|
root $ROOT;
|
||||||
|
|
||||||
|
access_log /var/log/nginx/$SERVERNAME_access.log
|
||||||
|
error_log /var/log/nginx/$SERVERNAME_error.log
|
||||||
|
}
|
||||||
|
EOF</pre><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
in the manifest, export the relevant variables and add the following lines in your manifest:
|
||||||
|
</li></ul></div><pre class="screen"># export variables needed for the template
|
||||||
|
export SERVERNAME='test"
|
||||||
|
export ROOT='/var/www/test'
|
||||||
|
# render the template
|
||||||
|
mkdir -p "$__object/files"
|
||||||
|
"$__type/files/basic.conf.sh" > "$__object/files/basic.conf"
|
||||||
|
# send the rendered template
|
||||||
|
__file /etc/nginx/sites-available/test.conf \
|
||||||
|
--state present
|
||||||
|
--source "$__object/files/basic.conf"</pre></div><div class="section" title="10. TESTING A NEW TYPE"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_testing_a_new_type"></a>10. TESTING A NEW TYPE</h2></div></div></div><p>If you want to test a new type on a node, you can tell cdist to only use an
|
||||||
|
object of this type: Use the <span class="emphasis"><em>--initial-manifest</em></span> parameter
|
||||||
|
with - (stdin) as argument and feed object into stdin
|
||||||
|
of cdist:</p><pre class="screen"># Singleton type without parameter
|
||||||
|
echo __ungleich_munin_server | cdist --initial-manifest - munin.panter.ch
|
||||||
|
|
||||||
|
# Singleton type with parameter
|
||||||
|
echo __ungleich_munin_node --allow 1.2.3.4 | \
|
||||||
|
cdist --initial-manifest - rails-19.panter.ch
|
||||||
|
|
||||||
|
# Normal type
|
||||||
|
echo __file /tmp/stdintest --mode 0644 | \
|
||||||
|
cdist --initial-manifest - cdist-dev-01.ungleich.ch</pre></div><div class="section" title="11. OTHER CONTENT IN CDIST REPOSITORY"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_other_content_in_cdist_repository"></a>11. OTHER CONTENT IN CDIST REPOSITORY</h2></div></div></div><p>Usually the cdist repository contains all configuration
|
||||||
|
items. Sometimes you may have additional resources that
|
||||||
|
you would like to store in your central configuration
|
||||||
|
repositiory (like password files from KeepassX,
|
||||||
|
Libreoffice diagrams, etc.).</p><p>It is recommended to use a subfolder named "non-cdist"
|
||||||
|
in the repository for such content: It allows you to
|
||||||
|
easily distinguish what is used by cdist and what not
|
||||||
|
and also to store all important files in one
|
||||||
|
repository.</p></div><div class="section" title="12. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>12. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-tutorial.html">cdist-tutorial(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="13. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>13. COPYING</h2></div></div></div><p>Copyright (C) 2011-2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
76
software/cdist/man/4.0.0/man7/cdist-bootstrap.html
Normal file
76
software/cdist/man/4.0.0/man7/cdist-bootstrap.html
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-bootstrap(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-bootstrap(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-bootstrap(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_introduction">2. INTRODUCTION</a></span></dt><dt><span class="section"><a href="#_location">3. LOCATION</a></span></dt><dt><span class="section"><a href="#_setup_working_directory_and_branch">4. SETUP WORKING DIRECTORY AND BRANCH</a></span></dt><dt><span class="section"><a href="#_publishing_the_configuration">5. PUBLISHING THE CONFIGURATION</a></span></dt><dt><span class="section"><a href="#_updating_from_origin">6. UPDATING FROM ORIGIN</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-bootstrap - setup cdist environment</p></div><div class="section" title="2. INTRODUCTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_introduction"></a>2. INTRODUCTION</h2></div></div></div><p>This document describes the usual steps recommended for a new
|
||||||
|
cdist setup. It is recommended that you have read and understood
|
||||||
|
<a href="../man7/cdist-quickstart.html">cdist-quickstart(7)</a> before digging into this.</p></div><div class="section" title="3. LOCATION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_location"></a>3. LOCATION</h2></div></div></div><p>First of all, you should think about where to store your configuration
|
||||||
|
database and who will be accessing or changing it. Secondly you have to
|
||||||
|
think about where to configure your hosts from, which may be a different
|
||||||
|
location.</p><p>For starters, having cdist (which includes the configuration database) on
|
||||||
|
your notebook should be fine.
|
||||||
|
Additionally an external copy of the git repository the configuration
|
||||||
|
relies on is recommended, for use as backup as well as to allow easy collaboration
|
||||||
|
with others.</p><p>For more sophisticated setups developing cdist configurations with multiple
|
||||||
|
people, have a look at <a href="../man7/cdist-best-practice.html">cdist-best-practice(7)</a>.</p></div><div class="section" title="4. SETUP WORKING DIRECTORY AND BRANCH"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_setup_working_directory_and_branch"></a>4. SETUP WORKING DIRECTORY AND BRANCH</h2></div></div></div><p>I assume you have a fresh copy of the cdist tree in ~/cdist, cloned from
|
||||||
|
one of the official urls (see <a href="../man7/cdist-quickstart.html">cdist-quickstart(7)</a> if you don’t).
|
||||||
|
Entering the command "git branch" should show you "* master", which indicates
|
||||||
|
you are on the <span class="strong"><strong>master</strong></span> branch.</p><p>The master branch reflects the latest development of cdist. As this is the
|
||||||
|
development branch, it may or may not work. There are also version branches
|
||||||
|
available, which are kept in a stable state. Let’s use <span class="strong"><strong>git branch -r</strong></span>
|
||||||
|
to list all branches:</p><pre class="screen">cdist% git branch -r
|
||||||
|
origin/1.0
|
||||||
|
origin/1.1
|
||||||
|
origin/1.2
|
||||||
|
origin/1.3
|
||||||
|
origin/1.4
|
||||||
|
origin/1.5
|
||||||
|
origin/1.6
|
||||||
|
origin/1.7
|
||||||
|
origin/2.0
|
||||||
|
origin/HEAD -> origin/master
|
||||||
|
origin/archive_shell_function_approach
|
||||||
|
origin/master</pre><p>So <span class="strong"><strong>2.0</strong></span> is the latest version branch in this example.
|
||||||
|
All versions (2.0.x) within one version branch (2.0) are compatible to each
|
||||||
|
other and won’t break your configuration when updating.</p><p>It’s up to you to decide which branch you want to base your own work on:
|
||||||
|
master contains more recent changes, newer types, but may also break.
|
||||||
|
The version branches are stable, but may lack the latest features.
|
||||||
|
Your decision can be changed later on, but may result in merge conflicts,
|
||||||
|
which you will need to solve.</p><p>Let’s assume you want latest stuff and select the master branch as base for
|
||||||
|
your own work. Now it’s time to create your branch, which contains your
|
||||||
|
local changes. I usually name it by the company/area I am working for:
|
||||||
|
ethz-systems, localch, customerX, … But this is pretty much up to you.</p><p>In this tutorial I use the branch <span class="strong"><strong>mycompany</strong></span>:</p><pre class="screen">cdist% git checkout -b mycompany origin/master
|
||||||
|
Branch mycompany set up to track remote branch master from origin.
|
||||||
|
Switched to a new branch 'mycompany'
|
||||||
|
cdist-user% git branch
|
||||||
|
master
|
||||||
|
* mycompany</pre><p>From now on, you can use git as usual to commit your changes in your own branch.</p></div><div class="section" title="5. PUBLISHING THE CONFIGURATION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_publishing_the_configuration"></a>5. PUBLISHING THE CONFIGURATION</h2></div></div></div><p>Usually a development machine like a notebook should be considered
|
||||||
|
temporary only. For this reason and to enable shareability, the configuration
|
||||||
|
should be published to another device as early as possible. The following
|
||||||
|
example shows how to publish the configuration to another host that is
|
||||||
|
reachable via ssh and has git installed:</p><pre class="screen"># Create bare git repository on the host named "loch"
|
||||||
|
cdist% ssh loch "GIT_DIR=/home/nutzer/cdist git init"
|
||||||
|
Initialized empty Git repository in /home/nutzer/cdist/
|
||||||
|
|
||||||
|
# Add remote git repo to git config
|
||||||
|
cdist% git remote add loch loch:/home/nutzer/cdist
|
||||||
|
|
||||||
|
# Configure the mycompany branch to push to loch
|
||||||
|
cdist% git config branch.mycompany.remote loch
|
||||||
|
|
||||||
|
# Configure mycompany branch to push into remote master branch
|
||||||
|
cdist% git config branch.mycompany.merge refs/heads/master
|
||||||
|
|
||||||
|
# Push mycompany branch to remote branch master initially
|
||||||
|
cdist% git push loch mycompany:refs/heads/master</pre><p>Now you have setup the git repository to synchronise the <span class="strong"><strong>mycompany</strong></span>
|
||||||
|
branch with the <span class="strong"><strong>master</strong></span> branch on the host <span class="strong"><strong>loch</strong></span>. Thus you can commit
|
||||||
|
as usual in your branch and push out changes by entering <span class="strong"><strong><span class="strong"><strong>git push</strong></span></strong></span>.</p></div><div class="section" title="6. UPDATING FROM ORIGIN"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_updating_from_origin"></a>6. UPDATING FROM ORIGIN</h2></div></div></div><p>Whenever you want to update your cdist installation, you can use git to do so:</p><pre class="screen"># Update git repository with latest changes from origin
|
||||||
|
cdist% git fetch origin
|
||||||
|
|
||||||
|
# Update current branch with master branch from origin
|
||||||
|
cdist% git merge origin/master
|
||||||
|
|
||||||
|
# Alternative: Update current branch with 2.0 branch from origin
|
||||||
|
cdist% git merge origin/2.0</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-tutorial.html">cdist-tutorial(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
27
software/cdist/man/4.0.0/man7/cdist-explorer.html
Normal file
27
software/cdist/man/4.0.0/man7/cdist-explorer.html
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-explorer(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-explorer(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60380240"></a>cdist-explorer(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_examples">3. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">4. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">5. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-explorer - Explore the target systems</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Explorer are small shell scripts, which will be executed on the target
|
||||||
|
host. The aim of the explorer is to give hints to types on how to act on the
|
||||||
|
target system. An explorer outputs the result to stdout, which is usually
|
||||||
|
a one liner, but may be empty or multi line especially in the case of
|
||||||
|
type explorers.</p><p>There are general explorers, which are run in an early stage, and
|
||||||
|
type explorers. Both work almost exactly the same way, with the difference
|
||||||
|
that the values of the general explorers are stored in a general location and
|
||||||
|
the type specific below the object.</p><p>Explorers can reuse other explorers on the target system by calling
|
||||||
|
$<span class="emphasis"><em>explorer/<explorer_name> (general and type explorer) or
|
||||||
|
$</em></span>type_explorer/<explorer name> (type explorer).</p><p>In case of significant errors, the explorer may exit non-zero and return an
|
||||||
|
error message on stderr, which will cause cdist to abort.</p><p>You can also use stderr for debugging purposes while developing a new
|
||||||
|
explorer.</p></div><div class="section" title="3. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>3. EXAMPLES</h2></div></div></div><p>A very simple explorer may look like this:</p><pre class="screen">hostname</pre><p>Which is in practise the <span class="strong"><strong><span class="strong"><strong>hostname</strong></span></strong></span> explorer.</p><p>A type explorer, which could check for the status of a package may look like this:</p><pre class="screen">if [ -f "$__object/parameter/name" ]; then
|
||||||
|
name="$(cat "$__object/parameter/name")"
|
||||||
|
else
|
||||||
|
name="$__object_id"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Expect dpkg failing, if package is not known / installed
|
||||||
|
dpkg -s "$name" 2>/dev/null || exit 0</pre></div><div class="section" title="4. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>4. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-reference.html">cdist-reference(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-stages.html">cdist-stages(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="5. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>5. COPYING</h2></div></div></div><p>Copyright (C) 2010-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
101
software/cdist/man/4.0.0/man7/cdist-hacker.html
Normal file
101
software/cdist/man/4.0.0/man7/cdist-hacker.html
Normal file
|
|
@ -0,0 +1,101 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-hacker(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-hacker(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-hacker(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_welcome">2. WELCOME</a></span></dt><dt><span class="section"><a href="#_reporting_bugs">3. REPORTING BUGS</a></span></dt><dt><span class="section"><a href="#_coding_conventions_everywhere">4. CODING CONVENTIONS (EVERYWHERE)</a></span></dt><dt><span class="section"><a href="#_how_to_submit_stuff_for_inclusion_into_upstream_cdist">5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST</a></span></dt><dt><span class="section"><a href="#_how_to_submit_a_new_type">6. HOW TO SUBMIT A NEW TYPE</a></span></dt><dt><span class="section"><a href="#_example_git_workflow">7. EXAMPLE GIT WORKFLOW</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-hacker - How to get (stuff) into cdist</p></div><div class="section" title="2. WELCOME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_welcome"></a>2. WELCOME</h2></div></div></div><p>Welcome dear hacker! I invite you to a tour of pointers to
|
||||||
|
get into the usable configuration mangament system, cdist.</p><p>The first thing to know is probably that cdist is brought to
|
||||||
|
you by people who care about how code looks like and who think
|
||||||
|
twice before merging or implementing a feature: Less features
|
||||||
|
with good usability are far better than the opposite.</p></div><div class="section" title="3. REPORTING BUGS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_reporting_bugs"></a>3. REPORTING BUGS</h2></div></div></div><p>If you believe you’ve found a bug and verified that it is
|
||||||
|
in the latest version, drop a mail to the cdist mailing list,
|
||||||
|
subject prefixed with "[BUG] " or create an issue on github.</p></div><div class="section" title="4. CODING CONVENTIONS (EVERYWHERE)"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_coding_conventions_everywhere"></a>4. CODING CONVENTIONS (EVERYWHERE)</h2></div></div></div><p>If something should be better done or needs to fixed, add the word FIXME
|
||||||
|
nearby, so grepping for FIXME gives all positions that need to be fixed.</p><p>Indention is 4 spaces (welcome to the python world).</p></div><div class="section" title="5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_to_submit_stuff_for_inclusion_into_upstream_cdist"></a>5. HOW TO SUBMIT STUFF FOR INCLUSION INTO UPSTREAM CDIST</h2></div></div></div><p>If you did some cool changes to cdist, which you value as a benefit for
|
||||||
|
everybody using cdist, you’re welcome to propose inclusion into upstream.</p><p>There are though some requirements to ensure your changes don’t break others
|
||||||
|
work nor kill the authors brain:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
All files should contain the usual header (Author, Copying, etc.)
|
||||||
|
</li><li class="listitem">
|
||||||
|
Code submission must be done via git
|
||||||
|
</li><li class="listitem">
|
||||||
|
Do not add cdist/conf/manifest/init - This file should only be touched in your
|
||||||
|
private branch!
|
||||||
|
</li><li class="listitem">
|
||||||
|
Code to be included should be branched of the upstream "master" branch
|
||||||
|
</li><li class="listitem">
|
||||||
|
Exception: Bugfixes to a version branch
|
||||||
|
</li><li class="listitem">
|
||||||
|
On a merge request, always name the branch I should pull from
|
||||||
|
</li><li class="listitem">
|
||||||
|
Always ensure <span class="strong"><strong>all</strong></span> manpages build. Use <span class="strong"><strong>./build man</strong></span> to test.
|
||||||
|
</li><li class="listitem">
|
||||||
|
If you developed more than <span class="strong"><strong>one</strong></span> feature, consider submitting them in
|
||||||
|
separate branches. This way one feature can already be included, even if
|
||||||
|
the other needs to be improved.
|
||||||
|
</li></ul></div><p>As soon as your work meets these requirements, write a mail
|
||||||
|
for inclusion to the mailinglist <span class="strong"><strong>cdist at cdist — at — l.schottelius.org</strong></span>
|
||||||
|
or open a pull request at <a class="ulink" href="http://github.com/telmich/cdist" target="_top">http://github.com/telmich/cdist</a>.</p></div><div class="section" title="6. HOW TO SUBMIT A NEW TYPE"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_to_submit_a_new_type"></a>6. HOW TO SUBMIT A NEW TYPE</h2></div></div></div><p>For detailled information about types, see <a href="../man7/cdist-type.html">cdist-type(7)</a>.</p><p>Submitting a type works as described above, with the additional requirement
|
||||||
|
that a corresponding manpage named man.text in asciidoc format with
|
||||||
|
the manpage-name "cdist-type__NAME" is included in the type directory
|
||||||
|
AND asciidoc is able to compile it (i.e. do NOT have to many "=" in the second
|
||||||
|
line).</p><p>Warning: Submitting "exec" or "run" types that simply echo their parameter in
|
||||||
|
gencode* will not be accepted, because they are of no use. Every type can output
|
||||||
|
code and thus such a type introduces redundant functionality that is given by
|
||||||
|
core cdist already.</p></div><div class="section" title="7. EXAMPLE GIT WORKFLOW"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_example_git_workflow"></a>7. EXAMPLE GIT WORKFLOW</h2></div></div></div><p>The following workflow works fine for most developers:</p><pre class="screen"># get latest upstream master branch
|
||||||
|
git clone https://github.com/telmich/cdist.git
|
||||||
|
|
||||||
|
# update if already existing
|
||||||
|
cd cdist; git fetch -v; git merge origin/master
|
||||||
|
|
||||||
|
# create a new branch for your feature/bugfix
|
||||||
|
cd cdist # if you haven't done before
|
||||||
|
git checkout -b documentation_cleanup
|
||||||
|
|
||||||
|
# *hack*
|
||||||
|
*hack*
|
||||||
|
|
||||||
|
# clone the cdist repository on github if you haven't done so
|
||||||
|
|
||||||
|
# configure your repo to know about your clone (only once)
|
||||||
|
git remote add github git@github.com:YOURUSERNAME/cdist.git
|
||||||
|
|
||||||
|
# push the new branch to github
|
||||||
|
git push github documentation_cleanup
|
||||||
|
|
||||||
|
# (or everything)
|
||||||
|
git push --mirror github
|
||||||
|
|
||||||
|
# create a pull request at github (use a browser)
|
||||||
|
# *fixthingsbecausequalityassurancefoundissuesinourpatch*
|
||||||
|
*hack*
|
||||||
|
|
||||||
|
# push code to github again
|
||||||
|
git push ... # like above
|
||||||
|
|
||||||
|
# add comment that everything should be green now (use a browser)
|
||||||
|
|
||||||
|
# go back to master branch
|
||||||
|
git checkout master
|
||||||
|
|
||||||
|
# update master branch that includes your changes now
|
||||||
|
git fetch -v origin
|
||||||
|
git diff master..origin/master
|
||||||
|
git merge origin/master</pre><p>If at any point you want to go back to the original master branch, you can
|
||||||
|
use <span class="strong"><strong>git stash</strong></span> to stash your changes away:</p><pre class="screen"># assume you are on documentation_cleanup
|
||||||
|
git stash
|
||||||
|
|
||||||
|
# change to master and update to most recent upstream version
|
||||||
|
git checkout master
|
||||||
|
git fetch -v origin
|
||||||
|
git merge origin/master</pre><p>Similar when you want to develop another new feature, you go back
|
||||||
|
to the master branch and create another branch based on it:</p><pre class="screen"># change to master and update to most recent upstream version
|
||||||
|
git checkout master
|
||||||
|
git fetch -v origin
|
||||||
|
git merge origin/master
|
||||||
|
|
||||||
|
git checkout -b another_feature</pre><p>(you can repeat the code above for as many features as you want to develop
|
||||||
|
in parallel)</p></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist.html">cdist(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/git.html">git(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/git-checkout.html">git-checkout(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/git-stash.html">git-stash(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2011-2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
140
software/cdist/man/4.0.0/man7/cdist-manifest.html
Normal file
140
software/cdist/man/4.0.0/man7/cdist-manifest.html
Normal file
|
|
@ -0,0 +1,140 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-manifest(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-manifest(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-manifest(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_initial_and_type_manifests">3. INITIAL AND TYPE MANIFESTS</a></span></dt><dt><span class="section"><a href="#_define_state_in_the_initial_manifest">4. DEFINE STATE IN THE INITIAL MANIFEST</a></span></dt><dt><span class="section"><a href="#_splitting_up_the_initial_manifest">5. SPLITTING UP THE INITIAL MANIFEST</a></span></dt><dt><span class="section"><a href="#_dependencies">6. DEPENDENCIES</a></span></dt><dt><span class="section"><a href="#_create_dependencies_from_execution_order">7. CREATE DEPENDENCIES FROM EXECUTION ORDER</a></span></dt><dt><span class="section"><a href="#_overrides">8. OVERRIDES</a></span></dt><dt><span class="section"><a href="#_examples">9. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">10. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">11. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-manifest - (Re-)Use types</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Manifests are used to define which objects to create.
|
||||||
|
Objects are instances of <span class="strong"><strong>types</strong></span>, like in object oriented programming languages.
|
||||||
|
An object is represented by the combination of
|
||||||
|
<span class="strong"><strong>type + slash + object name</strong></span>: <span class="strong"><strong>__file/etc/cdist-configured</strong></span> is an
|
||||||
|
object of the type <span class="strong"><strong><span class="strong"><strong>__file</strong></span></strong></span> with the name <span class="strong"><strong><span class="strong"><strong>etc/cdist-configured</strong></span></strong></span>.</p><p>All available types can be found in the <span class="strong"><strong>cdist/conf/type/</strong></span> directory,
|
||||||
|
use <span class="strong"><strong>ls cdist/conf/type</strong></span> to get the list of available types. If you have
|
||||||
|
setup the MANPATH correctly, you can use <span class="strong"><strong>man cdist-reference</strong></span> to access
|
||||||
|
the reference with pointers to the manpages.</p><p>Types in manifests are used like normal command line tools. Let’s have a look
|
||||||
|
at an example:</p><pre class="screen"># Create object of type __package with the parameter state = absent
|
||||||
|
__package apache2 --state absent
|
||||||
|
|
||||||
|
# Same with the __directory type
|
||||||
|
__directory /tmp/cdist --state present</pre><p>These two lines create objects, which will later be used to realise the
|
||||||
|
configuration on the target host.</p><p>Manifests are executed locally as a shell script using <span class="strong"><strong>/bin/sh -e</strong></span>.
|
||||||
|
The resulting objects are stored in an internal database.</p><p>The same object can be redefined in multiple different manifests as long as
|
||||||
|
the parameters are exactly the same.</p><p>In general, manifests are used to define which types are used depending
|
||||||
|
on given conditions.</p></div><div class="section" title="3. INITIAL AND TYPE MANIFESTS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_initial_and_type_manifests"></a>3. INITIAL AND TYPE MANIFESTS</h2></div></div></div><p>Cdist knows about two types of manifests: The initial manifest and type
|
||||||
|
manifests. The initial manifest is used to define, which configurations
|
||||||
|
to apply to which hosts. The type manifests are used to create objects
|
||||||
|
from types. More about manifests in types can be found in <a href="../man7/cdist-type.html">cdist-type(7)</a>.</p></div><div class="section" title="4. DEFINE STATE IN THE INITIAL MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_define_state_in_the_initial_manifest"></a>4. DEFINE STATE IN THE INITIAL MANIFEST</h2></div></div></div><p>The <span class="strong"><strong>initial manifest</strong></span> is the entry point for cdist to find out, which
|
||||||
|
<span class="strong"><strong>objects</strong></span> to configure on the selected host.
|
||||||
|
Cdist expects the initial manifest at <span class="strong"><strong>cdist/conf/manifest/init</strong></span>.</p><p>Within this initial manifest you define, which objects should be
|
||||||
|
created on which host. To distinguish between hosts, you can use the
|
||||||
|
environment variable <span class="strong"><strong>__target_host</strong></span>. Let’s have a look at a simple
|
||||||
|
example:</p><pre class="screen">__cdistmarker
|
||||||
|
|
||||||
|
case "$__target_host" in
|
||||||
|
localhost)
|
||||||
|
__directory /home/services/kvm-vm --parents yes
|
||||||
|
;;
|
||||||
|
esac</pre><p>This manifest says: Independent of the host, always use the type
|
||||||
|
<span class="strong"><strong><span class="strong"><strong>__cdistmarker</strong></span></strong></span>, which creates the file <span class="strong"><strong>/etc/cdist-configured</strong></span>,
|
||||||
|
with the timestamp as content.
|
||||||
|
The directory <span class="strong"><strong><span class="strong"><strong>/home/services/kvm-vm</strong></span></strong></span>, including all parent directories,
|
||||||
|
is only created on the host <span class="strong"><strong><span class="strong"><strong>localhost</strong></span></strong></span>.</p><p>As you can see, there is no magic involved, the manifest is simple shell code that
|
||||||
|
utilises cdist types. Every available type can be executed like a normal
|
||||||
|
command.</p></div><div class="section" title="5. SPLITTING UP THE INITIAL MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_splitting_up_the_initial_manifest"></a>5. SPLITTING UP THE INITIAL MANIFEST</h2></div></div></div><p>If you want to split up your initial manifest, you can create other shell
|
||||||
|
scripts in <span class="strong"><strong>cdist/conf/manifest/</strong></span> and include them in <span class="strong"><strong>cdist/conf/manifest/init</strong></span>.
|
||||||
|
Cdist provides the environment variable <span class="strong"><strong><span class="strong"><strong>__manifest</strong></span></strong></span> to reference
|
||||||
|
the directory containing the initial manifest (see <a href="../man7/cdist-reference.html">cdist-reference(7)</a>).</p><p>The following example would include every file with a <span class="strong"><strong>.sh</strong></span> suffix:</p><pre class="screen"># Include *.sh
|
||||||
|
for manifest in $__manifest/*.sh; do
|
||||||
|
# And source scripts into our shell environment
|
||||||
|
. "$manifest"
|
||||||
|
done</pre></div><div class="section" title="6. DEPENDENCIES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_dependencies"></a>6. DEPENDENCIES</h2></div></div></div><p>If you want to describe that something requires something else, just
|
||||||
|
setup the variable "require" to contain the requirements. Multiple
|
||||||
|
requirements can be added white space separated.</p><pre class="screen"> 1 # No dependency
|
||||||
|
2 __file /etc/cdist-configured
|
||||||
|
3
|
||||||
|
4 # Require above object
|
||||||
|
5 require="__file/etc/cdist-configured" __link /tmp/cdist-testfile \
|
||||||
|
6 --source /etc/cdist-configured --type symbolic
|
||||||
|
7
|
||||||
|
8 # Require two objects
|
||||||
|
9 require="__file/etc/cdist-configured __link/tmp/cdist-testfile" \
|
||||||
|
10 __file /tmp/cdist-another-testfile</pre><p>Above the "require" variable is only set for the command that is
|
||||||
|
immediately following it. Dependencies should always be declared that way.</p><p>On line 4 you can see that the instantion of a type "__link" object needs
|
||||||
|
the object "__file/etc/cdist-configured" to be present, before it can proceed.</p><p>This also means that the "__link" command must make sure, that either
|
||||||
|
"__file/etc/cdist-configured" allready is present, or, if it’s not, it needs
|
||||||
|
to be created. The task of cdist is to make sure, that the dependency will be
|
||||||
|
resolved appropriately and thus "__file/etc/cdist-configured" be created
|
||||||
|
if necessary before "__link" proceeds (or to abort execution with an error).</p><p>If you really need to make all types depend on a common dependency, you can
|
||||||
|
export the "require" variable as well. But then, if you need to add extra
|
||||||
|
dependencies to a specific type, you have to make sure that you append these
|
||||||
|
to the globally already defined one.</p><pre class="screen"># First of all, update the package index
|
||||||
|
__package_update_index
|
||||||
|
# Upgrade all the installed packages afterwards
|
||||||
|
require="__package_update_index" __package_upgrade_all
|
||||||
|
# Create a common dependency for all the next types so that they get to
|
||||||
|
# be executed only after the package upgrade has finished
|
||||||
|
export require="__package_upgrade_all"
|
||||||
|
|
||||||
|
# Ensure that lighttpd is installed after we have upgraded all the packages
|
||||||
|
__package lighttpd --state present
|
||||||
|
# Ensure that munin is installed after lighttpd is present and after all
|
||||||
|
# the packages are upgraded
|
||||||
|
require="$require __package/lighttpd" __package munin --state present</pre><p>All objects that are created in a type manifest are automatically required
|
||||||
|
from the type that is calling them. This is called "autorequirement" in
|
||||||
|
cdist jargon.</p><p>You can find an more in depth description of the flow execution of manifests
|
||||||
|
in <a href="../man7/cdist-stages.html">cdist-stages(7)</a> and of how types work in <a href="../man7/cdist-type.html">cdist-type(7)</a>.</p></div><div class="section" title="7. CREATE DEPENDENCIES FROM EXECUTION ORDER"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_create_dependencies_from_execution_order"></a>7. CREATE DEPENDENCIES FROM EXECUTION ORDER</h2></div></div></div><p>You can tell cdist to execute all types in the order in which they are created
|
||||||
|
in the manifest by setting up the variable CDIST_ORDER_DEPENDENCY.
|
||||||
|
When cdist sees that this variable is setup, the current created object
|
||||||
|
automatically depends on the previously created object.</p><p>It essentially helps you to build up blocks of code that build upon each other
|
||||||
|
(like first creating the directory xyz than the file below the directory).</p></div><div class="section" title="8. OVERRIDES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_overrides"></a>8. OVERRIDES</h2></div></div></div><p>In some special cases, you would like to create an already defined object
|
||||||
|
with different parameters. In normal situations this leads to an error in cdist.
|
||||||
|
If you whish, you can setup the environment variable CDIST_OVERRIDE
|
||||||
|
(any value or even empty is ok) to tell cdist, that this object override is
|
||||||
|
wanted and should be accepted.
|
||||||
|
ATTENTION: Only use this feature if you are 100% sure in which order
|
||||||
|
cdist encounters the affected objects, otherwhise this results
|
||||||
|
in an undefined situation.</p><p>If CDIST_OVERRIDE and CDIST_ORDER_DEPENDENCY are set for an object,
|
||||||
|
CDIST_ORDER_DEPENDENCY will be ignored, because adding a dependency in case of
|
||||||
|
overrides would result in circular dependencies, which is an error.</p></div><div class="section" title="9. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>9. EXAMPLES</h2></div></div></div><p>The initial manifest may for instance contain the following code:</p><pre class="screen"># Always create this file, so other sysadmins know cdist is used.
|
||||||
|
__file /etc/cdist-configured
|
||||||
|
|
||||||
|
case "$__target_host" in
|
||||||
|
my.server.name)
|
||||||
|
__directory /root/bin/
|
||||||
|
__file /etc/issue.net --source "$__manifest/issue.net
|
||||||
|
;;
|
||||||
|
esac</pre><p>The manifest of the type "nologin" may look like this:</p><pre class="screen">__file /etc/nologin --source "$__type/files/default.nologin"</pre><p>This example makes use of dependencies:</p><pre class="screen"># Ensure that lighttpd is installed
|
||||||
|
__package lighttpd --state present
|
||||||
|
# Ensure that munin makes use of lighttpd instead of the default webserver
|
||||||
|
# package as decided by the package manager
|
||||||
|
require="__package/lighttpd" __package munin --state present</pre><p>How to override objects:</p><pre class="screen"># for example in the inital manifest
|
||||||
|
|
||||||
|
# create user account foobar with some hash for password
|
||||||
|
__user foobar --password 'some_fancy_hash' --home /home/foobarexample
|
||||||
|
|
||||||
|
# ... many statements and includes in the manifest later ...
|
||||||
|
# somewhere in a conditionally sourced manifest
|
||||||
|
# (e.g. for example only sourced if a special application is on the target host)
|
||||||
|
|
||||||
|
# this leads to an error ...
|
||||||
|
__user foobar --password 'some_other_hash'
|
||||||
|
|
||||||
|
# this tells cdist, that you know that this is an override and should be accepted
|
||||||
|
CDIST_OVERRIDE=yes __user foobar --password 'some_other_hash'
|
||||||
|
# it's only an override, means the parameter --home is not touched
|
||||||
|
# and stays at the original value of /home/foobarexample</pre><p>Dependencies defined by execution order work as following:</p><pre class="screen"># Tells cdist to execute all types in the order in which they are created ...
|
||||||
|
export CDIST_ORDER_DEPENDENCY=on
|
||||||
|
__sample_type 1
|
||||||
|
require="__some_type_somewhere/id" __sample_type 2
|
||||||
|
__example_type 23
|
||||||
|
# Now this types are executed in the creation order until the variable is unset
|
||||||
|
unset CDIST_ORDER_DEPENDENCY
|
||||||
|
# all now following types cdist makes the order ..
|
||||||
|
__not_in_order_type 42
|
||||||
|
|
||||||
|
# how it works :
|
||||||
|
# this lines above are translated to:
|
||||||
|
__sample_type 1
|
||||||
|
require="__some_type_somewhere/id __sample_type/1" __sample_type 2
|
||||||
|
require="__sample_type/2" __example_type 23
|
||||||
|
__not_in_order_type 42</pre></div><div class="section" title="10. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>10. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-tutorial.html">cdist-tutorial(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="11. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>11. COPYING</h2></div></div></div><p>Copyright (C) 2010-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
60
software/cdist/man/4.0.0/man7/cdist-messaging.html
Normal file
60
software/cdist/man/4.0.0/man7/cdist-messaging.html
Normal file
|
|
@ -0,0 +1,60 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-messaging(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-messaging(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-messaging(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_availability">3. AVAILABILITY</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-messaging - How the initial manifest and types can communication</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>cdist has a simple but powerful way of allowing communication between
|
||||||
|
the initial manifest and types as well as types and types.</p><p>Whenever execution is passed from cdist to one of the
|
||||||
|
scripts described below, cdist generate 2 new temporary files
|
||||||
|
and exports the environment variables <span class="emphasis"><em>messages_in and
|
||||||
|
</em></span>messages_out to point to them.</p><p>Before handing over the control, the content of the global message
|
||||||
|
file is copied into the file referenced by $__messages_in.</p><p>After cdist gained control back, the content of the file referenced
|
||||||
|
by $__messages_out is appended to the global message file.</p><p>This way overwriting any of the two files by accident does not
|
||||||
|
interfere with other types.</p><p>The order of execution is not defined unless you create dependencies
|
||||||
|
between the different objects (see <a href="../man7/cdist-manifest.html">cdist-manifest(7)</a>) and thus you
|
||||||
|
can only react reliably on messages by objects that you depend on.</p></div><div class="section" title="3. AVAILABILITY"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_availability"></a>3. AVAILABILITY</h2></div></div></div><p>Messaging is possible between all <span class="strong"><strong>local</strong></span> scripts:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
initial manifest
|
||||||
|
</li><li class="listitem">
|
||||||
|
type/manifest
|
||||||
|
</li><li class="listitem">
|
||||||
|
type/gencode-local
|
||||||
|
</li><li class="listitem">
|
||||||
|
type/gencode-remote
|
||||||
|
</li></ul></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><p>When you want to emit a message use:</p><pre class="screen">echo "something" >> "$__messages_out"</pre><p>When you want to react on a message use:</p><pre class="screen">if grep -q "^__your_type/object/id:something" "$__messages_in"; then
|
||||||
|
echo "I do something else"
|
||||||
|
fi</pre><p>Some real life examples:</p><pre class="screen"># Reacting on changes from block for keepalive
|
||||||
|
if grep -q "^__block/keepalive-vrrp" "$__messages_in"; then
|
||||||
|
echo /etc/init.d/keepalived restart
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Reacting on changes of configuration files
|
||||||
|
if grep -q "^__file/etc/one" $__messages_in; then
|
||||||
|
echo 'for init in /etc/init.d/opennebula*; do $init restart; done'
|
||||||
|
fi</pre><p>Restart sshd on changes</p><pre class="screen">os="$(cat "$__global/explorer/os")"
|
||||||
|
|
||||||
|
case "$os" in
|
||||||
|
centos|redhat|suse)
|
||||||
|
restart="/etc/init.d/sshd restart"
|
||||||
|
;;
|
||||||
|
debian|ubuntu)
|
||||||
|
restart="/etc/init.d/ssh restart"
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
cat << eof >&2
|
||||||
|
Unsupported os $os.
|
||||||
|
If you would like to have this type running on $os,
|
||||||
|
you can either develop the changes and send a pull
|
||||||
|
request or ask for a quote at www.ungleich.ch
|
||||||
|
eof
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if grep -q "^__key_value/PermitRootLogin" "$__messages_in"; then
|
||||||
|
echo $restart
|
||||||
|
fi</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-manifest.html">cdist-manifest(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-reference.html">cdist-reference(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
52
software/cdist/man/4.0.0/man7/cdist-quickstart.html
Normal file
52
software/cdist/man/4.0.0/man7/cdist-quickstart.html
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-quickstart(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-quickstart(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-quickstart(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_introduction">2. INTRODUCTION</a></span></dt><dt><span class="section"><a href="#_quick_start_get_your_hands_dirty_now">3. QUICK START - GET YOUR HANDS DIRTY NOW</a></span></dt><dt><span class="section"><a href="#_see_also">4. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">5. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-quickstart - jump in and enjoy cdist</p></div><div class="section" title="2. INTRODUCTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_introduction"></a>2. INTRODUCTION</h2></div></div></div><p>This tutorial is aimed at people learning cdist and shows
|
||||||
|
typical approaches as well as gives an easy start into
|
||||||
|
the world of configuration management.</p><p>This tutorial assumes you are configuring <span class="strong"><strong>localhost</strong></span>, because
|
||||||
|
it is always available. Just replace <span class="strong"><strong>localhost</strong></span> with your target
|
||||||
|
host for real life usage.</p></div><div class="section" title="3. QUICK START - GET YOUR HANDS DIRTY NOW"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_quick_start_get_your_hands_dirty_now"></a>3. QUICK START - GET YOUR HANDS DIRTY NOW</h2></div></div></div><p>For those who just want to configure a system with the
|
||||||
|
cdist configuration management and do not need (or want)
|
||||||
|
to understand everything.</p><p>Cdist uses <span class="strong"><strong>ssh</strong></span> for communication and transportation
|
||||||
|
and usually logs into the <span class="strong"><strong>target host</strong></span> as the
|
||||||
|
<span class="strong"><strong>root</strong></span> user. So you need to configure the <span class="strong"><strong>ssh server</strong></span>
|
||||||
|
of the target host to allow root logins: Edit
|
||||||
|
the file <span class="strong"><strong>/etc/ssh/sshd_config</strong></span> and add one of the following
|
||||||
|
lines:</p><pre class="screen"># Allow login only via public key
|
||||||
|
PermitRootLogin without-password
|
||||||
|
|
||||||
|
# Allow login via password and public key
|
||||||
|
PermitRootLogin yes</pre><p>As cdist uses ssh intensively, it is recommended to setup authentication
|
||||||
|
with public keys:</p><pre class="screen"># Generate pubkey pair as a normal user
|
||||||
|
ssh-keygen
|
||||||
|
|
||||||
|
# Copy pubkey over to target host
|
||||||
|
ssh-copy-id root@localhost</pre><p>Have a look at <a href="../man1/ssh-agent.html">ssh-agent(1)</a> and <a href="../man1/ssh-add.html">ssh-add(1)</a> on how to cache the password for
|
||||||
|
your public key. Usually it looks like this:</p><pre class="screen"># Start agent and export variables
|
||||||
|
eval `ssh-agent`
|
||||||
|
|
||||||
|
# Add keys (requires password for every identity file)
|
||||||
|
ssh-add</pre><p>At this point you should be able to <span class="strong"><strong><span class="strong"><strong>ssh root@localhost</strong></span></strong></span> without
|
||||||
|
re-entering the password. If something failed until here, ensure that
|
||||||
|
all steps went successfully and you have read and understood the
|
||||||
|
documentation.</p><p>As soon as you are able to login without password to localhost,
|
||||||
|
we can use cdist to configure it. You can copy and paste the following
|
||||||
|
code into your shell to get started and configure localhost:</p><pre class="screen"># Get cdist
|
||||||
|
# Mirrors can be found on
|
||||||
|
# http://www.nico.schottelius.org/software/cdist/install/#index2h4
|
||||||
|
git clone git://git.schottelius.org/cdist
|
||||||
|
|
||||||
|
# Create manifest (maps configuration to host(s)
|
||||||
|
cd cdist
|
||||||
|
echo '__file /etc/cdist-configured' > cdist/conf/manifest/init
|
||||||
|
|
||||||
|
# Configure localhost in verbose mode
|
||||||
|
./bin/cdist config -v localhost
|
||||||
|
|
||||||
|
# Find out that cdist created /etc/cdist-configured
|
||||||
|
ls -l /etc/cdist-configured</pre><p>That’s it, you’ve successfully used cdist to configure your first host!
|
||||||
|
Continue reading the next sections, to understand what you did and how
|
||||||
|
to create a more sophisticated configuration.</p></div><div class="section" title="4. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>4. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-tutorial.html">cdist-tutorial(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="5. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>5. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
436
software/cdist/man/4.0.0/man7/cdist-reference.html
Normal file
436
software/cdist/man/4.0.0/man7/cdist-reference.html
Normal file
|
|
@ -0,0 +1,436 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-reference(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-reference(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-reference(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_explorers">2. EXPLORERS</a></span></dt><dt><span class="section"><a href="#_paths">3. PATHS</a></span></dt><dt><span class="section"><a href="#_types">4. TYPES</a></span></dt><dt><span class="section"><a href="#_objects">5. OBJECTS</a></span></dt><dt><span class="section"><a href="#_environment_variables_for_reading">6. ENVIRONMENT VARIABLES (FOR READING)</a></span></dt><dt><span class="section"><a href="#_environment_variables_for_writing">7. ENVIRONMENT VARIABLES (FOR WRITING)</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-reference - Variable, path and type reference for cdist</p></div><div class="section" title="2. EXPLORERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_explorers"></a>2. EXPLORERS</h2></div></div></div><p>The following global explorers are available:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cpu_cores
|
||||||
|
</li><li class="listitem">
|
||||||
|
cpu_sockets
|
||||||
|
</li><li class="listitem">
|
||||||
|
hostname
|
||||||
|
</li><li class="listitem">
|
||||||
|
init
|
||||||
|
</li><li class="listitem">
|
||||||
|
interfaces
|
||||||
|
</li><li class="listitem">
|
||||||
|
lsb_codename
|
||||||
|
</li><li class="listitem">
|
||||||
|
lsb_description
|
||||||
|
</li><li class="listitem">
|
||||||
|
lsb_id
|
||||||
|
</li><li class="listitem">
|
||||||
|
lsb_release
|
||||||
|
</li><li class="listitem">
|
||||||
|
machine
|
||||||
|
</li><li class="listitem">
|
||||||
|
machine_type
|
||||||
|
</li><li class="listitem">
|
||||||
|
memory
|
||||||
|
</li><li class="listitem">
|
||||||
|
os
|
||||||
|
</li><li class="listitem">
|
||||||
|
os_version
|
||||||
|
</li><li class="listitem">
|
||||||
|
runlevel
|
||||||
|
</li></ul></div></div><div class="section" title="3. PATHS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_paths"></a>3. PATHS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
$HOME/.cdist
|
||||||
|
</span></dt><dd>
|
||||||
|
The standard cdist configuration directory relative to your home directory
|
||||||
|
This is usually the place you want to store your site specific configuration
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist/conf/
|
||||||
|
</span></dt><dd>
|
||||||
|
The distribution configuration directory
|
||||||
|
This contains types and explorers to be used
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir
|
||||||
|
</span></dt><dd>
|
||||||
|
Cdist will use all available configuration directories and create
|
||||||
|
a temporary confdir containing links to the real configuration directories.
|
||||||
|
This way it is possible to merge configuration directories.
|
||||||
|
By default it consists of everything in $HOME/.cdist and cdist/conf/.
|
||||||
|
For more details see <a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/manifest/init
|
||||||
|
</span></dt><dd>
|
||||||
|
This is the central entry point.
|
||||||
|
It is an executable (+x bit set) shell script that can use
|
||||||
|
values from the explorers to decide which configuration to create
|
||||||
|
for the specified target host.
|
||||||
|
Its intent is to used to define mapping from configurations to hosts.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/manifest/*
|
||||||
|
</span></dt><dd>
|
||||||
|
All other files in this directory are not directly used by cdist, but you
|
||||||
|
can separate configuration mappings, if you have a lot of code in the
|
||||||
|
conf/manifest/init file. This may also be helpful to have different admins
|
||||||
|
maintain different groups of hosts.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/explorer/<name>
|
||||||
|
</span></dt><dd>
|
||||||
|
Contains explorers to be run on the target hosts, see <a href="../man7/cdist-explorer.html">cdist-explorer(7)</a>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/
|
||||||
|
</span></dt><dd>
|
||||||
|
Contains all available types, which are used to provide
|
||||||
|
some kind of functionality. See <a href="../man7/cdist-type.html">cdist-type(7)</a>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/
|
||||||
|
</span></dt><dd>
|
||||||
|
Home of the type <name>.
|
||||||
|
This directory is referenced by the variable __type (see below).
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/man.text
|
||||||
|
</span></dt><dd>
|
||||||
|
Manpage in Asciidoc format (required for inclusion into upstream)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/manifest
|
||||||
|
</span></dt><dd>
|
||||||
|
Used to generate additional objects from a type.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/gencode-local
|
||||||
|
</span></dt><dd>
|
||||||
|
Used to generate code to be executed on the source host
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/gencode-remote
|
||||||
|
</span></dt><dd>
|
||||||
|
Used to generate code to be executed on the target host
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/parameter/required
|
||||||
|
</span></dt><dd>
|
||||||
|
Parameters required by type, \n separated list.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/parameter/optional
|
||||||
|
</span></dt><dd>
|
||||||
|
Parameters optionally accepted by type, \n separated list.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/parameter/default/*
|
||||||
|
</span></dt><dd>
|
||||||
|
Default values for optional parameters.
|
||||||
|
Assuming an optional parameter name of <span class="emphasis"><em>foo</em></span>, it’s default value would
|
||||||
|
be read from the file confdir/type/<name>/parameter/default/foo.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/parameter/boolean
|
||||||
|
</span></dt><dd>
|
||||||
|
Boolean parameters accepted by type, \n separated list.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/explorer
|
||||||
|
</span></dt><dd>
|
||||||
|
Location of the type specific explorers.
|
||||||
|
This directory is referenced by the variable __type_explorer (see below).
|
||||||
|
See <a href="../man7/cdist-explorer.html">cdist-explorer(7)</a>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
confdir/type/<name>/files
|
||||||
|
</span></dt><dd>
|
||||||
|
This directory is reserved for user data and will not be used
|
||||||
|
by cdist at any time. It can be used for storing supplementary
|
||||||
|
files (like scripts to act as a template or configuration files).
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
out/
|
||||||
|
</span></dt><dd>
|
||||||
|
This directory contains output of cdist and is usually located
|
||||||
|
in a temporary directory and thus will be removed after the run.
|
||||||
|
This directory is referenced by the variable __global (see below).
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
out/explorer
|
||||||
|
</span></dt><dd>
|
||||||
|
Output of general explorers.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
out/object
|
||||||
|
</span></dt><dd>
|
||||||
|
Objects created for the host.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
out/object/<object>
|
||||||
|
</span></dt><dd>
|
||||||
|
Contains all object specific information.
|
||||||
|
This directory is referenced by the variable __object (see below).
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
out/object/<object>/explorers
|
||||||
|
</span></dt><dd>
|
||||||
|
Output of type specific explorers, per object.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. TYPES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_types"></a>4. TYPES</h2></div></div></div><p>The following types are available:</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
__apt_norecommends (<a href="../man7/cdist-type__apt_norecommends.html">cdist-type__apt_norecommends(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__apt_ppa (<a href="../man7/cdist-type__apt_ppa.html">cdist-type__apt_ppa(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__apt_source (<a href="../man7/cdist-type__apt_source.html">cdist-type__apt_source(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__apt_update_index (<a href="../man7/cdist-type__apt_update_index.html">cdist-type__apt_update_index(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__block (<a href="../man7/cdist-type__block.html">cdist-type__block(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__ccollect_source (<a href="../man7/cdist-type__ccollect_source.html">cdist-type__ccollect_source(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__cdist (<a href="../man7/cdist-type__cdist.html">cdist-type__cdist(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__cdistmarker (<a href="../man7/cdist-type__cdistmarker.html">cdist-type__cdistmarker(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__config_file (<a href="../man7/cdist-type__config_file.html">cdist-type__config_file(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul (<a href="../man7/cdist-type__consul.html">cdist-type__consul(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_agent (<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_check (<a href="../man7/cdist-type__consul_check.html">cdist-type__consul_check(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_reload (<a href="../man7/cdist-type__consul_reload.html">cdist-type__consul_reload(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_service (<a href="../man7/cdist-type__consul_service.html">cdist-type__consul_service(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_template (<a href="../man7/cdist-type__consul_template.html">cdist-type__consul_template(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_template_template (<a href="../man7/cdist-type__consul_template_template.html">cdist-type__consul_template_template(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_checks (<a href="../man7/cdist-type__consul_watch_checks.html">cdist-type__consul_watch_checks(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_event (<a href="../man7/cdist-type__consul_watch_event.html">cdist-type__consul_watch_event(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_key (<a href="../man7/cdist-type__consul_watch_key.html">cdist-type__consul_watch_key(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_keyprefix (<a href="../man7/cdist-type__consul_watch_keyprefix.html">cdist-type__consul_watch_keyprefix(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_nodes (<a href="../man7/cdist-type__consul_watch_nodes.html">cdist-type__consul_watch_nodes(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_service (<a href="../man7/cdist-type__consul_watch_service.html">cdist-type__consul_watch_service(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__consul_watch_services (<a href="../man7/cdist-type__consul_watch_services.html">cdist-type__consul_watch_services(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__cron (<a href="../man7/cdist-type__cron.html">cdist-type__cron(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__debconf_set_selections (<a href="../man7/cdist-type__debconf_set_selections.html">cdist-type__debconf_set_selections(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__directory (<a href="../man7/cdist-type__directory.html">cdist-type__directory(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__dog_vdi (<a href="../man7/cdist-type__dog_vdi.html">cdist-type__dog_vdi(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__file (<a href="../man7/cdist-type__file.html">cdist-type__file(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__firewalld_rule (<a href="../man7/cdist-type__firewalld_rule.html">cdist-type__firewalld_rule(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__git (<a href="../man7/cdist-type__git.html">cdist-type__git(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__group (<a href="../man7/cdist-type__group.html">cdist-type__group(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__hostname (<a href="../man7/cdist-type__hostname.html">cdist-type__hostname(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__iptables_apply (<a href="../man7/cdist-type__iptables_apply.html">cdist-type__iptables_apply(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__iptables_rule (<a href="../man7/cdist-type__iptables_rule.html">cdist-type__iptables_rule(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__issue (<a href="../man7/cdist-type__issue.html">cdist-type__issue(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__jail (<a href="../man7/cdist-type__jail.html">cdist-type__jail(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__key_value (<a href="../man7/cdist-type__key_value.html">cdist-type__key_value(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__line (<a href="../man7/cdist-type__line.html">cdist-type__line(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__link (<a href="../man7/cdist-type__link.html">cdist-type__link(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__locale (<a href="../man7/cdist-type__locale.html">cdist-type__locale(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__motd (<a href="../man7/cdist-type__motd.html">cdist-type__motd(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__mount (<a href="../man7/cdist-type__mount.html">cdist-type__mount(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__mysql_database (<a href="../man7/cdist-type__mysql_database.html">cdist-type__mysql_database(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package (<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_apt (<a href="../man7/cdist-type__package_apt.html">cdist-type__package_apt(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_emerge (<a href="../man7/cdist-type__package_emerge.html">cdist-type__package_emerge(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_emerge_dependencies (<a href="../man7/cdist-type__package_emerge_dependencies.html">cdist-type__package_emerge_dependencies(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_luarocks (<a href="../man7/cdist-type__package_luarocks.html">cdist-type__package_luarocks(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_opkg (<a href="../man7/cdist-type__package_opkg.html">cdist-type__package_opkg(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pacman (<a href="../man7/cdist-type__package_pacman.html">cdist-type__package_pacman(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pip (<a href="../man7/cdist-type__package_pip.html">cdist-type__package_pip(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pkg_freebsd (<a href="../man7/cdist-type__package_pkg_freebsd.html">cdist-type__package_pkg_freebsd(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pkg_openbsd (<a href="../man7/cdist-type__package_pkg_openbsd.html">cdist-type__package_pkg_openbsd(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_pkgng_freebsd (<a href="../man7/cdist-type__package_pkgng_freebsd.html">cdist-type__package_pkgng_freebsd(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_rubygem (<a href="../man7/cdist-type__package_rubygem.html">cdist-type__package_rubygem(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_update_index (<a href="../man7/cdist-type__package_update_index.html">cdist-type__package_update_index(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_upgrade_all (<a href="../man7/cdist-type__package_upgrade_all.html">cdist-type__package_upgrade_all(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_yum (<a href="../man7/cdist-type__package_yum.html">cdist-type__package_yum(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__package_zypper (<a href="../man7/cdist-type__package_zypper.html">cdist-type__package_zypper(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__pacman_conf (<a href="../man7/cdist-type__pacman_conf.html">cdist-type__pacman_conf(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__pacman_conf_integrate (<a href="../man7/cdist-type__pacman_conf_integrate.html">cdist-type__pacman_conf_integrate(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__pf_apply (<a href="../man7/cdist-type__pf_apply.html">cdist-type__pf_apply(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__pf_ruleset (<a href="../man7/cdist-type__pf_ruleset.html">cdist-type__pf_ruleset(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postfix (<a href="../man7/cdist-type__postfix.html">cdist-type__postfix(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postfix_master (<a href="../man7/cdist-type__postfix_master.html">cdist-type__postfix_master(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postfix_postconf (<a href="../man7/cdist-type__postfix_postconf.html">cdist-type__postfix_postconf(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postfix_postmap (<a href="../man7/cdist-type__postfix_postmap.html">cdist-type__postfix_postmap(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postfix_reload (<a href="../man7/cdist-type__postfix_reload.html">cdist-type__postfix_reload(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postgres_database (<a href="../man7/cdist-type__postgres_database.html">cdist-type__postgres_database(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__postgres_role (<a href="../man7/cdist-type__postgres_role.html">cdist-type__postgres_role(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__process (<a href="../man7/cdist-type__process.html">cdist-type__process(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__pyvenv (<a href="../man7/cdist-type__pyvenv.html">cdist-type__pyvenv(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__qemu_img (<a href="../man7/cdist-type__qemu_img.html">cdist-type__qemu_img(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__rbenv (<a href="../man7/cdist-type__rbenv.html">cdist-type__rbenv(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__rsync (<a href="../man7/cdist-type__rsync.html">cdist-type__rsync(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__rvm (<a href="../man7/cdist-type__rvm.html">cdist-type__rvm(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__rvm_gem (<a href="../man7/cdist-type__rvm_gem.html">cdist-type__rvm_gem(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__rvm_gemset (<a href="../man7/cdist-type__rvm_gemset.html">cdist-type__rvm_gemset(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__rvm_ruby (<a href="../man7/cdist-type__rvm_ruby.html">cdist-type__rvm_ruby(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__ssh_authorized_key (<a href="../man7/cdist-type__ssh_authorized_key.html">cdist-type__ssh_authorized_key(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__ssh_authorized_keys (<a href="../man7/cdist-type__ssh_authorized_keys.html">cdist-type__ssh_authorized_keys(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__ssh_dot_ssh (<a href="../man7/cdist-type__ssh_dot_ssh.html">cdist-type__ssh_dot_ssh(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__staged_file (<a href="../man7/cdist-type__staged_file.html">cdist-type__staged_file(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__start_on_boot (<a href="../man7/cdist-type__start_on_boot.html">cdist-type__start_on_boot(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__timezone (<a href="../man7/cdist-type__timezone.html">cdist-type__timezone(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__update_alternatives (<a href="../man7/cdist-type__update_alternatives.html">cdist-type__update_alternatives(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__user (<a href="../man7/cdist-type__user.html">cdist-type__user(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__user_groups (<a href="../man7/cdist-type__user_groups.html">cdist-type__user_groups(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__yum_repo (<a href="../man7/cdist-type__yum_repo.html">cdist-type__yum_repo(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__zypper_repo (<a href="../man7/cdist-type__zypper_repo.html">cdist-type__zypper_repo(7)</a>)
|
||||||
|
</li><li class="listitem">
|
||||||
|
__zypper_service (<a href="../man7/cdist-type__zypper_service.html">cdist-type__zypper_service(7)</a>)
|
||||||
|
</li></ul></div></div><div class="section" title="5. OBJECTS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_objects"></a>5. OBJECTS</h2></div></div></div><p>For object to object communication and tests, the following paths are
|
||||||
|
usable within a object directory:</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
files
|
||||||
|
</span></dt><dd>
|
||||||
|
This directory is reserved for user data and will not be used
|
||||||
|
by cdist at any time. It can be used freely by the type
|
||||||
|
(for instance to store template results).
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
changed
|
||||||
|
</span></dt><dd>
|
||||||
|
This empty file exists in an object directory, if the object has
|
||||||
|
code to be excuted (either remote or local)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
stdin
|
||||||
|
</span></dt><dd>
|
||||||
|
This file exists and contains data, if data was provided on stdin
|
||||||
|
when the type was called.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. ENVIRONMENT VARIABLES (FOR READING)"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment_variables_for_reading"></a>6. ENVIRONMENT VARIABLES (FOR READING)</h2></div></div></div><p>The following environment variables are exported by cdist:</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
__explorer
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains all global explorers.
|
||||||
|
Available for: initial manifest, explorer, type explorer, shell
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__manifest
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains the initial manifest.
|
||||||
|
Available for: initial manifest, type manifest, shell
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__global
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains generic output like explorer.
|
||||||
|
Available for: initial manifest, type manifest, type gencode, shell
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__messages_in
|
||||||
|
</span></dt><dd>
|
||||||
|
File to read messages from.
|
||||||
|
Available for: initial manifest, type manifest, type gencode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__messages_out
|
||||||
|
</span></dt><dd>
|
||||||
|
File to write messages.
|
||||||
|
Available for: initial manifest, type manifest, type gencode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__object
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains the current object.
|
||||||
|
Available for: type manifest, type explorer, type gencode and code scripts
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__object_id
|
||||||
|
</span></dt><dd>
|
||||||
|
The type unique object id.
|
||||||
|
Available for: type manifest, type explorer, type gencode and code scripts
|
||||||
|
Note: The leading and the trailing "/" will always be stripped (caused by
|
||||||
|
the filesystem database and ensured by the core).
|
||||||
|
Note: Double slashes ("//") will not be fixed and result in an error.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__object_name
|
||||||
|
</span></dt><dd>
|
||||||
|
The full qualified name of the current object.
|
||||||
|
Available for: type manifest, type explorer, type gencode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__target_host
|
||||||
|
</span></dt><dd>
|
||||||
|
The host we are deploying to.
|
||||||
|
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__type
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to the current type.
|
||||||
|
Available for: type manifest, type gencode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
__type_explorer
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory that contains the type explorers.
|
||||||
|
Available for: type explorer
|
||||||
|
</dd></dl></div></div><div class="section" title="7. ENVIRONMENT VARIABLES (FOR WRITING)"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment_variables_for_writing"></a>7. ENVIRONMENT VARIABLES (FOR WRITING)</h2></div></div></div><p>The following environment variables influence the behaviour of cdist:</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
require
|
||||||
|
</span></dt><dd>
|
||||||
|
Setup dependencies between objects (see <a href="../man7/cdist-manifest.html">cdist-manifest(7)</a>)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_LOCAL_SHELL
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this shell locally instead of /bin/sh to execute scripts
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_REMOTE_SHELL
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this shell remotely instead of /bin/sh to execute scripts
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_OVERRIDE
|
||||||
|
</span></dt><dd>
|
||||||
|
Allow overwriting type parameters (see <a href="../man7/cdist-manifest.html">cdist-manifest(7)</a>)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_ORDER_DEPENDENCY
|
||||||
|
</span></dt><dd>
|
||||||
|
Create dependencies based on the execution order (see <a href="../man7/cdist-manifest.html">cdist-manifest(7)</a>)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_REMOTE_EXEC
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this command for remote execution (should behave like ssh)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
CDIST_REMOTE_COPY
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this command for remote copy (should behave like scp)
|
||||||
|
</dd></dl></div></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2011-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
14
software/cdist/man/4.0.0/man7/cdist-remote-exec-copy.html
Normal file
14
software/cdist/man/4.0.0/man7/cdist-remote-exec-copy.html
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-remote-exec-copy(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-remote-exec-copy(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-remote-exec-copy(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_intro">2. INTRO</a></span></dt><dt><span class="section"><a href="#_examples">3. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">4. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">5. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-remote-exec-copy - How to use remote exec and copy</p></div><div class="section" title="2. INTRO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_intro"></a>2. INTRO</h2></div></div></div><p>Cdist interacts with the target host in two ways:
|
||||||
|
- it executes code (<span class="emphasis"><em>remote_exec)
|
||||||
|
- and it copies files (</em></span>remote_copy)</p><p>By default this is accomplished with ssh and scp respectively.
|
||||||
|
The default implementations used by cdist are:
|
||||||
|
<span class="emphasis"><em>remote_exec: ssh -o User=root -q
|
||||||
|
</em></span>remote_copy: scp -o User=root -q</p><p>The user can override these defaults by providing custom implementations and
|
||||||
|
passing them to cdist with the --remote-exec and/or --remote-copy arguments.</p><p>For <span class="emphasis"><em>remote_exec, the custom implementation must behave as if it where ssh.
|
||||||
|
For </em></span>remote_copy, it must behave like scp.</p><p>With this simple interface the user can take total control of how cdist
|
||||||
|
interacts with the target when required, while the default implementation
|
||||||
|
remains as simple as possible.</p></div><div class="section" title="3. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>3. EXAMPLES</h2></div></div></div><p>See cdist/other/examples/remote/ for some example implementations.</p></div><div class="section" title="4. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>4. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist.html">cdist(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="5. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>5. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
28
software/cdist/man/4.0.0/man7/cdist-stages.html
Normal file
28
software/cdist/man/4.0.0/man7/cdist-stages.html
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-stages(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-stages(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-stages(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_stage_1_target_information_retrieval">3. STAGE 1: TARGET INFORMATION RETRIEVAL</a></span></dt><dt><span class="section"><a href="#_stage_2_run_the_initial_manifest">4. STAGE 2: RUN THE INITIAL MANIFEST</a></span></dt><dt><span class="section"><a href="#_stage_3_object_information_retrieval">5. STAGE 3: OBJECT INFORMATION RETRIEVAL</a></span></dt><dt><span class="section"><a href="#_stage_4_run_the_object_manifest">6. STAGE 4: RUN THE OBJECT MANIFEST</a></span></dt><dt><span class="section"><a href="#_stage_5_code_generation">7. STAGE 5: CODE GENERATION</a></span></dt><dt><span class="section"><a href="#_stage_6_code_execution">8. STAGE 6: CODE EXECUTION</a></span></dt><dt><span class="section"><a href="#_stage_7_cache">9. STAGE 7: CACHE</a></span></dt><dt><span class="section"><a href="#_summary">10. SUMMARY</a></span></dt><dt><span class="section"><a href="#_see_also">11. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">12. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-stages - Stages used during configuration deployment</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Starting the execution of deployment with cdist, cdist passes
|
||||||
|
through different stages.</p></div><div class="section" title="3. STAGE 1: TARGET INFORMATION RETRIEVAL"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_1_target_information_retrieval"></a>3. STAGE 1: TARGET INFORMATION RETRIEVAL</h2></div></div></div><p>In this stage information is collected about the target host using so called
|
||||||
|
explorers. Every existing explorer is run on the target and the output of all
|
||||||
|
explorers are copied back into the local cache. The results can be used by
|
||||||
|
manifests and types.</p></div><div class="section" title="4. STAGE 2: RUN THE INITIAL MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_2_run_the_initial_manifest"></a>4. STAGE 2: RUN THE INITIAL MANIFEST</h2></div></div></div><p>The initial manifest, which should be used for mappings of hosts to types,
|
||||||
|
is executed. This stage creates objects in a cconfig database that contains
|
||||||
|
the objects as defined in the manifest for the specific host. In this stage,
|
||||||
|
no conflicts may occur, i.e. no object of the same type with the same id may
|
||||||
|
be created, if it has different parameters.</p></div><div class="section" title="5. STAGE 3: OBJECT INFORMATION RETRIEVAL"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_3_object_information_retrieval"></a>5. STAGE 3: OBJECT INFORMATION RETRIEVAL</h2></div></div></div><p>Every object is checked whether its type has explorers and if so, these are
|
||||||
|
executed on the target host. The results are transferred back
|
||||||
|
and can be used in the following stages to decide what changes need to be made
|
||||||
|
on the target to implement the desired state.</p></div><div class="section" title="6. STAGE 4: RUN THE OBJECT MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_4_run_the_object_manifest"></a>6. STAGE 4: RUN THE OBJECT MANIFEST</h2></div></div></div><p>Every object is checked whether its type has a executable manifest. The
|
||||||
|
manifest script may generate and change the created objects. In other words,
|
||||||
|
one type can reuse other types.</p><p>For instance the object <span class="emphasis"><em>apache/www.example.org is of type </em></span>apache, which may
|
||||||
|
contain a manifest script, which creates new objects of type __file.</p><p>The newly created objects are merged back into the existing tree. No conflicts
|
||||||
|
may occur during the merge. A conflict would mean that two different objects
|
||||||
|
try to create the same object, which indicates a broken configuration.</p></div><div class="section" title="7. STAGE 5: CODE GENERATION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_5_code_generation"></a>7. STAGE 5: CODE GENERATION</h2></div></div></div><p>In this stage for every created object its type is checked for executable
|
||||||
|
gencode scripts. The gencode scripts generate the code to be executed on the
|
||||||
|
target on stdout. If the gencode executables fail, they must print diagnostic
|
||||||
|
messages on stderr and exit non-zero.</p></div><div class="section" title="8. STAGE 6: CODE EXECUTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_6_code_execution"></a>8. STAGE 6: CODE EXECUTION</h2></div></div></div><p>For every object the resulting code from the previous stage is transferred to
|
||||||
|
the target host and executed there to apply the configuration changes.</p></div><div class="section" title="9. STAGE 7: CACHE"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_stage_7_cache"></a>9. STAGE 7: CACHE</h2></div></div></div><p>The cache stores the information from the current run for later use.</p></div><div class="section" title="10. SUMMARY"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_summary"></a>10. SUMMARY</h2></div></div></div><p>If, and only if, all the stages complete without an errors, the configuration
|
||||||
|
will be applied to the target.</p></div><div class="section" title="11. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>11. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-reference.html">cdist-reference(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="12. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>12. COPYING</h2></div></div></div><p>Copyright (C) 2010-2012 Nico Schottelius, Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
28
software/cdist/man/4.0.0/man7/cdist-troubleshooting.html
Normal file
28
software/cdist/man/4.0.0/man7/cdist-troubleshooting.html
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-troubleshooting(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-troubleshooting(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-troubleshooting(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_error_in_manifest_is_not_considered_an_error_by_cdist">2. ERROR IN MANIFEST IS NOT CONSIDERED AN ERROR BY CDIST</a></span></dt><dt><span class="section"><a href="#_see_also">3. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">4. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-troubleshooting - common problems and their solutions</p></div><div class="section" title="2. ERROR IN MANIFEST IS NOT CONSIDERED AN ERROR BY CDIST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_error_in_manifest_is_not_considered_an_error_by_cdist"></a>2. ERROR IN MANIFEST IS NOT CONSIDERED AN ERROR BY CDIST</h2></div></div></div><p>Situation: You are executing other scripts from a manifest.
|
||||||
|
This script fails, but cdist does not recognise the error.
|
||||||
|
An example script would be something like this:</p><pre class="screen">% cat ~/.cdist/manifest/init
|
||||||
|
"$__manifest/special"
|
||||||
|
% cat ~/.cdist/manifest/special
|
||||||
|
#!/bin/sh
|
||||||
|
echo "Here is an unclean exiting script"
|
||||||
|
somecommandthatdoesnotexist
|
||||||
|
echo "I continue here although previous command failed"</pre><p>We can clearly see that <span class="strong"><strong>somecommandthatdoesnotexist</strong></span>
|
||||||
|
will fail in ~/.cdist/manifest/special. But as the custom
|
||||||
|
script is not called with the -e flag (exit on failure) of shell,
|
||||||
|
it does not lead to an error. And thus cdist sees the exit 0
|
||||||
|
code of the last echo line instead of the failing command.</p><p>All scripts executed by cdist carry the -e flag.
|
||||||
|
To prevent the above from happening, there are three solutions available,
|
||||||
|
two of which can be used in the calling script:</p><pre class="screen"># Execute as before, but abort on failure
|
||||||
|
sh -e "$__manifest/special"
|
||||||
|
|
||||||
|
# Source the script in our namespace, runs in a set -e environment:
|
||||||
|
. "$__manifest/special"</pre><p>The third solution is to include a shebang header in every script
|
||||||
|
you write to use the -e flag:</p><pre class="screen">% cat ~/.cdist/manifest/special
|
||||||
|
#!/bin/sh -e
|
||||||
|
...</pre></div><div class="section" title="3. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>3. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-tutorial.html">cdist-tutorial(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="4. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>4. COPYING</h2></div></div></div><p>Copyright (C) 2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
53
software/cdist/man/4.0.0/man7/cdist-tutorial.html
Normal file
53
software/cdist/man/4.0.0/man7/cdist-tutorial.html
Normal file
|
|
@ -0,0 +1,53 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-tutorial(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-tutorial(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-tutorial(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_introduction">2. INTRODUCTION</a></span></dt><dt><span class="section"><a href="#_see_also">3. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">4. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-tutorial - a guided introduction into cdist</p></div><div class="section" title="2. INTRODUCTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_introduction"></a>2. INTRODUCTION</h2></div></div></div><p>This document gives you a pointer on what to read in
|
||||||
|
which order and is thus a "guide to the right locations".
|
||||||
|
So in case you are just starting, just "begin at the beginning"
|
||||||
|
(Brave New World). You can see the target audience in [] brackets
|
||||||
|
after the description.</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
cdist-quickstart
|
||||||
|
</span></dt><dd>
|
||||||
|
New to cdist? Want to get your hands dirty? Read this. [beginner]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-bootstrap
|
||||||
|
</span></dt><dd>
|
||||||
|
The comprehensive guide to your first cdist installation [beginner]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-manifest
|
||||||
|
</span></dt><dd>
|
||||||
|
Learn how to define which hosts get which configurations [beginner]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-type
|
||||||
|
</span></dt><dd>
|
||||||
|
Understand how types are working and created [intermediate]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-best-practice
|
||||||
|
</span></dt><dd>
|
||||||
|
Hints from real life experience to help you to organise cdist [intermediate]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-reference
|
||||||
|
</span></dt><dd>
|
||||||
|
The type, explorers and environment variables reference [intermediate]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-explorer
|
||||||
|
</span></dt><dd>
|
||||||
|
Interested in getting more information about the target system? [intermediate]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-stages
|
||||||
|
</span></dt><dd>
|
||||||
|
Understand the internal workflow of cdist. [advanced]
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cdist-hacker
|
||||||
|
</span></dt><dd>
|
||||||
|
README, if you want to extend or modify cdist. [hacker]
|
||||||
|
</dd></dl></div></div><div class="section" title="3. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>3. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/cdist.html">cdist(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-best-practice.html">cdist-best-practice(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-stages.html">cdist-stages(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
Brave New World by Aldous Huxley
|
||||||
|
</li></ul></div></div><div class="section" title="4. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>4. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
144
software/cdist/man/4.0.0/man7/cdist-type.html
Normal file
144
software/cdist/man/4.0.0/man7/cdist-type.html
Normal file
|
|
@ -0,0 +1,144 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_synopsis">2. SYNOPSIS</a></span></dt><dt><span class="section"><a href="#_description">3. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_how_to_use_a_type">4. HOW TO USE A TYPE</a></span></dt><dt><span class="section"><a href="#_singleton_types">5. SINGLETON TYPES</a></span></dt><dt><span class="section"><a href="#_how_to_write_a_new_type">6. HOW TO WRITE A NEW TYPE</a></span></dt><dt><span class="section"><a href="#_defining_parameters">7. DEFINING PARAMETERS</a></span></dt><dt><span class="section"><a href="#_using_parameters">8. USING PARAMETERS</a></span></dt><dt><span class="section"><a href="#_input_from_stdin">9. INPUT FROM STDIN</a></span></dt><dt><span class="section"><a href="#_writing_the_manifest">10. WRITING THE MANIFEST</a></span></dt><dt><span class="section"><a href="#_singleton_one_instance_only">11. SINGLETON - ONE INSTANCE ONLY</a></span></dt><dt><span class="section"><a href="#_the_type_explorers">12. THE TYPE EXPLORERS</a></span></dt><dt><span class="section"><a href="#_writing_the_gencode_script">13. WRITING THE GENCODE SCRIPT</a></span></dt><dt><span class="section"><a href="#_variable_access_from_the_generated_scripts">14. VARIABLE ACCESS FROM THE GENERATED SCRIPTS</a></span></dt><dt><span class="section"><a href="#_hints_for_typewriters">15. HINTS FOR TYPEWRITERS</a></span></dt><dt><span class="section"><a href="#_how_to_include_a_type_into_upstream_cdist">16. HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST</a></span></dt><dt><span class="section"><a href="#_see_also">17. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">18. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type - Functionality bundled</p></div><div class="section" title="2. SYNOPSIS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_synopsis"></a>2. SYNOPSIS</h2></div></div></div><p>__TYPE ID --parameter value [--parameter value …]</p><p>__TYPE --parameter value [--parameter value …] (for singletons)</p></div><div class="section" title="3. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>3. DESCRIPTION</h2></div></div></div><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" title="4. HOW TO USE A TYPE"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_to_use_a_type"></a>4. HOW TO USE A TYPE</h2></div></div></div><p>You can use types from the initial manifest or the type manifest like a
|
||||||
|
normal shell command:</p><pre class="screen"># Creates empty file /etc/cdist-configured
|
||||||
|
__file /etc/cdist-configured --type file
|
||||||
|
|
||||||
|
# Ensure tree is installed
|
||||||
|
__package tree --state installed</pre><p>A list of supported types can be found in the <a href="../man7/cdist-reference.html">cdist-reference(7)</a> manpage.</p></div><div class="section" title="5. SINGLETON TYPES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_singleton_types"></a>5. SINGLETON TYPES</h2></div></div></div><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><pre class="screen"># __issue type manages /etc/issue
|
||||||
|
__issue
|
||||||
|
|
||||||
|
# Probably your own type - singletons may use parameters
|
||||||
|
__myfancysingleton --colour green</pre></div><div class="section" title="6. HOW TO WRITE A NEW TYPE"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_to_write_a_new_type"></a>6. HOW TO WRITE A NEW TYPE</h2></div></div></div><p>A type consists of</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
parameter (optional)
|
||||||
|
</li><li class="listitem">
|
||||||
|
manifest (optional)
|
||||||
|
</li><li class="listitem">
|
||||||
|
singleton (optional)
|
||||||
|
</li><li class="listitem">
|
||||||
|
explorer (optional)
|
||||||
|
</li><li class="listitem">
|
||||||
|
gencode (optional)
|
||||||
|
</li></ul></div><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 <span class="strong"><strong>cdist/conf/type/__NAME</strong></span>.</p></div><div class="section" title="7. DEFINING PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_defining_parameters"></a>7. DEFINING PARAMETERS</h2></div></div></div><p>Every type consists of required, optional and boolean parameters, which must
|
||||||
|
each be declared in a newline separated file in <span class="strong"><strong><span class="strong"><strong>parameter/required</strong></span></strong></span>,
|
||||||
|
<span class="strong"><strong><span class="strong"><strong>parameter/required_multiple</strong></span></strong></span>, <span class="strong"><strong><span class="strong"><strong>parameter/optional</strong></span></strong></span>,
|
||||||
|
<span class="strong"><strong><span class="strong"><strong>parameter/optional_multiple</strong></span></strong></span> and <span class="strong"><strong><span class="strong"><strong>parameter/boolean</strong></span></strong></span>.
|
||||||
|
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
|
||||||
|
<span class="strong"><strong><span class="strong"><strong>parameter/default/<name></strong></span></strong></span>.</p><p>Example:</p><pre class="screen">echo servername >> cdist/conf/type/__nginx_vhost/parameter/required
|
||||||
|
echo logdirectory >> cdist/conf/type/__nginx_vhost/parameter/optional
|
||||||
|
echo loglevel >> cdist/conf/type/__nginx_vhost/parameter/optional
|
||||||
|
mkdir cdist/conf/type/__nginx_vhost/parameter/default
|
||||||
|
echo warning > cdist/conf/type/__nginx_vhost/parameter/default/loglevel
|
||||||
|
echo server_alias >> cdist/conf/type/__nginx_vhost/parameter/optional_multiple
|
||||||
|
echo use_ssl >> cdist/conf/type/__nginx_vhost/parameter/boolean</pre></div><div class="section" title="8. USING PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_using_parameters"></a>8. USING PARAMETERS</h2></div></div></div><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><pre class="screen"># required parameter
|
||||||
|
servername="$(cat "$__object/parameter/servername")"
|
||||||
|
|
||||||
|
# optional parameter
|
||||||
|
if [ -f "$__object/parameter/logdirectory" ]; then
|
||||||
|
logdirectory="$(cat "$__object/parameter/logdirectory")"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# optional parameter with predefined default
|
||||||
|
loglevel="$(cat "$__object/parameter/loglevel")"
|
||||||
|
|
||||||
|
# boolean parameter
|
||||||
|
if [ -f "$__object/parameter/use_ssl" ]; then
|
||||||
|
# file exists -> True
|
||||||
|
# do some fancy ssl stuff
|
||||||
|
fi
|
||||||
|
|
||||||
|
# parameter with multiple values
|
||||||
|
if [ -f "$__object/parameter/server_alias" ]; then
|
||||||
|
for alias in $(cat "$__object/parameter/server_alias"); do
|
||||||
|
echo $alias > /some/where/usefull
|
||||||
|
done
|
||||||
|
fi</pre></div><div class="section" title="9. INPUT FROM STDIN"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_input_from_stdin"></a>9. INPUT FROM STDIN</h2></div></div></div><p>Every type can access what has been written on stdin when it has been called.
|
||||||
|
The result is saved into the <span class="strong"><strong><span class="strong"><strong>stdin</strong></span></strong></span> file in the object directory.</p><p>Example use of a type: (e.g. in cdist/conf/type/__archlinux_hostname)</p><pre class="screen">__file /etc/rc.conf --source - << eof
|
||||||
|
...
|
||||||
|
HOSTNAME="$__target_host"
|
||||||
|
...
|
||||||
|
eof</pre><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><pre class="screen"> if [ -f "$__object/parameter/source" ]; then
|
||||||
|
source="$(cat "$__object/parameter/source")"
|
||||||
|
if [ "$source" = "-" ]; then
|
||||||
|
source="$__object/stdin"
|
||||||
|
fi
|
||||||
|
....</pre></div><div class="section" title="10. WRITING THE MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_the_manifest"></a>10. WRITING THE MANIFEST</h2></div></div></div><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><pre class="screen">os="$(cat "$__global/explorer/os")"
|
||||||
|
case "$os" in
|
||||||
|
archlinux) type="pacman" ;;
|
||||||
|
debian|ubuntu) type="apt" ;;
|
||||||
|
gentoo) type="emerge" ;;
|
||||||
|
*)
|
||||||
|
echo "Don't know how to manage packages on: $os" >&2
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
__package_$type "$@"</pre><p>As you can see, the type can reference different environment variables,
|
||||||
|
which are documented in <a href="../man7/cdist-reference.html">cdist-reference(7)</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 href="../man7/cdist-manifest.html">cdist-manifest(7)</a>.</p></div><div class="section" title="11. SINGLETON - ONE INSTANCE ONLY"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_singleton_one_instance_only"></a>11. SINGLETON - ONE INSTANCE ONLY</h2></div></div></div><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><pre class="screen">touch cdist/conf/type/__NAME/singleton</pre><p>This will also change the way your type must be called:</p><pre class="screen">__YOURTYPE --parameter value</pre><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" title="12. THE TYPE EXPLORERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_the_type_explorers"></a>12. THE TYPE EXPLORERS</h2></div></div></div><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><pre class="screen">if [ -f "$__object/parameter/destination" ]; then
|
||||||
|
destination="$(cat "$__object/parameter/destination")"
|
||||||
|
else
|
||||||
|
destination="/$__object_id"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [ -e "$destination" ]; then
|
||||||
|
md5sum < "$destination"
|
||||||
|
fi</pre></div><div class="section" title="13. WRITING THE GENCODE SCRIPT"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_the_gencode_script"></a>13. WRITING THE GENCODE SCRIPT</h2></div></div></div><p>There are two gencode scripts: <span class="strong"><strong><span class="strong"><strong>gencode-local</strong></span></strong></span> and <span class="strong"><strong><span class="strong"><strong>gencode-remote</strong></span></strong></span>.
|
||||||
|
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><pre class="screen"># Debug output to stderr
|
||||||
|
echo "My fancy debug line" >&2
|
||||||
|
|
||||||
|
# Output to be saved by cdist for execution on the target
|
||||||
|
echo "touch /etc/cdist-configured"</pre></div><div class="section" title="14. VARIABLE ACCESS FROM THE GENERATED SCRIPTS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_variable_access_from_the_generated_scripts"></a>14. VARIABLE ACCESS FROM THE GENERATED SCRIPTS</h2></div></div></div><p>In the generated scripts, you have access to the following cdist variables</p><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
__object
|
||||||
|
</li><li class="listitem">
|
||||||
|
__object_id
|
||||||
|
</li></ul></div><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><pre class="screen">if [ -f "$__object/parameter/name" ]; then
|
||||||
|
name="$(cat "$__object/parameter/name")"
|
||||||
|
else
|
||||||
|
name="$__object_id"
|
||||||
|
fi</pre></div><div class="section" title="15. HINTS FOR TYPEWRITERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_hints_for_typewriters"></a>15. HINTS FOR TYPEWRITERS</h2></div></div></div><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" title="16. HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_how_to_include_a_type_into_upstream_cdist"></a>16. HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST</h2></div></div></div><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 href="../man7/cdist-hacker.html">cdist-hacker(7)</a> on
|
||||||
|
how to submit it.</p></div><div class="section" title="17. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>17. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-explorer.html">cdist-explorer(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-hacker.html">cdist-hacker(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-stages.html">cdist-stages(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-tutorial.html">cdist-tutorial(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="18. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>18. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
29
software/cdist/man/4.0.0/man7/cdist-type__apt_key.html
Normal file
29
software/cdist/man/4.0.0/man7/cdist-type__apt_key.html
Normal file
|
|
@ -0,0 +1,29 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__apt_key(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__apt_key(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__apt_key(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__apt_key - manage the list of keys used by apt</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Manages the list of keys used by apt to authenticate packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
keyid
|
||||||
|
</span></dt><dd>
|
||||||
|
the id of the key to add. Defaults to __object_id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
keyserver
|
||||||
|
</span></dt><dd>
|
||||||
|
the keyserver from which to fetch the key. If omitted the default set in
|
||||||
|
./parameter/default/keyserver is used.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Add Ubuntu Archive Automatic Signing Key
|
||||||
|
__apt_key 437D05B5
|
||||||
|
# Same thing
|
||||||
|
__apt_key 437D05B5 --state present
|
||||||
|
# Get rid of it
|
||||||
|
__apt_key 437D05B5 --state absent
|
||||||
|
|
||||||
|
# same thing with human readable name and explicit keyid
|
||||||
|
__apt_key UbuntuArchiveKey --keyid 437D05B5
|
||||||
|
|
||||||
|
# same thing with other keyserver
|
||||||
|
__apt_key UbuntuArchiveKey --keyid 437D05B5 --keyserver keyserver.ubuntu.com</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
21
software/cdist/man/4.0.0/man7/cdist-type__apt_key_uri.html
Normal file
21
software/cdist/man/4.0.0/man7/cdist-type__apt_key_uri.html
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__apt_key_uri(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__apt_key_uri(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685136"></a>cdist-type__apt_key_uri(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__apt_key_uri - add apt key from uri</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Download a key from an uri and add it to the apt keyring.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
uri
|
||||||
|
</span></dt><dd>
|
||||||
|
the uri from which to download the key
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
a name for this key, used when testing if it is already installed.
|
||||||
|
Defaults to __object_id
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__apt_key_uri rabbitmq \
|
||||||
|
--name 'RabbitMQ Release Signing Key <info@rabbitmq.com>' \
|
||||||
|
--uri http://www.rabbitmq.com/rabbitmq-signing-key-public.asc \
|
||||||
|
--state present</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html"><a href="../man7/cdist-type.html">cdist-type(7)</a></a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__apt_norecommends(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__apt_norecommends(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681168"></a>cdist-type__apt_norecommends(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__apt_norecommends - configure apt to not install recommended packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Configure apt to not install any recommended or suggested packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__apt_norecommends</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
16
software/cdist/man/4.0.0/man7/cdist-type__apt_ppa.html
Normal file
16
software/cdist/man/4.0.0/man7/cdist-type__apt_ppa.html
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__apt_ppa(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__apt_ppa(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__apt_ppa(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__apt_ppa - Manage ppa repositories</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows manage ubuntu ppa repositories.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
The state the ppa should be in, either <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>.
|
||||||
|
Defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Enable a ppa repository
|
||||||
|
__apt_ppa ppa:sans-intern/missing-bits
|
||||||
|
# same as
|
||||||
|
__apt_ppa ppa:sans-intern/missing-bits --state present
|
||||||
|
|
||||||
|
# Disable a ppa repository
|
||||||
|
__apt_ppa ppa:sans-intern/missing-bits --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
39
software/cdist/man/4.0.0/man7/cdist-type__apt_source.html
Normal file
39
software/cdist/man/4.0.0/man7/cdist-type__apt_source.html
Normal file
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__apt_source(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__apt_source(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60593232"></a>cdist-type__apt_source(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__apt_source - manage apt sources</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to manage apt sources.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
uri
|
||||||
|
</span></dt><dd>
|
||||||
|
the uri to the apt repository
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
arch
|
||||||
|
</span></dt><dd>
|
||||||
|
set this if you need to force and specific arch (ubuntu specific)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
distribution
|
||||||
|
</span></dt><dd>
|
||||||
|
the distribution codename to use. Defaults to DISTRIB_CODENAME from
|
||||||
|
the targets /etc/lsb-release
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
component
|
||||||
|
</span></dt><dd>
|
||||||
|
space delimited list of components to enable. Defaults to an empty string.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
include-src
|
||||||
|
</span></dt><dd>
|
||||||
|
include deb-src entries
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen">__apt_source rabbitmq \
|
||||||
|
--uri http://www.rabbitmq.com/debian/ \
|
||||||
|
--distribution testing \
|
||||||
|
--component main \
|
||||||
|
--include-src \
|
||||||
|
--state present
|
||||||
|
|
||||||
|
__apt_source canonical_partner \
|
||||||
|
--uri http://archive.canonical.com/ \
|
||||||
|
--component partner --state present</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2011-2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__apt_update_index(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__apt_update_index(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60310736"></a>cdist-type__apt_update_index(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__apt_update_index - Update apt’s package index</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type runs apt-get update whenever any apt sources have changed.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__apt_update_index</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
56
software/cdist/man/4.0.0/man7/cdist-type__block.html
Normal file
56
software/cdist/man/4.0.0/man7/cdist-type__block.html
Normal file
|
|
@ -0,0 +1,56 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__block(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__block(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__block(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">5. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__block - Manage blocks of text in files</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Manage a block of text in an existing file.
|
||||||
|
The block is identified using the prefix and suffix parameters.
|
||||||
|
Everything between prefix and suffix is considered to be a managed block
|
||||||
|
of text.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
text
|
||||||
|
</span></dt><dd>
|
||||||
|
the text to manage.
|
||||||
|
If text is <span class="emphasis"><em>-</em></span> (dash), take what was written to stdin as the text.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd>
|
||||||
|
the file in which to manage the text block.
|
||||||
|
Defaults to object_id.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
prefix
|
||||||
|
</span></dt><dd>
|
||||||
|
the prefix to add before the text.
|
||||||
|
Defaults to #cdist:<span class="emphasis"><em>block/$</em></span>object_id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
suffix
|
||||||
|
</span></dt><dd>
|
||||||
|
the prefix to add after the text.
|
||||||
|
Defaults to #/cdist:<span class="emphasis"><em>block/$</em></span>object_id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd></dl></div></div><div class="section" title="5. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>5. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
add
|
||||||
|
</span></dt><dd>
|
||||||
|
block was added
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
update
|
||||||
|
</span></dt><dd>
|
||||||
|
block was updated/changed
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remove
|
||||||
|
</span></dt><dd>
|
||||||
|
block was removed
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen"># text from argument
|
||||||
|
__block /path/to/file \
|
||||||
|
--prefix '#start' \
|
||||||
|
--suffix '#end' \
|
||||||
|
--text 'some\nblock of\ntext'
|
||||||
|
|
||||||
|
# text from stdin
|
||||||
|
__block some-id \
|
||||||
|
--file /path/to/file \
|
||||||
|
--text - << DONE
|
||||||
|
here some block
|
||||||
|
of text
|
||||||
|
DONE</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2013 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__ccollect_source(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__ccollect_source(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__ccollect_source(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_multiple_parameters">5. OPTIONAL MULTIPLE PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">6. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__ccollect_source - Manage ccollect sources</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create or delete ccollect sources.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
The source from which to backup
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
destination
|
||||||
|
</span></dt><dd>
|
||||||
|
The destination directory
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ccollectconf
|
||||||
|
</span></dt><dd>
|
||||||
|
The CCOLLECT_CONF directory. Defaults to /etc/ccollect.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. OPTIONAL MULTIPLE PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_multiple_parameters"></a>5. OPTIONAL MULTIPLE PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
exclude
|
||||||
|
</span></dt><dd>
|
||||||
|
Paths to exclude of backup
|
||||||
|
</dd></dl></div></div><div class="section" title="6. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>6. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
verbose
|
||||||
|
</span></dt><dd>
|
||||||
|
Whether to report backup verbosely
|
||||||
|
</dd></dl></div></div><div class="section" title="7. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><pre class="screen">__ccollect_source doc.ungleich.ch \
|
||||||
|
--source doc.ungleich.ch:/ \
|
||||||
|
--destination /backup/doc.ungleich.ch \
|
||||||
|
--exclude '/proc/*' --exclude '/sys/*' \
|
||||||
|
--verbose</pre></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/ccollect.html">ccollect(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.nico.schottelius.org/software/ccollect/" target="_top">http://www.nico.schottelius.org/software/ccollect/</a>
|
||||||
|
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
28
software/cdist/man/4.0.0/man7/cdist-type__cdist.html
Normal file
28
software/cdist/man/4.0.0/man7/cdist-type__cdist.html
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__cdist(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__cdist(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60503120"></a>cdist-type__cdist(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__cdist - Manage cdist installations</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to easily setup cdist
|
||||||
|
on another box, to allow the other box to configure
|
||||||
|
systems.</p><p>This type is <span class="strong"><strong>NOT</strong></span> required by target hosts.
|
||||||
|
It is only helpful to build FROM which you configure
|
||||||
|
other hosts.</p><p>This type will use git to clone</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
username
|
||||||
|
</span></dt><dd>
|
||||||
|
Select the user to create for the cdist installation.
|
||||||
|
Defaults to "cdist".
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
Select the source from which to clone cdist from.
|
||||||
|
Defaults to "git://github.com/telmich/cdist.git".
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
branch
|
||||||
|
</span></dt><dd>
|
||||||
|
Select the branch to checkout from.
|
||||||
|
Defaults to "master".
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Install cdist for user cdist in her home as subfolder cdist
|
||||||
|
__cdist /home/cdist/cdist
|
||||||
|
|
||||||
|
# Use alternative source
|
||||||
|
__cdist --source "git://git.schottelius.org/cdist" /home/cdist/cdist</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
22
software/cdist/man/4.0.0/man7/cdist-type__cdistmarker.html
Normal file
22
software/cdist/man/4.0.0/man7/cdist-type__cdistmarker.html
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__cdistmarker(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__cdistmarker(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-type__cdistmarker(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Daniel</span> <span class="surname">Maher</span></h3><code class="email"><<a class="email" href="mailto:phrawzty+cdist--@--gmail.com">phrawzty+cdist--@--gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__cdistmarker - Add a timestamped cdist marker.</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is used to add a common marker file which indicates that a given
|
||||||
|
machine is being managed by cdist. The contents of this file consist of a
|
||||||
|
timestamp, which can be used to determine the most recent time at which cdist
|
||||||
|
was run against the machine in question.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
destination
|
||||||
|
</span></dt><dd>
|
||||||
|
The path and filename of the marker.
|
||||||
|
Default: /etc/cdist-configured
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
format
|
||||||
|
</span></dt><dd>
|
||||||
|
The format of the timestamp. This is passed directly to system <span class="emphasis"><em>date</em></span>.
|
||||||
|
Default: -u
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Creates the marker as normal.
|
||||||
|
__cdistmarker
|
||||||
|
|
||||||
|
# Creates the marker differently.
|
||||||
|
__cdistmarker --destination /tmp/cdist_marker --format '+%s'</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Daniel Maher. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
37
software/cdist/man/4.0.0/man7/cdist-type__config_file.html
Normal file
37
software/cdist/man/4.0.0/man7/cdist-type__config_file.html
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__config_file(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__config_file(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__config_file(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__config_file - manages config files</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Deploy config files using the file type.
|
||||||
|
Run the given code if the files changes.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
see cdist-type__file
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
mode
|
||||||
|
</span></dt><dd>
|
||||||
|
see cdist-type__file
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
onchange
|
||||||
|
</span></dt><dd>
|
||||||
|
the code to run if the file changes
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
see cdist-type__file
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to the config file.
|
||||||
|
If source is <span class="emphasis"><em>-</em></span> (dash), take what was written to stdin as the config file content.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
see cdist-type__file
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__config_file /etc/consul/conf.d/watch_foo.json \
|
||||||
|
--owner root --group consul --mode 640 \
|
||||||
|
--source "$__type/files/watch_foo.json" \
|
||||||
|
--state present \
|
||||||
|
--onchange 'service consul status >/dev/null && service consul reload || true'</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__file.html">cdist-type__file(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
21
software/cdist/man/4.0.0/man7/cdist-type__consul.html
Normal file
21
software/cdist/man/4.0.0/man7/cdist-type__consul.html
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64164944"></a>cdist-type__consul(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul - install consul</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Downloads and installs the consul binary from <a class="ulink" href="https://dl.bintray.com/mitchellh/consul" target="_top">https://dl.bintray.com/mitchellh/consul</a>.
|
||||||
|
Note that the consul binary is downloaded on the server (the machine running
|
||||||
|
cdist) and then deployed to the target host using the __file type.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
either <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
which version of consul to install. See ./files/versions for a list of
|
||||||
|
supported versions. Defaults to the latest known version.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># just install using defaults
|
||||||
|
__consul
|
||||||
|
|
||||||
|
# specific version
|
||||||
|
__consul \
|
||||||
|
--version 0.4.1</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
168
software/cdist/man/4.0.0/man7/cdist-type__consul_agent.html
Normal file
168
software/cdist/man/4.0.0/man7/cdist-type__consul_agent.html
Normal file
|
|
@ -0,0 +1,168 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_agent(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_agent(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__consul_agent(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_agent - manage the consul agent</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Configure and manage the consul agent.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
acl-datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
only used by servers. This designates the datacenter which is authoritative
|
||||||
|
for ACL information.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
acl-default-policy
|
||||||
|
</span></dt><dd>
|
||||||
|
either "allow" or "deny"; defaults to "allow". The default policy controls the
|
||||||
|
behavior of a token when there is no matching rule.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
acl-down-policy
|
||||||
|
</span></dt><dd>
|
||||||
|
either "allow", "deny" or "extend-cache"; "extend-cache" is the default.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
acl-master-token
|
||||||
|
</span></dt><dd>
|
||||||
|
only used for servers in the acl_datacenter. This token will be created with
|
||||||
|
management-level permissions if it does not exist. It allows operators to
|
||||||
|
bootstrap the ACL system with a token ID that is well-known.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
acl-token
|
||||||
|
</span></dt><dd>
|
||||||
|
when provided, the agent will use this token when making requests to the
|
||||||
|
Consul servers.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
acl-ttl
|
||||||
|
</span></dt><dd>
|
||||||
|
used to control Time-To-Live caching of ACLs.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
bind-addr
|
||||||
|
</span></dt><dd>
|
||||||
|
sets the bind address for cluster communication
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
bootstrap-expect
|
||||||
|
</span></dt><dd>
|
||||||
|
sets server to expect bootstrap mode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ca-file-source
|
||||||
|
</span></dt><dd>
|
||||||
|
path to a PEM encoded certificate authority file which will be uploaded and
|
||||||
|
configure using the ca_file config option.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
cert-file-source
|
||||||
|
</span></dt><dd>
|
||||||
|
path to a PEM encoded certificate file which will be uploaded and
|
||||||
|
configure using the cert_file config option.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
client-addr
|
||||||
|
</span></dt><dd>
|
||||||
|
sets the address to bind for client access
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
datacenter of the agent
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
encrypt
|
||||||
|
</span></dt><dd>
|
||||||
|
provides the gossip encryption key
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
the primary group for the agent
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
json-config
|
||||||
|
</span></dt><dd>
|
||||||
|
path to a partial json config file without leading { and trailing }.
|
||||||
|
If json-config is <span class="emphasis"><em>-</em></span> (dash), take what was written to stdin as the file content.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
key-file-source
|
||||||
|
</span></dt><dd>
|
||||||
|
path to a PEM encoded private key file which will be uploaded and
|
||||||
|
configure using the key_file config option.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
node-name
|
||||||
|
</span></dt><dd>
|
||||||
|
name of this node. Must be unique in the cluster
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
retry-join
|
||||||
|
</span></dt><dd>
|
||||||
|
address to attempt joining every retry_interval until at least one join works.
|
||||||
|
Can be specified multiple times.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
user
|
||||||
|
</span></dt><dd>
|
||||||
|
the user to run the agent as
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if the agent is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
Currently state=absent is not working due to some dependency issues.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
disable-remote-exec
|
||||||
|
</span></dt><dd>
|
||||||
|
disables support for remote execution. When set to true, the agent will ignore any incoming remote exec requests.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
disable-update-check
|
||||||
|
</span></dt><dd>
|
||||||
|
disables automatic checking for security bulletins and new version releases
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
leave-on-terminate
|
||||||
|
</span></dt><dd>
|
||||||
|
gracefully leave cluster on SIGTERM
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
rejoin-after-leave
|
||||||
|
</span></dt><dd>
|
||||||
|
rejoin the cluster using the previous state after leaving
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
server
|
||||||
|
</span></dt><dd>
|
||||||
|
used to control if an agent is in server or client mode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
syslog
|
||||||
|
</span></dt><dd>
|
||||||
|
enables logging to syslog
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
verify-incoming
|
||||||
|
</span></dt><dd>
|
||||||
|
enforce the use of TLS and verify a client’s authenticity on incomming connections
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
verify-outgoing
|
||||||
|
</span></dt><dd>
|
||||||
|
enforce the use of TLS and verify the peers authenticity on outgoing connections
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen"># configure as server, bootstrap and rejoin
|
||||||
|
hostname="$(cat "$__global/explorer/hostname")"
|
||||||
|
__consul_agent \
|
||||||
|
--datacenter dc1 \
|
||||||
|
--node-name "${hostname%%.*}" \
|
||||||
|
--disable-update-check \
|
||||||
|
--server \
|
||||||
|
--rejoin-after-leave \
|
||||||
|
--bootstrap-expect 3 \
|
||||||
|
--retry-join consul-01 \
|
||||||
|
--retry-join consul-02 \
|
||||||
|
--retry-join consul-03
|
||||||
|
|
||||||
|
# configure as server, bootstrap and rejoin with ssl support
|
||||||
|
hostname="$(cat "$__global/explorer/hostname")"
|
||||||
|
__consul_agent \
|
||||||
|
--datacenter dc1 \
|
||||||
|
--node-name "${hostname%%.*}" \
|
||||||
|
--disable-update-check \
|
||||||
|
--server \
|
||||||
|
--rejoin-after-leave \
|
||||||
|
--bootstrap-expect 3 \
|
||||||
|
--retry-join consul-01 \
|
||||||
|
--retry-join consul-02 \
|
||||||
|
--retry-join consul-03 \
|
||||||
|
--ca-file-source /path/to/ca.pem \
|
||||||
|
--cert-file-source /path/to/cert.pem \
|
||||||
|
--key-file-source /path/to/key.pem \
|
||||||
|
--verify-incoming \
|
||||||
|
--verify-outgoing
|
||||||
|
|
||||||
|
# configure as client and try joining existing cluster
|
||||||
|
__consul_agent \
|
||||||
|
--datacenter dc1 \
|
||||||
|
--node-name "${hostname%%.*}" \
|
||||||
|
--disable-update-check \
|
||||||
|
--retry-join consul-01 \
|
||||||
|
--retry-join consul-02 \
|
||||||
|
--retry-join consul-03</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/options.html" target="_top">http://www.consul.io/docs/agent/options.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
45
software/cdist/man/4.0.0/man7/cdist-type__consul_check.html
Normal file
45
software/cdist/man/4.0.0/man7/cdist-type__consul_check.html
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_check(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_check(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__consul_check(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_check - manages consul checks</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy check definitions for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/checks.html" target="_top">http://www.consul.io/docs/agent/checks.html</a> for parameter documentation.</p><p>Use either script toghether with interval, or use ttl.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
interval
|
||||||
|
</span></dt><dd>
|
||||||
|
the interval in which the script given with --script should be run
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
script
|
||||||
|
</span></dt><dd>
|
||||||
|
the shell command to run every --interval
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ttl
|
||||||
|
</span></dt><dd>
|
||||||
|
how long a check is considered healthy without being updated through the
|
||||||
|
HTTP interfave
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
id
|
||||||
|
</span></dt><dd>
|
||||||
|
Defaults to --name
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of this check. Defaults to __object_id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
notes
|
||||||
|
</span></dt><dd>
|
||||||
|
human readable description
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this check is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_check redis \
|
||||||
|
--script /usr/local/bin/check_redis.py \
|
||||||
|
--interval 10s
|
||||||
|
|
||||||
|
__consul_check some-object-id \
|
||||||
|
--id web-app \
|
||||||
|
--name "Web App Status" \
|
||||||
|
--notes "Web app does a curl internally every 10 seconds" \
|
||||||
|
--ttl 30s</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_reload(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_reload(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60535888"></a>cdist-type__consul_reload(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_reload - reload consul</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Reload consul after configuration changes.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_reload</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,50 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_service(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_service(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64230480"></a>cdist-type__consul_service(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_service - manages consul services</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy service definitions for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/services.html" target="_top">http://www.consul.io/docs/agent/services.html</a> for parameter documentation.</p><p>Use either script together with interval, or use ttl.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
check-interval
|
||||||
|
</span></dt><dd>
|
||||||
|
the interval in which the script given with --check-script should be run
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
check-script
|
||||||
|
</span></dt><dd>
|
||||||
|
the shell command to run every --check-interval
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
check-ttl
|
||||||
|
</span></dt><dd>
|
||||||
|
how long a service is considered healthy without being updated through the
|
||||||
|
HTTP interfave
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
id
|
||||||
|
</span></dt><dd>
|
||||||
|
Defaults to --name
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of this service. Defaults to __object_id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
port
|
||||||
|
</span></dt><dd>
|
||||||
|
the port at which this service can be reached
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this service is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
tag
|
||||||
|
</span></dt><dd>
|
||||||
|
a tag to add to this service. Can be specified multiple times.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_service redis \
|
||||||
|
--tag master \
|
||||||
|
--tag production \
|
||||||
|
--port 8000 \
|
||||||
|
--check-script /usr/local/bin/check_redis.py \
|
||||||
|
--check-interval 10s
|
||||||
|
|
||||||
|
__consul_service webapp \
|
||||||
|
--port 80 \
|
||||||
|
--check-ttl 10s</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
123
software/cdist/man/4.0.0/man7/cdist-type__consul_template.html
Normal file
123
software/cdist/man/4.0.0/man7/cdist-type__consul_template.html
Normal file
|
|
@ -0,0 +1,123 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_template(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_template(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64734288"></a>cdist-type__consul_template(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_template - manage the consul-template service</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Downloads and installs the consul-template binary from
|
||||||
|
<a class="ulink" href="https://github.com/hashicorp/consul-template/releases/download/" target="_top">https://github.com/hashicorp/consul-template/releases/download/</a>.
|
||||||
|
Generates a global config file and creates directory for per template config files.
|
||||||
|
Note that the consul-template binary is downloaded on the server (the machine running
|
||||||
|
cdist) and then deployed to the target host using the __file type.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
auth-username
|
||||||
|
</span></dt><dd>
|
||||||
|
specify a username for basic authentication.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
auth-password
|
||||||
|
</span></dt><dd>
|
||||||
|
specify a password for basic authentication.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
batch-size
|
||||||
|
</span></dt><dd>
|
||||||
|
the size of the batch when polling multiple dependencies.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
consul
|
||||||
|
</span></dt><dd>
|
||||||
|
the location of the Consul instance to query (may be an IP address or FQDN) with port.
|
||||||
|
Defaults to <span class="emphasis"><em>localhost:8500</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
log-level
|
||||||
|
</span></dt><dd>
|
||||||
|
The log level for output. This applies to the stdout/stderr logging as well
|
||||||
|
as syslog logging (if enabled). Valid values are "debug", "info", "warn",
|
||||||
|
and "err". The default value is "warn".
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
max-stale
|
||||||
|
</span></dt><dd>
|
||||||
|
the maximum staleness of a query. If specified, Consul will distribute work among all
|
||||||
|
servers instead of just the leader.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
retry
|
||||||
|
</span></dt><dd>
|
||||||
|
the amount of time to wait if Consul returns an error when communicating
|
||||||
|
with the API.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
either <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ssl-cert
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to an SSL client certificate to use to authenticate to the consul server.
|
||||||
|
Useful if the consul server "verify_incoming" option is set.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ssl-ca-cert
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to a CA certificate file, containing one or more CA certificates to
|
||||||
|
use to validate the certificate sent by the consul server to us. This is a
|
||||||
|
handy alternative to setting --ssl-no-verify if you are using your own CA.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
syslog-facility
|
||||||
|
</span></dt><dd>
|
||||||
|
The facility to use when sending to syslog. This requires the use of --syslog.
|
||||||
|
The default value is LOCAL0.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
the Consul API token.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
vault-address
|
||||||
|
</span></dt><dd>
|
||||||
|
the location of the Vault instance to query (may be an IP address or FQDN) with port.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
vault-token
|
||||||
|
</span></dt><dd>
|
||||||
|
the Vault API token.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
vault-ssl-cert
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to an SSL client certificate to use to authenticate to the vault server.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
vault-ssl-ca-cert
|
||||||
|
</span></dt><dd>
|
||||||
|
Path to a CA certificate file, containing one or more CA certificates to
|
||||||
|
use to validate the certificate sent by the vault server to us.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
which version of consul-template to install. See ./files/versions for a list of
|
||||||
|
supported versions. Defaults to the latest known version.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
wait
|
||||||
|
</span></dt><dd>
|
||||||
|
the minimum(:maximum) to wait before rendering a new template to disk and
|
||||||
|
triggering a command, separated by a colon (:). If the optional maximum
|
||||||
|
value is omitted, it is assumed to be 4x the required minimum value.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
ssl
|
||||||
|
</span></dt><dd>
|
||||||
|
use HTTPS while talking to Consul. Requires the Consul server to be configured to serve secure connections.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ssl-no-verify
|
||||||
|
</span></dt><dd>
|
||||||
|
ignore certificate warnings. Only used if ssl is enabled.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
syslog
|
||||||
|
</span></dt><dd>
|
||||||
|
Send log output to syslog (in addition to stdout and stderr).
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
vault-ssl
|
||||||
|
</span></dt><dd>
|
||||||
|
use HTTPS while talking to Vault. Requires the Vault server to be configured to serve secure connections.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
vault-ssl-no-verify
|
||||||
|
</span></dt><dd>
|
||||||
|
ignore certificate warnings. Only used if vault is enabled.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen">__consul_template \
|
||||||
|
--consul consul.service.consul:8500 \
|
||||||
|
--retry 30s
|
||||||
|
|
||||||
|
# specific version
|
||||||
|
__consul_template \
|
||||||
|
--version 0.6.5 \
|
||||||
|
--retry 30s</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="https://github.com/hashicorp/consul-template" target="_top">https://github.com/hashicorp/consul-template</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,46 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_template_template(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_template_template(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681552"></a>cdist-type__consul_template_template(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_template_template - manage consul-template templates</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy template definitions for a consul-template.
|
||||||
|
See <a class="ulink" href="https://github.com/hashicorp/consul-template#examples" target="_top">https://github.com/hashicorp/consul-template#examples</a> for documentation.
|
||||||
|
Templates are written in the Go template format.
|
||||||
|
Either the --source or the --source-file parameter must be given.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
destination
|
||||||
|
</span></dt><dd>
|
||||||
|
the destination where the generated file should go.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
command
|
||||||
|
</span></dt><dd>
|
||||||
|
an optional command to run after rendering the template to its destination.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
path to the template source. Conflicts --source-file.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
source-file
|
||||||
|
</span></dt><dd>
|
||||||
|
path to a local file which is uploaded using the __file type and configured
|
||||||
|
as the source.
|
||||||
|
If source is <span class="emphasis"><em>-</em></span> (dash), take what was written to stdin as the file content.
|
||||||
|
Conflicts --source.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this template is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># configure template on the target
|
||||||
|
__consul_template_template nginx \
|
||||||
|
--source /etc/my-consul-templates/nginx.ctmpl \
|
||||||
|
--destination /etc/nginx/nginx.conf \
|
||||||
|
--command 'service nginx restart'
|
||||||
|
|
||||||
|
|
||||||
|
# upload a local file to the target and configure it
|
||||||
|
__consul_template_template nginx \
|
||||||
|
--source-file "$__manifest/files/nginx.ctmpl" \
|
||||||
|
--destination /etc/nginx/nginx.conf \
|
||||||
|
--command 'service nginx restart'</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_template.html">cdist-type__consul_template(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_template_config.html">cdist-type__consul_template_config(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_checks(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_checks(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685648"></a>cdist-type__consul_watch_checks(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_checks - manages consul checks watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>checks</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
filter-service
|
||||||
|
</span></dt><dd>
|
||||||
|
filter to a specific service. Conflicts with --filter-state.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
filter-state
|
||||||
|
</span></dt><dd>
|
||||||
|
filter to a specific state. Conflicts with --filter-service.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_checks some-id \
|
||||||
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
|
__consul_watch_checks some-id \
|
||||||
|
--filter-service consul \
|
||||||
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
|
__consul_watch_checks some-id \
|
||||||
|
--filter-state passing \
|
||||||
|
--handler /usr/bin/my-handler.sh</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_event(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_event(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742992"></a>cdist-type__consul_watch_event(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_event - manages consul event watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>event</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
restrict the watch to only events with the given name
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_event some-id \
|
||||||
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
|
__consul_watch_event some-id \
|
||||||
|
--name web-deploy \
|
||||||
|
--handler /usr/bin/my-handler.sh</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_key(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_key(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681168"></a>cdist-type__consul_watch_key(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_key - manages consul key watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>key</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
key
|
||||||
|
</span></dt><dd>
|
||||||
|
the key to watch for changes
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_key some-id \
|
||||||
|
--key foo/bar/baz \
|
||||||
|
--handler /usr/bin/my-key-handler.sh</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,32 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_keyprefix(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_keyprefix(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685648"></a>cdist-type__consul_watch_keyprefix(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_keyprefix - manages consul keyprefix watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>keyprefix</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
prefix
|
||||||
|
</span></dt><dd>
|
||||||
|
the prefix of keys to watch for changes
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_keyprefix some-id \
|
||||||
|
--prefix foo/ \
|
||||||
|
--handler /usr/bin/my-prefix-handler.sh</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_nodes(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_nodes(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64677456"></a>cdist-type__consul_watch_nodes(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_nodes - manages consul nodes watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>nodes</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_nodes some-id \
|
||||||
|
--handler /usr/bin/my-key-handler.sh</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_service(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_service(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp63919696"></a>cdist-type__consul_watch_service(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_service - manages consul service watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>service</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
service
|
||||||
|
</span></dt><dd>
|
||||||
|
the service to watch for changes
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
tag
|
||||||
|
</span></dt><dd>
|
||||||
|
filter by tag
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
passingonly
|
||||||
|
</span></dt><dd>
|
||||||
|
specifies if only hosts passing all checks are displayed
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_service some-id \
|
||||||
|
--service consul \
|
||||||
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
|
__consul_watch_service some-id \
|
||||||
|
--service redis \
|
||||||
|
--tag production \
|
||||||
|
--handler /usr/bin/my-handler.sh
|
||||||
|
|
||||||
|
__consul_watch_service some-id \
|
||||||
|
--service redis \
|
||||||
|
--tag production \
|
||||||
|
--passingonly \
|
||||||
|
--handler /usr/bin/my-handler.sh</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__consul_watch_services(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__consul_watch_services(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742992"></a>cdist-type__consul_watch_services(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__consul_watch_services - manages consul services watches</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Generate and deploy watch definitions of type <span class="emphasis"><em>services</em></span> for a consul agent.
|
||||||
|
See <a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a> for parameter documentation.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
handler
|
||||||
|
</span></dt><dd>
|
||||||
|
the handler to invoke when the data view updates
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
datacenter
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default datacenter
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if this watch is <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>. Defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
token
|
||||||
|
</span></dt><dd>
|
||||||
|
can be provided to override the agent’s default ACL token
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__consul_watch_services some-id \
|
||||||
|
--handler /usr/bin/my-key-handler.sh</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__consul_agent.html">cdist-type__consul_agent(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.consul.io/docs/agent/watches.html" target="_top">http://www.consul.io/docs/agent/watches.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
66
software/cdist/man/4.0.0/man7/cdist-type__cron.html
Normal file
66
software/cdist/man/4.0.0/man7/cdist-type__cron.html
Normal file
|
|
@ -0,0 +1,66 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__cron(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__cron(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-type__cron(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__cron - installs and manages cron jobs</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to manage entries in a users crontab.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
user
|
||||||
|
</span></dt><dd>
|
||||||
|
The user who’s crontab is edited
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
command
|
||||||
|
</span></dt><dd>
|
||||||
|
The command to run.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either present or absent. Defaults to present.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
minute
|
||||||
|
</span></dt><dd>
|
||||||
|
See crontab(5). Defaults to *
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
hour
|
||||||
|
</span></dt><dd>
|
||||||
|
See crontab(5). Defaults to *
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
day_of_month
|
||||||
|
</span></dt><dd>
|
||||||
|
See crontab(5). Defaults to *
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
month
|
||||||
|
</span></dt><dd>
|
||||||
|
See crontab(5). Defaults to *
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
day_of_week
|
||||||
|
</span></dt><dd>
|
||||||
|
See crontab(5). Defaults to *
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
raw
|
||||||
|
</span></dt><dd>
|
||||||
|
Take whatever the user has given instead of time and date fields.
|
||||||
|
If given, all other time and date fields are ignored.
|
||||||
|
Can for example be used to specify cron EXTENSIONS like reboot, yearly etc.
|
||||||
|
See crontab(5) for the extensions if any that your cron implementation
|
||||||
|
implements.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
raw_command
|
||||||
|
</span></dt><dd>
|
||||||
|
Take whatever the user has given in the commmand and ignore everything else.
|
||||||
|
If given, the command will be added to crontab.
|
||||||
|
Can for example be used to define variables like SHELL or MAILTO.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># run Monday to Saturday at 23:15
|
||||||
|
__cron some-id --user root --command "/path/to/script" \
|
||||||
|
--hour 23 --minute 15 --day_of_week 1-6
|
||||||
|
|
||||||
|
# run on reboot
|
||||||
|
__cron some-id --user root --command "/path/to/script" \
|
||||||
|
--raw @reboot
|
||||||
|
|
||||||
|
# remove cronjob
|
||||||
|
__cron some-id --user root --command "/path/to/script" --state absent
|
||||||
|
|
||||||
|
# define default shell
|
||||||
|
__cron some-id --user root --raw_command --command "SHELL=/bin/bash" \
|
||||||
|
--state present</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
crontab(5)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2013 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__debconf_set_selections(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__debconf_set_selections(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60515920"></a>cdist-type__debconf_set_selections(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__debconf_set_selections - Setup debconf selections</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>On Debian and alike systems debconf-set-selections(1) can be used
|
||||||
|
to setup configuration parameters.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd>
|
||||||
|
Use the given filename as input for <a href="../man1/debconf-set-selections.html">debconf-set-selections(1)</a>
|
||||||
|
If filename is "-", read from stdin.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Setup configuration for nslcd
|
||||||
|
__debconf_set_selections nslcd --file /path/to/file
|
||||||
|
|
||||||
|
# Setup configuration for nslcd from another type
|
||||||
|
__debconf_set_selections nslcd --file "$__type/files/preseed/nslcd"
|
||||||
|
|
||||||
|
__debconf_set_selections nslcd --file - << eof
|
||||||
|
gitolite gitolite/gituser string git
|
||||||
|
eof</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__update_alternatives.html">cdist-type__update_alternatives(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/debconf-set-selections.html">debconf-set-selections(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2011-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
76
software/cdist/man/4.0.0/man7/cdist-type__directory.html
Normal file
76
software/cdist/man/4.0.0/man7/cdist-type__directory.html
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__directory(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__directory(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__directory(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">6. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__directory - Manage a directory</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create or remove directories on the target.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
Group to chgrp to.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
mode
|
||||||
|
</span></dt><dd>
|
||||||
|
Unix permissions, suitable for chmod.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
User to chown to.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
parents
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Whether to create parents as well (mkdir -p behaviour).
|
||||||
|
Warning: all intermediate directory permissions default
|
||||||
|
to whatever mkdir -p does.
|
||||||
|
</p><pre class="literallayout">Usually this means root:root, 0700.</pre></dd><dt><span class="term">
|
||||||
|
recursive
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied the chgrp and chown call will run recursively.
|
||||||
|
This does <span class="strong"><strong>not</strong></span> influence the behaviour of chmod.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>6. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
chgrp <group>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed group membership
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
chown <owner>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed owner
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
chmod <mode>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed mode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
create
|
||||||
|
</span></dt><dd>
|
||||||
|
Empty directory was created
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remove
|
||||||
|
</span></dt><dd>
|
||||||
|
Directory exists, but state is absent, directory will be removed by generated code.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remove non directory
|
||||||
|
</span></dt><dd>
|
||||||
|
Someting other than a directory with the same name exists and was removed prior to create.
|
||||||
|
</dd></dl></div></div><div class="section" title="7. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><pre class="screen"># A silly example
|
||||||
|
__directory /tmp/foobar
|
||||||
|
|
||||||
|
# Remove a directory
|
||||||
|
__directory /tmp/foobar --state absent
|
||||||
|
|
||||||
|
# Ensure /etc exists correctly
|
||||||
|
__directory /etc --owner root --group root --mode 0755
|
||||||
|
|
||||||
|
# Create nfs service directory, including parents
|
||||||
|
__directory /home/services/nfs --parents
|
||||||
|
|
||||||
|
# Change permissions recursively
|
||||||
|
__directory /home/services --recursive --owner root --group root
|
||||||
|
|
||||||
|
# Setup a temp directory
|
||||||
|
__directory /local --mode 1777
|
||||||
|
|
||||||
|
# Take it all
|
||||||
|
__directory /home/services/kvm --recursive --parents \
|
||||||
|
--owner root --group root --mode 0755 --state present</pre></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2011 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
28
software/cdist/man/4.0.0/man7/cdist-type__dog_vdi.html
Normal file
28
software/cdist/man/4.0.0/man7/cdist-type__dog_vdi.html
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__dog_vdi(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__dog_vdi(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__dog_vdi(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__dog_vdi - Manage Sheepdog VM images</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>The dog program is used to create images for sheepdog
|
||||||
|
to be used in qemu.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
size
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Size of the image in "dog vdi" compatible units.
|
||||||
|
</p><pre class="literallayout">Required if state is "present".</pre></dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Create a 50G size image
|
||||||
|
__dog_vdi nico-privat.sky.ungleich.ch --size 50G
|
||||||
|
|
||||||
|
# Create a 50G size image (more explicit)
|
||||||
|
__dog_vdi nico-privat.sky.ungleich.ch --size 50G --state present
|
||||||
|
|
||||||
|
# Remove image
|
||||||
|
__dog_vdi nico-privat.sky.ungleich.ch --state absent
|
||||||
|
|
||||||
|
# Remove image - keeping --size is ok
|
||||||
|
__dog_vdi nico-privat.sky.ungleich.ch --size 50G --state absent</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
dog(8)
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/qemu.html">qemu(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
84
software/cdist/man/4.0.0/man7/cdist-type__file.html
Normal file
84
software/cdist/man/4.0.0/man7/cdist-type__file.html
Normal file
|
|
@ -0,0 +1,84 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__file(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__file(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__file(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">5. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__file - Manage files</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create files, remove files and set file
|
||||||
|
attributes on the target.</p><p>If the file already exists on the target, then if it is a:
|
||||||
|
- regular file, and state is:
|
||||||
|
present: replace it with the source file if they are not equal
|
||||||
|
exists: do nothing
|
||||||
|
- symlink: replace it with the source file
|
||||||
|
- directory: replace it with the source file</p><p>In any case, make sure that the file attributes are as specified.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span>, <span class="emphasis"><em>absent</em></span> or <span class="emphasis"><em>exists</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
where:
|
||||||
|
present: the file is exactly the one from source
|
||||||
|
absent: the file does not exist
|
||||||
|
exists: the file from source but only if it doesn’t already exist
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
Group to chgrp to.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
mode
|
||||||
|
</span></dt><dd>
|
||||||
|
Unix permissions, suitable for chmod.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
User to chown to.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, copy this file from the host running cdist to the target.
|
||||||
|
If not supplied, an empty file or directory will be created.
|
||||||
|
If source is <span class="emphasis"><em>-</em></span> (dash), take what was written to stdin as the file content.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>5. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
chgrp <group>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed group membership
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
chown <owner>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed owner
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
chmod <mode>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed mode
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
create
|
||||||
|
</span></dt><dd>
|
||||||
|
Empty file was created (no --source specified)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remove
|
||||||
|
</span></dt><dd>
|
||||||
|
File exists, but state is absent, file will be removed by generated code.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
upload
|
||||||
|
</span></dt><dd>
|
||||||
|
File was uploaded
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen"># Create /etc/cdist-configured as an empty file
|
||||||
|
__file /etc/cdist-configured
|
||||||
|
# The same thing
|
||||||
|
__file /etc/cdist-configured --state present
|
||||||
|
# Delete existing file
|
||||||
|
__file /etc/cdist-configured --state absent
|
||||||
|
|
||||||
|
# Use __file from another type
|
||||||
|
__file /etc/issue --source "$__type/files/archlinux" --state present
|
||||||
|
|
||||||
|
# Supply some more settings
|
||||||
|
__file /etc/shadow --source "$__type/files/shadow" \
|
||||||
|
--owner root --group shadow --mode 0640 \
|
||||||
|
--state present
|
||||||
|
|
||||||
|
# Provide a default file, but let the user change it
|
||||||
|
__file /home/frodo/.bashrc --source "/etc/skel/.bashrc" \
|
||||||
|
--state exists \
|
||||||
|
--owner frodo --mode 0600
|
||||||
|
|
||||||
|
# Take file content from stdin
|
||||||
|
__file /tmp/whatever --owner root --group root --mode 644 --source - << DONE
|
||||||
|
Here goes the content for /tmp/whatever
|
||||||
|
DONE</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2011-2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,57 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__firewalld_rule(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__firewalld_rule(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-type__firewalld_rule(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__firewalld_rule - Configure firewalld rules</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to manage rules in firewalld
|
||||||
|
using the <span class="strong"><strong>direct</strong></span> way (i.e. no zone support).</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
rule
|
||||||
|
</span></dt><dd>
|
||||||
|
The rule to apply. Essentially an firewalld command
|
||||||
|
line without firewalld in front of it.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
protocol
|
||||||
|
</span></dt><dd>
|
||||||
|
Either ipv4, ipv4 or eb. See <a href="../man1/firewall-cmd.html">firewall-cmd(1)</a>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
table
|
||||||
|
</span></dt><dd>
|
||||||
|
The table to use (like filter or nat). See <a href="../man1/firewall-cmd.html">firewall-cmd(1)</a>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
chain
|
||||||
|
</span></dt><dd>
|
||||||
|
The chain to use (like INPUT_direct or FORWARD_direct). See <a href="../man1/firewall-cmd.html">firewall-cmd(1)</a>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
priority
|
||||||
|
</span></dt><dd>
|
||||||
|
The priority to use (0 is topmost). See <a href="../man1/firewall-cmd.html">firewall-cmd(1)</a>.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Allow acces from entrance.place4.ungleich.ch
|
||||||
|
__firewalld_rule entrance \
|
||||||
|
--protocol ipv4 \
|
||||||
|
--table filter \
|
||||||
|
--chain INPUT_direct \
|
||||||
|
--priority 0 \
|
||||||
|
--rule '-s entrance.place4.ungleich.ch -j ACCEPT'
|
||||||
|
|
||||||
|
# Allow forwarding of traffic from br0
|
||||||
|
__firewalld_rule vm-forward --protocol ipv4 \
|
||||||
|
--table filter \
|
||||||
|
--chain FORWARD_direct \
|
||||||
|
--priority 0 \
|
||||||
|
--rule '-i br0 -j ACCEPT'
|
||||||
|
|
||||||
|
# Ensure old rule is absent - warning, the rule part must stay the same!
|
||||||
|
__firewalld_rule vm-forward
|
||||||
|
--protocol ipv4 \
|
||||||
|
--table filter \
|
||||||
|
--chain FORWARD_direct \
|
||||||
|
--priority 0 \
|
||||||
|
--rule '-i br0 -j ACCEPT' \
|
||||||
|
--state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__iptables_rule.html">cdist-type__iptables_rule(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
firewalld(8)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
33
software/cdist/man/4.0.0/man7/cdist-type__git.html
Normal file
33
software/cdist/man/4.0.0/man7/cdist-type__git.html
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__git(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__git(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685136"></a>cdist-type__git(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__git - Get and or keep git repositories up-to-date</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to clone git repositories</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
Specifies the git remote to clone from
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
branch
|
||||||
|
</span></dt><dd>
|
||||||
|
Create this branch by checking out the remote branch of this name
|
||||||
|
Default branch is "master"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
Group to chgrp to.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
mode
|
||||||
|
</span></dt><dd>
|
||||||
|
Unix permissions, suitable for chmod.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
User to chown to.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__git /home/services/dokuwiki --source git://github.com/splitbrain/dokuwiki.git
|
||||||
|
|
||||||
|
# Checkout cdist, stay on branch 2.1
|
||||||
|
__git /home/nico/cdist --source git://github.com/telmich/cdist.git --branch 2.1</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
54
software/cdist/man/4.0.0/man7/cdist-type__group.html
Normal file
54
software/cdist/man/4.0.0/man7/cdist-type__group.html
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__group(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__group(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__group(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">6. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__group - Manage groups</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create or modify groups on the target.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
absent or present, defaults to present
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
gid
|
||||||
|
</span></dt><dd>
|
||||||
|
see groupmod(8)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
password
|
||||||
|
</span></dt><dd>
|
||||||
|
see above
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
system
|
||||||
|
</span></dt><dd>
|
||||||
|
see groupadd(8), apply only on group creation
|
||||||
|
</dd></dl></div></div><div class="section" title="6. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>6. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
mod
|
||||||
|
</span></dt><dd>
|
||||||
|
group is modified
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
add
|
||||||
|
</span></dt><dd>
|
||||||
|
New group added
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remove
|
||||||
|
</span></dt><dd>
|
||||||
|
group is removed
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
change <property> <new_value> <current_value>
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed group property from current_value to new_value
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
set <property> <new_value>
|
||||||
|
</span></dt><dd>
|
||||||
|
set property to new value, property was not set bevore
|
||||||
|
</dd></dl></div></div><div class="section" title="7. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><pre class="screen"># Create a group 'foobar' with operating system default settings
|
||||||
|
__group foobar
|
||||||
|
|
||||||
|
# Remove the 'foobar' group
|
||||||
|
__group foobar --state absent
|
||||||
|
|
||||||
|
# Create a system group 'myservice' with operating system default settings
|
||||||
|
__group myservice --system
|
||||||
|
|
||||||
|
# Same but with a specific gid
|
||||||
|
__group foobar --gid 1234
|
||||||
|
|
||||||
|
# Same but with a gid and password
|
||||||
|
__group foobar --gid 1234 --password 'crypted-password-string'</pre></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2011-2015 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
18
software/cdist/man/4.0.0/man7/cdist-type__hostname.html
Normal file
18
software/cdist/man/4.0.0/man7/cdist-type__hostname.html
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__hostname(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__hostname(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__hostname(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">5. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__hostname - set the hostname</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Set’s the hostname on various operating systems.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
The hostname to set. Defaults to the first segment of <span class="emphasis"><em>target_host
|
||||||
|
(${</em></span>target_host%%.*})
|
||||||
|
</dd></dl></div></div><div class="section" title="5. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>5. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
changed
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed the hostname
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen"># take hostname from __target_host
|
||||||
|
__hostname
|
||||||
|
|
||||||
|
# set hostname explicitly
|
||||||
|
__hostname --name some-static-hostname</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2012 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,11 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__iptables_apply(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__iptables_apply(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__iptables_apply(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__iptables_apply - Apply the rules</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type deploys an init script that triggers
|
||||||
|
the configured rules and also re-applies them on
|
||||||
|
configuration.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><p>None (<span class="emphasis"><em>iptables_apply is used by </em></span>iptables_rule)</p></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__iptables_rule.html">cdist-type__iptables_rule(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
iptables(8)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
34
software/cdist/man/4.0.0/man7/cdist-type__iptables_rule.html
Normal file
34
software/cdist/man/4.0.0/man7/cdist-type__iptables_rule.html
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__iptables_rule(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__iptables_rule(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__iptables_rule(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__iptables_rule - Deploy iptable rulesets</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to manage iptable rules
|
||||||
|
in a distribution independent manner.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
rule
|
||||||
|
</span></dt><dd>
|
||||||
|
The rule to apply. Essentially an iptables command
|
||||||
|
line without iptables in front of it.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Deploy some policies
|
||||||
|
__iptables_rule policy-in --rule "-P INPUT DROP"
|
||||||
|
__iptables_rule policy-out --rule "-P OUTPUT ACCEPT"
|
||||||
|
__iptables_rule policy-fwd --rule "-P FORWARD DROP"
|
||||||
|
|
||||||
|
# The usual established rule
|
||||||
|
__iptables_rule established --rule "-A INPUT -m state --state RELATED,ESTABLISHED -j ACCEPT"
|
||||||
|
|
||||||
|
# Some service rules
|
||||||
|
__iptables_rule http --rule "-A INPUT -p tcp --dport 80 -j ACCEPT"
|
||||||
|
__iptables_rule ssh --rule "-A INPUT -p tcp --dport 22 -j ACCEPT"
|
||||||
|
__iptables_rule https --rule "-A INPUT -p tcp --dport 443 -j ACCEPT"
|
||||||
|
|
||||||
|
# Ensure some rules are not present anymore
|
||||||
|
__iptables_rule munin --rule "-A INPUT -p tcp --dport 4949 -j ACCEPT" \
|
||||||
|
--state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__iptables_apply.html">cdist-type__iptables_apply(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
iptables(8)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
12
software/cdist/man/4.0.0/man7/cdist-type__issue.html
Normal file
12
software/cdist/man/4.0.0/man7/cdist-type__issue.html
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__issue(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__issue(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__issue(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__issue - Manage issue</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to easily setup /etc/issue.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use this file as /etc/issue instead of default.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__issue
|
||||||
|
|
||||||
|
# When called from another type
|
||||||
|
__issue --source "$__type/files/myfancyissue"</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
96
software/cdist/man/4.0.0/man7/cdist-type__jail.html
Normal file
96
software/cdist/man/4.0.0/man7/cdist-type__jail.html
Normal file
|
|
@ -0,0 +1,96 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__jail(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__jail(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__jail(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email"><<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_caveats">6. CAVEATS</a></span></dt><dt><span class="section"><a href="#_messages">7. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">8. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">9. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">10. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__jail - Manage FreeBSD jails</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is used on FreeBSD to manage jails.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
jailbase
|
||||||
|
</span></dt><dd>
|
||||||
|
The location of the .tgz archive containing the base fs for your jails.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of the jail. Default is to use the object_id as the jail name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ip
|
||||||
|
</span></dt><dd>
|
||||||
|
The ifconfig style IP/netmask combination to use for the jail guest. If
|
||||||
|
the state parameter is "present," this parameter is required.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
hostname
|
||||||
|
</span></dt><dd>
|
||||||
|
The FQDN to use for the jail guest. Defaults to the name parameter.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
interface
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of the physical interface on the jail server to bind the jail to.
|
||||||
|
Defaults to the first interface found in the output of ifconfig -l.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
devfs-ruleset
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of the devfs ruleset to associate with the jail. Defaults to
|
||||||
|
"jailrules." This ruleset must be copied to the server via another type.
|
||||||
|
To use this option, devfs-enable must be "true."
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
jaildir
|
||||||
|
</span></dt><dd>
|
||||||
|
The location on the remote server to use for hosting jail filesystems.
|
||||||
|
Defaults to /usr/jail.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
stopped
|
||||||
|
</span></dt><dd>
|
||||||
|
Do not start the jail
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
devfs-disable
|
||||||
|
</span></dt><dd>
|
||||||
|
Whether to disallow devfs mounting within the jail
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
onboot
|
||||||
|
</span></dt><dd>
|
||||||
|
Whether to add the jail to rc.conf’s jail_list variable.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. CAVEATS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_caveats"></a>6. CAVEATS</h2></div></div></div><p>This type does not currently support modification of jail options. If, for
|
||||||
|
example a jail needs to have its IP address or netmask changed, the jail must
|
||||||
|
be removed then re-added with the correct IP address/netmask or the appropriate
|
||||||
|
line (jail_<name>_ip="…") modified within rc.conf through some alternate
|
||||||
|
means.</p></div><div class="section" title="7. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>7. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
start
|
||||||
|
</span></dt><dd>
|
||||||
|
The jail was started
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
stop
|
||||||
|
</span></dt><dd>
|
||||||
|
The jail was stopped
|
||||||
|
create:
|
||||||
|
The jail was created
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
delete
|
||||||
|
</span></dt><dd>
|
||||||
|
The jail was deleted
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
onboot
|
||||||
|
</span></dt><dd>
|
||||||
|
The jail was configured to start on boot
|
||||||
|
</dd></dl></div></div><div class="section" title="8. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>8. EXAMPLES</h2></div></div></div><pre class="screen"># Create a jail called www
|
||||||
|
__jail www --state present --ip "192.168.1.2" --jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
|
# Remove the jail called www
|
||||||
|
__jail www --state absent --jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
|
# The jail www should not be started
|
||||||
|
__jail www --state present --stopped \
|
||||||
|
--ip "192.168.1.2 netmask 255.255.255.0" \
|
||||||
|
--jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
|
# Use the name variable explicitly
|
||||||
|
__jail thisjail --state present --name www \
|
||||||
|
--ip "192.168.1.2" \
|
||||||
|
--jailbase /my/jail/base.tgz
|
||||||
|
|
||||||
|
# Go nuts
|
||||||
|
__jail lotsofoptions --state present --name testjail \
|
||||||
|
--ip "192.168.1.100 netmask 255.255.255.0" \
|
||||||
|
--hostname "testjail.example.com" --interface "em0" \
|
||||||
|
--onboot --jailbase /my/jail/base.tgz --jaildir /jails</pre></div><div class="section" title="9. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>9. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="10. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>10. COPYING</h2></div></div></div><p>Copyright (C) 2012 Jake Guffey. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
68
software/cdist/man/4.0.0/man7/cdist-type__key_value.html
Normal file
68
software/cdist/man/4.0.0/man7/cdist-type__key_value.html
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__key_value(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__key_value(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__key_value(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">6. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_more_information">8. MORE INFORMATION</a></span></dt><dt><span class="section"><a href="#_see_also">9. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">10. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__key_value - Change property values in files</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to change values in a key value based config
|
||||||
|
file.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd>
|
||||||
|
The file to operate on.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
delimiter
|
||||||
|
</span></dt><dd>
|
||||||
|
The delimiter which seperates the key from the value.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
present or absent, defaults to present. If present, sets the key to value,
|
||||||
|
if absent, removes the key from the file.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
key
|
||||||
|
</span></dt><dd>
|
||||||
|
The key to change. Defaults to object_id.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
value
|
||||||
|
</span></dt><dd>
|
||||||
|
The value for the key. Optional if state=absent, required otherwise.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
comment
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, the value will be inserted before the line with the key,
|
||||||
|
but only if the key or value must be changed.
|
||||||
|
You need to ensure yourself that the line is prefixed with the correct
|
||||||
|
comment sign. (for example # or ; or wathever ..)
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
exact_delimiter
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, treat additional whitespaces between key, delimiter and value
|
||||||
|
as wrong value.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>6. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
remove
|
||||||
|
</span></dt><dd>
|
||||||
|
Removed existing key and value
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
insert
|
||||||
|
</span></dt><dd>
|
||||||
|
Added key and value
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
change
|
||||||
|
</span></dt><dd>
|
||||||
|
Changed value of existing key
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
create
|
||||||
|
</span></dt><dd>
|
||||||
|
A new line was inserted in a new file
|
||||||
|
</dd></dl></div></div><div class="section" title="7. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><pre class="screen"># Set the maximum system user id
|
||||||
|
__key_value SYS_UID_MAX --file /etc/login.defs --value 666 --delimiter ' '
|
||||||
|
|
||||||
|
# Same with fancy id
|
||||||
|
__key_value my-fancy-id --file /etc/login.defs --key SYS_UID_MAX --value 666 \
|
||||||
|
--delimiter ' '
|
||||||
|
|
||||||
|
# Enable packet forwarding
|
||||||
|
__key_value net.ipv4.ip_forward --file /etc/sysctl.conf --value 1 \
|
||||||
|
--delimiter ' = ' --comment '# my linux kernel should act as a router'
|
||||||
|
|
||||||
|
# Remove existing key/value
|
||||||
|
__key_value LEGACY_KEY --file /etc/somefile --state absent --delimiter '='</pre></div><div class="section" title="8. MORE INFORMATION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_more_information"></a>8. MORE INFORMATION</h2></div></div></div><p>This type try to handle as many values as possible, so it doesn’t use regexes.
|
||||||
|
So you need to exactly specify the key and delimiter. Delimiter can be of any lenght.</p></div><div class="section" title="9. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>9. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="10. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>10. COPYING</h2></div></div></div><p>Copyright (C) 2011 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
37
software/cdist/man/4.0.0/man7/cdist-type__line.html
Normal file
37
software/cdist/man/4.0.0/man7/cdist-type__line.html
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__line(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__line(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__line(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__line - Manage lines in files</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to add lines and remove lines from files.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
line
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Specifies the line which should be absent or present
|
||||||
|
</p><pre class="literallayout">Must be present, if state is present.
|
||||||
|
Must not be combined with regex, if state is absent.</pre></dd><dt><span class="term">
|
||||||
|
regex
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
If state is present, search for this pattern and add
|
||||||
|
given line, if the given regular expression does not match.
|
||||||
|
</p><pre class="literallayout">In case of absent, ensure all lines matching the
|
||||||
|
regular expression are absent.</pre><pre class="literallayout">The regular expression is interpreted by grep.</pre><pre class="literallayout">Must not be combined with line, if state is absent.</pre></dd><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use this as the destination file.
|
||||||
|
Otherwise the object_id is used.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Manage the DAEMONS line in rc.conf
|
||||||
|
__line daemons --file /etc/rc.conf --line 'DAEMONS=(hwclock !network sshd crond postfix)'
|
||||||
|
|
||||||
|
# Ensure the home mount is present in /etc/fstab - explicitly make it present
|
||||||
|
__line home-fstab \
|
||||||
|
--file /etc/fstab \
|
||||||
|
--line 'filer.fs:/vol/home /home nfs defaults 0 0' \
|
||||||
|
--state present
|
||||||
|
|
||||||
|
# Removes the line specifiend in "include_www" from the file "lighttpd.conf"
|
||||||
|
__line legacy_timezone --file /etc/rc.conf --regex 'TIMEZONE=.*' --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/grep.html">grep(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012-2013 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
30
software/cdist/man/4.0.0/man7/cdist-type__link.html
Normal file
30
software/cdist/man/4.0.0/man7/cdist-type__link.html
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__link(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__link(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60535888"></a>cdist-type__link(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__link - Manage links (hard and symbolic)</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to manage hard and symbolic links.
|
||||||
|
The given object id is the destination for the link.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
Specifies the link source.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
type
|
||||||
|
</span></dt><dd>
|
||||||
|
Specifies the link type: Either hard or symoblic.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Create hard link of /etc/shadow
|
||||||
|
__link /root/shadow --source /etc/shadow --type hard
|
||||||
|
|
||||||
|
# Relative symbolic link
|
||||||
|
__link /etc/apache2/sites-enabled/www.test.ch \
|
||||||
|
--source ../sites-available/www.test.ch \
|
||||||
|
--type symbolic
|
||||||
|
|
||||||
|
# Absolute symbolic link
|
||||||
|
__link /opt/plone --source /home/services/plone --type symbolic
|
||||||
|
|
||||||
|
# Remove link
|
||||||
|
__link /opt/plone --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
20
software/cdist/man/4.0.0/man7/cdist-type__locale.html
Normal file
20
software/cdist/man/4.0.0/man7/cdist-type__locale.html
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__locale(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__locale(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__locale(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__locale - Configure locales</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to setup locales.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to present
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Add locale de_CH.UTF-8
|
||||||
|
__locale de_CH.UTF-8
|
||||||
|
|
||||||
|
# Same as above, but more explicit
|
||||||
|
__locale de_CH.UTF-8 --state present
|
||||||
|
|
||||||
|
# Remove colourful British English
|
||||||
|
__locale en_GB.UTF-8 --state absent</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man1/locale.html">locale(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/localedef.html">localedef(1)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2013-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
14
software/cdist/man/4.0.0/man7/cdist-type__motd.html
Normal file
14
software/cdist/man/4.0.0/man7/cdist-type__motd.html
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__motd(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__motd(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__motd(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__motd - Manage message of the day</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to easily setup /etc/motd.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, copy this file from the host running cdist to the target.
|
||||||
|
If not supplied, a default message will be placed onto the target.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Use cdist defaults
|
||||||
|
__motd
|
||||||
|
|
||||||
|
# Supply source file from a different type
|
||||||
|
__motd --source "$__type/files/my-motd"</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
50
software/cdist/man/4.0.0/man7/cdist-type__mount.html
Normal file
50
software/cdist/man/4.0.0/man7/cdist-type__mount.html
Normal file
|
|
@ -0,0 +1,50 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__mount(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__mount(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__mount(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__mount - manage filesystem mounts</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Manage filesystem mounts either via /etc/fstab or manually.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
device
|
||||||
|
</span></dt><dd>
|
||||||
|
device to mount at path, defaults to <span class="emphasis"><em>none</em></span>. see mount(8)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
dump
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
value for the dump field in fstab. see fstab(5)
|
||||||
|
defaults to 0.
|
||||||
|
</p><pre class="literallayout">This parameter is ignored, if the nofstab parameter is given.</pre></dd><dt><span class="term">
|
||||||
|
options
|
||||||
|
</span></dt><dd>
|
||||||
|
comma separated string of options, see mount(8)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
pass
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
value for the pass field in fstab. see fstab(5)
|
||||||
|
defaults to 0.
|
||||||
|
</p><pre class="literallayout">This parameter is ignored, if the nofstab parameter is given.</pre></dd><dt><span class="term">
|
||||||
|
path
|
||||||
|
</span></dt><dd>
|
||||||
|
mount point where to mount the device, see mount(8).
|
||||||
|
Defaults to __object_id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
either present or absent. Defaults to present.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
type
|
||||||
|
</span></dt><dd>
|
||||||
|
vfstype, see mount(8)
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
nofstab
|
||||||
|
</span></dt><dd>
|
||||||
|
do not manage an entry in /etc/fstab
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen">__mount /some/dir \
|
||||||
|
--device /dev/sdc3 \
|
||||||
|
--type xfs \
|
||||||
|
--options "defaults,ro"
|
||||||
|
--dump 0 \
|
||||||
|
--pass 1
|
||||||
|
|
||||||
|
__mount /var/lib/one \
|
||||||
|
--device mfsmount \
|
||||||
|
--type fuse \
|
||||||
|
--options "mfsmaster=mfsmaster.domain.tld,mfssubfolder=/one,nonempty,_netdev"</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__mysql_database(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__mysql_database(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64160848"></a>cdist-type__mysql_database(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Benedikt</span> <span class="surname">Koeppel</span></h3><code class="email"><<a class="email" href="mailto:code@benediktkoeppel.ch">code@benediktkoeppel.ch</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__mysql_database - Manage a MySQL database</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to install a MySQL database.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of the database to install
|
||||||
|
defaults to the object id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
user
|
||||||
|
</span></dt><dd>
|
||||||
|
A user that should have access to the database
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
password
|
||||||
|
</span></dt><dd>
|
||||||
|
The password for the user who manages the database
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__mysql_database "cdist" --name "cdist" --user "myuser" --password "mypwd"</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Benedikt Koeppel. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
34
software/cdist/man/4.0.0/man7/cdist-type__package.html
Normal file
34
software/cdist/man/4.0.0/man7/cdist-type__package.html
Normal file
|
|
@ -0,0 +1,34 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__package(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package - Manage packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to install or uninstall packages on the target.
|
||||||
|
It dispatches the actual work to the package system dependent types.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
The name of the package to install. Default is to use the object_id as the
|
||||||
|
package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
The version of the package to install. Default is to install the version
|
||||||
|
chosen by the local package manager.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
type
|
||||||
|
</span></dt><dd>
|
||||||
|
The package type to use. Default is determined based on the $os explorer
|
||||||
|
variable.
|
||||||
|
e.g. <span class="emphasis"><em>package_apt for Debian
|
||||||
|
</em></span>package_emerge for Gentoo
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Install the package vim on the target
|
||||||
|
__package vim --state present
|
||||||
|
|
||||||
|
# Same but install specific version
|
||||||
|
__package vim --state present --version 7.3.50
|
||||||
|
|
||||||
|
# Force use of a specific package type
|
||||||
|
__package vim --state present --type __package_apt</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
28
software/cdist/man/4.0.0/man7/cdist-type__package_apt.html
Normal file
28
software/cdist/man/4.0.0/man7/cdist-type__package_apt.html
Normal file
|
|
@ -0,0 +1,28 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_apt(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_apt(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64230480"></a>cdist-type__package_apt(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_apt - Manage packages with apt-get</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>apt-get is usually used on Debian and variants (like Ubuntu) to
|
||||||
|
manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
target-release
|
||||||
|
</span></dt><dd>
|
||||||
|
Passed on to apt-get install, see apt-get(8).
|
||||||
|
Essentially allows you to retrieve packages from a different release
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh in installed
|
||||||
|
__package_apt zsh --state present
|
||||||
|
|
||||||
|
# In case you only want *a* webserver, but don't care which one
|
||||||
|
__package_apt webserver --state present --name nginx
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_apt puppet --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,31 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_emerge(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_emerge(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__package_emerge(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Thomas</span> <span class="surname">Oettli</span></h3><code class="email"><<a class="email" href="mailto:otho--@--sfs.biz">otho--@--sfs.biz</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_emerge - Manage packages with portage</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Portage is usually used on the gentoo distribution to manage packages.
|
||||||
|
This type requires app-portage/gentoolkit installed on the target host.
|
||||||
|
cdist-type__package_emerge_dependencies is supposed to install the needed
|
||||||
|
packages on the target host.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to install or uninstall a specific version of the package named.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure sys-devel/gcc is installed
|
||||||
|
__package_emerge sys-devel/gcc --state present
|
||||||
|
|
||||||
|
# If you want a specific version of a package
|
||||||
|
__package_emerge app-portage/gentoolkit --state present --version 0.3.0.8-r2
|
||||||
|
|
||||||
|
# Remove package
|
||||||
|
__package_emerge sys-devel/gcc --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package_emerge_dependencies.html">cdist-type__package_emerge_dependencies(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2013 Thomas Oettli. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_emerge_dependencies(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_emerge_dependencies(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64747088"></a>cdist-type__package_emerge_dependencies(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Thomas</span> <span class="surname">Oettli</span></h3><code class="email"><<a class="email" href="mailto:otho--@--sfs.biz">otho--@--sfs.biz</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type<span class="emphasis"><em>package_emerge_dependencies - Install dependencies for </em></span>package_emerge</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Portage is usually used on the gentoo distribution to manage packages.
|
||||||
|
This type installs the following tools which are required by __package_emerge to work:
|
||||||
|
app-portage/flaggie
|
||||||
|
app-portage/gentoolkit</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure app-portage/flaggie and app-portage/gentoolkit are installed
|
||||||
|
__package_emerge_dependencies</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package_emerge.html">cdist-type__package_emerge(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2013 Thomas Oettli. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_luarocks(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_luarocks(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60519632"></a>cdist-type__package_luarocks(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Christian</span> <span class="othername">G.</span> <span class="surname">Warden</span></h3><code class="email"><<a class="email" href="mailto:cwarden@xerus.org">cwarden@xerus.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_luarocks - Manage luarocks packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>LuaRocks is a deployment and management system for Lua modules.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure luasocket is installed
|
||||||
|
__package_luarocks luasocket --state present
|
||||||
|
|
||||||
|
# Remove package
|
||||||
|
__package_luarocks luasocket --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 SwellPath, Inc. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
19
software/cdist/man/4.0.0/man7/cdist-type__package_opkg.html
Normal file
19
software/cdist/man/4.0.0/man7/cdist-type__package_opkg.html
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_opkg(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_opkg(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__package_opkg(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Giel</span> <span class="othername">van</span> <span class="surname">Schijndel</span></h3><code class="email"><<a class="email" href="mailto:giel+cdist--@--mortis.eu">giel+cdist--@--mortis.eu</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_opkg - Manage packages with opkg</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>opkg is usually used on OpenWRT to manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure lsof is installed
|
||||||
|
__package_opkg lsof --state present
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_opkg dnsmasq --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Giel van Schijndel. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,22 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_pacman(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_pacman(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__package_pacman(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_pacman - Manage packages with pacman</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Pacman is usually used on the Archlinux distribution to manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh in installed
|
||||||
|
__package_pacman zsh --state present
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_pacman python --state present --name python2
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pacman puppet --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
31
software/cdist/man/4.0.0/man7/cdist-type__package_pip.html
Normal file
31
software/cdist/man/4.0.0/man7/cdist-type__package_pip.html
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_pip(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_pip(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__package_pip(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_pip - Manage packages with pip</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Pip is used in Python environments to install packages.
|
||||||
|
It is also included in the python virtualenv environment.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
pip
|
||||||
|
</span></dt><dd>
|
||||||
|
Instead of using pip from PATH, use the specific pip path.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
runas
|
||||||
|
</span></dt><dd>
|
||||||
|
Run pip as specified user. By default it runs as root.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Install a package
|
||||||
|
__package_pip pyro --state present
|
||||||
|
|
||||||
|
# Use pip in a virtualenv located at /root/shinken_virtualenv
|
||||||
|
__package_pip pyro --state present --pip /root/shinken_virtualenv/bin/pip
|
||||||
|
|
||||||
|
# Use pip in a virtualenv located at /foo/shinken_virtualenv as user foo
|
||||||
|
__package_pip pyro --state present --pip /foo/shinken_virtualenv/bin/pip --runas foo</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_pkg_freebsd(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_pkg_freebsd(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681552"></a>cdist-type__package_pkg_freebsd(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email"><<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_pkg_freebsd - Manage FreeBSD packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is usually used on FreeBSD to manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
flavor
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to avoid ambiguity.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to install a specific version of the package named.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
pkgsite
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to install from a specific package repository.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh is installed
|
||||||
|
__package_pkg_freebsd zsh --state present
|
||||||
|
|
||||||
|
# Ensure vim is installed, use flavor no_x11
|
||||||
|
__package_pkg_freebsd vim --state present --flavor no_x11
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_pkg_freebsd python --state present --name python2
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pkg_freebsd puppet --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Jake Guffey. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_pkg(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_pkg(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681552"></a>cdist-type__package_pkg(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Andi</span> <span class="surname">Brönnimann</span></h3><code class="email"><<a class="email" href="mailto:andi-cdist--@--v-net.ch">andi-cdist--@--v-net.ch</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_pkg_openbsd - Manage OpenBSD packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is usually used on OpenBSD to manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
flavor
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to avoid ambiguity.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
pkg_path
|
||||||
|
</span></dt><dd>
|
||||||
|
Manually specify a PKG_PATH to add packages from.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh is installed
|
||||||
|
__package_pkg_openbsd zsh --state present
|
||||||
|
|
||||||
|
# Ensure vim is installed, use flavor no_x11
|
||||||
|
__package_pkg_openbsd vim --state present --flavor no_x11
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_pkg_openbsd python --state present --name python2
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pkg_openbsd puppet --state absent
|
||||||
|
|
||||||
|
# Add a package using a particular mirror
|
||||||
|
__package_pkg_openbsd bash \
|
||||||
|
--pkg_path http://openbsd.mirrorcatalogs.com/snapshots/packages/amd64</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Andi Brönnimann. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_pkgng_freebsd(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_pkgng_freebsd(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685648"></a>cdist-type__package_pkgng_freebsd(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email"><<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_caveats">6. CAVEATS</a></span></dt><dt><span class="section"><a href="#_messages">7. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">8. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">9. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">10. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_pkgng_freebsd - Manage FreeBSD packages with pkg-ng</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is usually used on FreeBSD to manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
flavor
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to avoid ambiguity.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to install a specific version of the package named.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
repo
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to install the package named from a particular repo.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
upgrade
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, allow upgrading to the latest version of a package.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. CAVEATS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_caveats"></a>6. CAVEATS</h2></div></div></div><p>This type requires that repository definitions already exist in /etc/pkg/*.conf.
|
||||||
|
Ensure that they exist prior to use of this type with __file.</p><p>pkg-ng can’t upgrade a package to a specific version. If this type needs to
|
||||||
|
upgrade a package, it can only ugprade to the latest available version. If the
|
||||||
|
"upgrade" parameter is not given and an upgrade needs to occur, an error will result.</p></div><div class="section" title="7. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>7. MESSAGES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
install
|
||||||
|
</span></dt><dd>
|
||||||
|
The package was installed
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remove
|
||||||
|
</span></dt><dd>
|
||||||
|
The package was removed
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
upgrade
|
||||||
|
</span></dt><dd>
|
||||||
|
The package was upgraded
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
exist
|
||||||
|
</span></dt><dd>
|
||||||
|
The package was already present and thus not installed
|
||||||
|
</dd></dl></div></div><div class="section" title="8. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>8. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh is installed
|
||||||
|
__package_pkgng_freebsd zsh --state present
|
||||||
|
|
||||||
|
# Ensure vim is installed, use flavor no_x11
|
||||||
|
__package_pkgng_freebsd vim --state present --flavor no_x11
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_pkgng_freebsd python --state present --name python2
|
||||||
|
|
||||||
|
# Install a package from a particular repository when multiples exist
|
||||||
|
__package_pkgng_freebsd bash --state present --repo myrepo
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_pkgng_freebsd puppet --state absent</pre></div><div class="section" title="9. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>9. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="10. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>10. COPYING</h2></div></div></div><p>Copyright (C) 2014 Jake Guffey. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_rubygem(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_rubygem(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-type__package_rubygem(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Chase</span> <span class="othername">Allen</span> <span class="surname">James</span></h3><code class="email"><<a class="email" href="mailto:nx-cdist@nu-ex.com">nx-cdist@nu-ex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_rubygem - Manage rubygem packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Rubygems is the default package management system for the Ruby programming language.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure sinatra is installed
|
||||||
|
__package_rubygem sinatra --state present
|
||||||
|
|
||||||
|
# Remove package
|
||||||
|
__package_rubygem rails --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011 Chase Allen James. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_update_index(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_update_index(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp63919696"></a>cdist-type__package_update_index(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Ricardo</span> <span class="othername">Catalinas</span> <span class="surname">Jiménez</span></h3><code class="email"><<a class="email" href="mailto:jimenezrick--@--gmail.com">jimenezrick--@--gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_update_index - Update the package index</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to update the package index on the target.
|
||||||
|
It will automatically use the appropriate package manager.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
type
|
||||||
|
</span></dt><dd>
|
||||||
|
The package manager to use. Default is determined based on the $os
|
||||||
|
explorer variable.
|
||||||
|
e.g. apt for Debian
|
||||||
|
yum for Red Hat
|
||||||
|
pacman for Arch Linux
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Update the package index on the target
|
||||||
|
__package_update_index
|
||||||
|
|
||||||
|
# Force use of a specific package manager
|
||||||
|
__package_update_index --type apt</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2014 Ricardo Catalinas Jiménez. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_upgrade_all(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_upgrade_all(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64747088"></a>cdist-type__package_upgrade_all(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Ricardo</span> <span class="othername">Catalinas</span> <span class="surname">Jiménez</span></h3><code class="email"><<a class="email" href="mailto:jimenezrick--@--gmail.com">jimenezrick--@--gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_upgrade_all - Upgrade all the installed packages</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to upgrade all the installed packages on the
|
||||||
|
target. It will automatically use the appropriate package manager.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
type
|
||||||
|
</span></dt><dd>
|
||||||
|
The package manager to use. Default is determined based on the $os
|
||||||
|
explorer variable.
|
||||||
|
e.g. apt for Debian
|
||||||
|
yum for Red Hat
|
||||||
|
pacman for Arch Linux
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Upgrade all the installed packages on the target
|
||||||
|
__package_upgrade_all
|
||||||
|
|
||||||
|
# Force use of a specific package manager
|
||||||
|
__package_upgrade_all --type apt</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2014 Ricardo Catalinas Jiménez. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
31
software/cdist/man/4.0.0/man7/cdist-type__package_yum.html
Normal file
31
software/cdist/man/4.0.0/man7/cdist-type__package_yum.html
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_yum(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_yum(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__package_yum(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_yum - Manage packages with yum</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Yum is usually used on the Fedora distribution to manage packages.
|
||||||
|
If you specify an unknown package, yum will display the
|
||||||
|
slightly confusing error message "Error: Nothing to do".</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
url
|
||||||
|
</span></dt><dd>
|
||||||
|
URL to use for the package
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh in installed
|
||||||
|
__package_yum zsh --state present
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_yum python --state present --name python2
|
||||||
|
|
||||||
|
# Remove obsolete package
|
||||||
|
__package_yum puppet --state absent
|
||||||
|
|
||||||
|
__package epel-release-6-8 \
|
||||||
|
--url http://mirror.switch.ch/ftp/mirror/epel/6/i386/epel-release-6-8.noarch.rpm</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,39 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__package_zypper(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__package_zypper(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64164944"></a>cdist-type__package_zypper(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Daniel</span> <span class="surname">Heule</span></h3><code class="email"><<a class="email" href="mailto:hda--@--sfs.biz">hda--@--sfs.biz</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__package_zypper - Manage packages with zypper</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Zypper is usually used on the SuSE distribution to manage packages.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use the name and not the object id as the package name.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
version
|
||||||
|
</span></dt><dd>
|
||||||
|
The version of the package to install. Default is to install the version
|
||||||
|
chosen by the local package manager. For a list of available versions,
|
||||||
|
have a look at the output of "zypper se -s packagename"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
ptype
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "package", "patch", "pattern", "product" or "srcpackage", defaults to "package". For a description see man zypper.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure zsh is installed
|
||||||
|
__package_zypper zsh --state present
|
||||||
|
|
||||||
|
# If you don't want to follow pythonX packages, but always use python
|
||||||
|
__package_zypper python --state present --name python2
|
||||||
|
|
||||||
|
# Ensure binutils is installed and the version is forced to be 2.23.1-0.19.2
|
||||||
|
__package_zypper binutils --state present --version 2.23.1-0.19.2
|
||||||
|
|
||||||
|
# Remove package
|
||||||
|
__package_zypper cfengine --state absent
|
||||||
|
|
||||||
|
# install all packages which belongs to pattern x11
|
||||||
|
__package_zypper x11 --ptype pattern --state present</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__package.html">cdist-type__package(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Nico Schottelius.
|
||||||
|
Copyright (C) 2013 Daniel Heule.
|
||||||
|
Free use of this software is granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
36
software/cdist/man/4.0.0/man7/cdist-type__pacman_conf.html
Normal file
36
software/cdist/man/4.0.0/man7/cdist-type__pacman_conf.html
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__pacman_conf(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__pacman_conf(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60290128"></a>cdist-type__pacman_conf(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Dominique</span> <span class="surname">Roux</span></h3><code class="email"><<a class="email" href="mailto:dominique.roux4@gmail.com">dominique.roux4@gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__pacman_conf - Manage pacman configuration</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>The type allows you to configure options section, add or delete repositories and manage mirrorlists</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
section
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
<span class="emphasis"><em>options</em></span> for configure options section
|
||||||
|
</p><pre class="literallayout">Otherwise it specifies a repository or a plain file</pre></dd><dt><span class="term">
|
||||||
|
key
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Specifies the key which will be set
|
||||||
|
</p><pre class="literallayout">If section = 'options' or file is not set the key will
|
||||||
|
be checked against available keys from pacman.conf</pre></dd><dt><span class="term">
|
||||||
|
value
|
||||||
|
</span></dt><dd>
|
||||||
|
Specifies the value which will be set against the key
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Specifies the filename.
|
||||||
|
</p><pre class="literallayout">The managed file will be named like 'plain_file_filename'</pre><pre class="literallayout">If supplied the key will not be checked.</pre></dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Manage options section in pacman.conf
|
||||||
|
__pacman_conf options_Architecture --section options --key Architecture --value auto
|
||||||
|
|
||||||
|
# Add new repository
|
||||||
|
__pacman_conf localrepo_Server --section localrepo --key Server --value "file:///var/cache/pacman/pkg"
|
||||||
|
|
||||||
|
# Add mirror to a mirrorlist
|
||||||
|
__pacman_conf customlist_Server --file customlist --section customlist --key Server\
|
||||||
|
--value "file:///var/cache/pacman/pkg"</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/grep.html">grep(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Dominique Roux. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__pacman_conf_integrate(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__pacman_conf_integrate(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685648"></a>cdist-type__pacman_conf_integrate(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Dominique</span> <span class="surname">Roux</span></h3><code class="email"><<a class="email" href="mailto:dominique.roux4@gmail.com">dominique.roux4@gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__pacman_conf_integrate - Integrate default pacman.conf to cdist conform and vice versa</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>The type allows you to convert the default pacman.conf to a cdist conform one and vice versa</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
<span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Convert normal to cdist conform
|
||||||
|
__pacman_conf_integrate convert
|
||||||
|
|
||||||
|
# Convert cdist conform to normal
|
||||||
|
__pacman_conf_integrate convert --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/grep.html">grep(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2015 Dominique Roux. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
17
software/cdist/man/4.0.0/man7/cdist-type__pf_apply.html
Normal file
17
software/cdist/man/4.0.0/man7/cdist-type__pf_apply.html
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__pf_apply(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__pf_apply(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60671056"></a>cdist-type__pf_apply(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email"><<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__pf_apply - Apply pf(4) ruleset on *BSD</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is used on *BSD systems to manage the pf firewall’s active ruleset.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>NONE</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>NONE</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Modify the ruleset on $__target_host:
|
||||||
|
__pf_ruleset --state present --source /my/pf/ruleset.conf
|
||||||
|
require="__pf_ruleset" \
|
||||||
|
__pf_apply
|
||||||
|
|
||||||
|
# Remove the ruleset on $__target_host (implies disabling pf(4):
|
||||||
|
__pf_ruleset --state absent
|
||||||
|
require="__pf_ruleset" \
|
||||||
|
__pf_apply</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__pf_ruleset.html">cdist-type__pf_ruleset(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
pf(4)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Jake Guffey. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
21
software/cdist/man/4.0.0/man7/cdist-type__pf_ruleset.html
Normal file
21
software/cdist/man/4.0.0/man7/cdist-type__pf_ruleset.html
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__pf_ruleset(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__pf_ruleset(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-type__pf_ruleset(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Jake</span> <span class="surname">Guffey</span></h3><code class="email"><<a class="email" href="mailto:jake.guffey--@--eprotex.com">jake.guffey--@--eprotex.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type<span class="emphasis"><em>pf_ruleset - Copy a pf(4) ruleset to $</em></span>target_host</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This type is used on *BSD systems to manage the pf firewall’s ruleset.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "absent" (no ruleset at all) or "present", defaults to "present".
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
If supplied, use to define the ruleset to load onto the $__target_host for pf(4).
|
||||||
|
Note that this type is almost useless without a ruleset defined, but it’s technically not
|
||||||
|
needed, e.g. for the case of disabling the firewall temporarily.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Remove the current ruleset in place
|
||||||
|
__pf_ruleset --state absent
|
||||||
|
|
||||||
|
# Enable the firewall with the ruleset defined in $__manifest/files/pf.conf
|
||||||
|
__pf_ruleset --state present --source $__manifest/files/pf.conf</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
pf(4)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Jake Guffey. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
5
software/cdist/man/4.0.0/man7/cdist-type__postfix.html
Normal file
5
software/cdist/man/4.0.0/man7/cdist-type__postfix.html
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postfix(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postfix(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685136"></a>cdist-type__postfix(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postfix - install postfix</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This space intentionally left blank.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__postfix</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,52 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postfix_master(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postfix_master(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64676944"></a>cdist-type__postfix_master(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">4. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">5. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postfix_master - configure postfix master.cf</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>See master(5) for more information.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
type
|
||||||
|
</span></dt><dd>
|
||||||
|
See master(5)
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
command
|
||||||
|
</span></dt><dd>
|
||||||
|
See master(5)
|
||||||
|
</dd></dl></div></div><div class="section" title="4. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>4. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
noreload
|
||||||
|
</span></dt><dd>
|
||||||
|
don’t reload postfix after changes
|
||||||
|
</dd></dl></div></div><div class="section" title="5. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>5. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
present or absent, defaults to present
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
service
|
||||||
|
, </span><span class="term">
|
||||||
|
private
|
||||||
|
, </span><span class="term">
|
||||||
|
unpriv
|
||||||
|
, </span><span class="term">
|
||||||
|
chroot
|
||||||
|
, </span><span class="term">
|
||||||
|
wakeup
|
||||||
|
, </span><span class="term">
|
||||||
|
maxproc
|
||||||
|
, </span><span class="term">
|
||||||
|
option
|
||||||
|
</span></dt><dd>
|
||||||
|
Pass an option to a service. Same as using -o in master.cf.
|
||||||
|
Can be specified multiple times.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
comment
|
||||||
|
</span></dt><dd>
|
||||||
|
a textual comment to add with the master.cf entry
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen">__postfix_master smtp --type inet --command smtpd
|
||||||
|
|
||||||
|
__postfix_master smtp --type inet --chroot y --command smtpd \
|
||||||
|
--option smtpd_enforce_tls=yes \
|
||||||
|
--option smtpd_sasl_auth_enable=yes \
|
||||||
|
--option smtpd_client_restrictions=permit_sasl_authenticated,reject
|
||||||
|
|
||||||
|
__postfix_master submission --type inet --command smtpd \
|
||||||
|
--comment "Run alternative smtp on submission port"</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
master(5)
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2012 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postfix_postconf(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postfix_postconf(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742608"></a>cdist-type__postfix_postconf(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postfix_postconf - configure postfix main.cf</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>See postconf(5) for possible keys and values.</p><p>Note that this type directly runs the postconf executable.
|
||||||
|
It does not make changes to /etc/postfix/main.cf itself.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
value
|
||||||
|
</span></dt><dd>
|
||||||
|
the value for the postfix parameter
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
key
|
||||||
|
</span></dt><dd>
|
||||||
|
the name of the parameter. Defaults to __object_id
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__postfix_postconf mydomain --value somedomain.com
|
||||||
|
|
||||||
|
__postfix_postconf bind-to-special-ip --key smtp_bind_address --value 127.0.0.5</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
postconf(5)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postfix_postmap(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postfix_postmap(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64685136"></a>cdist-type__postfix_postmap(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postfix_postmap - run postmap on the given file</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This space intentionally left blank.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__postfix_postmap /etc/postfix/generic</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postfix_reload(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postfix_reload(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__postfix_reload(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postfix_reload - tell postfix to reload its configuration</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This space intentionally left blank.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><p>None.</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__postfix_reload</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
cdist-type(7)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postgres_database(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postgres_database(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64747088"></a>cdist-type__postgres_database(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postgres_database - create/drop postgres databases</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create or drop postgres databases.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
either <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
the role owning this database
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen">__postgres_database mydbname --owner mydbusername</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__postgres_role.html">cdist-type__postgres_role(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2011 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
33
software/cdist/man/4.0.0/man7/cdist-type__postgres_role.html
Normal file
33
software/cdist/man/4.0.0/man7/cdist-type__postgres_role.html
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__postgres_role(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__postgres_role(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64689232"></a>cdist-type__postgres_role(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_see_also">4. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">5. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__postgres_role - manage postgres roles</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create or drop postgres roles.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd></dl></div><p>All other parameters map directly to the corresponding postgres createrole
|
||||||
|
parameters.</p><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
password
|
||||||
|
</span></dt><dd>
|
||||||
|
BOOLEAN PARAMETERS
|
||||||
|
</dd></dl></div><pre class="screen">All parameter map directly to the corresponding postgres createrole
|
||||||
|
parameters.
|
||||||
|
|
||||||
|
login::
|
||||||
|
createdb::
|
||||||
|
createrole::
|
||||||
|
superuser::
|
||||||
|
inherit::
|
||||||
|
|
||||||
|
EXAMPLES</pre><pre class="screen">__postgres_role myrole
|
||||||
|
|
||||||
|
__postgres_role myrole --password 'secret'
|
||||||
|
|
||||||
|
__postgres_role admin --password 'very-secret' --superuser
|
||||||
|
|
||||||
|
__postgres_role dbcustomer --password 'bla' --createdb</pre></div><div class="section" title="4. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>4. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__postgres_database.html">cdist-type__postgres_database(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a class="ulink" href="http://www.postgresql.org/docs/current/static/sql-createrole.html" target="_top">http://www.postgresql.org/docs/current/static/sql-createrole.html</a>
|
||||||
|
</li></ul></div></div><div class="section" title="5. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>5. COPYING</h2></div></div></div><p>Copyright (C) 2011 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
43
software/cdist/man/4.0.0/man7/cdist-type__process.html
Normal file
43
software/cdist/man/4.0.0/man7/cdist-type__process.html
Normal file
|
|
@ -0,0 +1,43 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__process(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__process(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__process(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__process - Start or stop process</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to define the state of a process.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
name
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Process name to match on when using pgrep -f -x.
|
||||||
|
</p><pre class="literallayout">This is useful, if the name starts with a "/",
|
||||||
|
because the leading slash is stripped away from
|
||||||
|
the object id by cdist.</pre></dd><dt><span class="term">
|
||||||
|
stop
|
||||||
|
</span></dt><dd>
|
||||||
|
Executable to use for stopping the process.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
start
|
||||||
|
</span></dt><dd>
|
||||||
|
Executable to use for starting the process.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Start if not running
|
||||||
|
__process /usr/sbin/syslog-ng --state present
|
||||||
|
|
||||||
|
# Start if not running with a different binary
|
||||||
|
__process /usr/sbin/nginx --state present --start "/etc/rc.d/nginx start"
|
||||||
|
|
||||||
|
# Stop the process using kill (the type default) - DO NOT USE THIS
|
||||||
|
__process /usr/sbin/sshd --state absent
|
||||||
|
|
||||||
|
# Stop the process using /etc/rc.d/sshd stop - THIS ONE NOT AS WELL
|
||||||
|
__process /usr/sbin/sshd --state absent --stop "/etc/rc.d/sshd stop"
|
||||||
|
|
||||||
|
# Ensure cups is running, which runs with -C ...:
|
||||||
|
__process cups --start "/etc/rc.d/cups start" --state present \
|
||||||
|
--name "/usr/sbin/cupsd -C /etc/cups/cupsd.conf"
|
||||||
|
|
||||||
|
# Ensure rpc.statd is running (which usually runs with -L) using a regexp
|
||||||
|
__process rpcstatd --state present --start "/etc/init.d/statd start" \
|
||||||
|
--name "rpc.statd.*"</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__start_on_boot.html">cdist-type__start_on_boot(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2011-2012 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
48
software/cdist/man/4.0.0/man7/cdist-type__pyvenv.html
Normal file
48
software/cdist/man/4.0.0/man7/cdist-type__pyvenv.html
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__pyvenv(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__pyvenv(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__pyvenv(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Darko</span> <span class="surname">Poljak</span></h3><code class="email"><<a class="email" href="mailto:darko.poljak--@--gmail.com">darko.poljak--@--gmail.com</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__pyvenv - Create or remove python virtual environment</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to create or remove python virtual
|
||||||
|
environment using pyvenv.
|
||||||
|
It assumes pyvenv is already installed. Concrete package depends
|
||||||
|
on concrete OS and/or OS version/distribution.
|
||||||
|
Ensure this for e.g. in your init manifest as in the following example:</p><pre class="screen">case "$__target_host" in
|
||||||
|
localhost)
|
||||||
|
__package python3-venv --state present
|
||||||
|
require="__package/python3-venv" __pyvenv /home/darko/testenv --pyvenv "pyvenv-3.4" --owner darko --group darko --mode 740 --state present
|
||||||
|
require="__pyvenv/home/darko/testenv" __package_pip docopt --pip /home/darko/testenv/bin/pip --runas darko --state present
|
||||||
|
;;
|
||||||
|
esac</pre></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><p>None</p></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
Group to chgrp to
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
mode
|
||||||
|
</span></dt><dd>
|
||||||
|
Unix permissions, suitable for chmod
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
User to chown to
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
pyvenv
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this specific pyvenv
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
venvparams
|
||||||
|
</span></dt><dd>
|
||||||
|
Specific parameters to pass to pyvenv invocation
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__pyvenv /home/services/djangoenv
|
||||||
|
|
||||||
|
# Use specific pyvenv
|
||||||
|
__pyvenv /home/foo/fooenv --pyvenv /usr/local/bin/pyvenv-3.4
|
||||||
|
|
||||||
|
# Create python virtualenv for user foo.
|
||||||
|
__pyvenv /home/foo/fooenv --group foo --user foo
|
||||||
|
|
||||||
|
# Create python virtualenv with specific parameters.
|
||||||
|
__pyvenv /home/services/djangoenv --venvparams "--copies --system-site-packages"</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2016 Darko Poljak. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
20
software/cdist/man/4.0.0/man7/cdist-type__qemu_img.html
Normal file
20
software/cdist/man/4.0.0/man7/cdist-type__qemu_img.html
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__qemu_img(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__qemu_img(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__qemu_img(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__qemu_img - Manage VM disk images</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>The qemu-img program is used to create qemu images for
|
||||||
|
qemu and (qemu-)kvm.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
size
|
||||||
|
</span></dt><dd><p class="simpara">
|
||||||
|
Size of the image in qemu-img compatible units.
|
||||||
|
</p><pre class="literallayout">Required if state is "present".</pre></dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Create a 50G size image
|
||||||
|
__qemu_img /home/services/kvm/vm/myvmname/system-disk --size 50G
|
||||||
|
|
||||||
|
# Remove image
|
||||||
|
__qemu_img /home/services/kvm/vm/myoldvm/system-disk --state absent</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/qemu-img.html">qemu-img(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2012-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
21
software/cdist/man/4.0.0/man7/cdist-type__rbenv.html
Normal file
21
software/cdist/man/4.0.0/man7/cdist-type__rbenv.html
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__rbenv(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__rbenv(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp63919184"></a>cdist-type__rbenv(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__rbenv - Manage rbenv installation</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>This cdist type allows you to manage rbenv installations.
|
||||||
|
It also installs ruby-build.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present"
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
Which user should own the rbenv installation, defaults to root
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Install rbenv including ruby-build for nico
|
||||||
|
__rbenv /home/nico
|
||||||
|
|
||||||
|
# Install rbenv including ruby-build for nico
|
||||||
|
__rbenv /home/nico --owner nico
|
||||||
|
|
||||||
|
# Bastian does not need rbenv anymore, he began to code C99
|
||||||
|
__rbenv /home/bastian --state absent</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2012-2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
71
software/cdist/man/4.0.0/man7/cdist-type__rsync.html
Normal file
71
software/cdist/man/4.0.0/man7/cdist-type__rsync.html
Normal file
|
|
@ -0,0 +1,71 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__rsync(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__rsync(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60535888"></a>cdist-type__rsync(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_multiple_parameters">5. OPTIONAL MULTIPLE PARAMETERS</a></span></dt><dt><span class="section"><a href="#_messages">6. MESSAGES</a></span></dt><dt><span class="section"><a href="#_examples">7. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">8. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">9. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__rsync - Mirror directories using rsync</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><div class="warning" title="Warning" style="margin-left: 0; margin-right: 10%;"><h3 class="title">Warning</h3><p>This type is of BETA quality:</p></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
it has not been tested widely
|
||||||
|
</li><li class="listitem">
|
||||||
|
interfaces <span class="strong"><strong>may</strong></span> change
|
||||||
|
</li><li class="listitem">
|
||||||
|
if there is a better approach to solve the problem → the type may even vanish
|
||||||
|
</li></ul></div><p>If you are fine with these constraints, please read on.</p><p>This cdist type allows you to mirror local directories to the
|
||||||
|
target host using rsync. Rsync will be installed in the manifest of the type.
|
||||||
|
If group or owner are giveng, a recursive chown will be executed on the
|
||||||
|
target host.</p><p>A slash will be appended to the source directory so that only the contents
|
||||||
|
of the directory are taken and not the directory name itself.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
source
|
||||||
|
</span></dt><dd>
|
||||||
|
Where to take files from
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
group
|
||||||
|
</span></dt><dd>
|
||||||
|
Group to chgrp to.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
User to chown to.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
destination
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this as the base destination instead of the object id
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
remote-user
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this user instead of the default "root" for rsync operations.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. OPTIONAL MULTIPLE PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_multiple_parameters"></a>5. OPTIONAL MULTIPLE PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
rsync-opts
|
||||||
|
</span></dt><dd>
|
||||||
|
Use this option to give rsync options with.
|
||||||
|
See <a href="../man1/rsync.html">rsync(1)</a> for available options.
|
||||||
|
Only "--" options are supported.
|
||||||
|
Write the options without the beginning "--"
|
||||||
|
Can be specified multiple times.
|
||||||
|
</dd></dl></div></div><div class="section" title="6. MESSAGES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_messages"></a>6. MESSAGES</h2></div></div></div><p>NONE</p></div><div class="section" title="7. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>7. EXAMPLES</h2></div></div></div><pre class="screen"># You can use any source directory
|
||||||
|
__rsync /tmp/testdir \
|
||||||
|
--source /etc
|
||||||
|
|
||||||
|
# Use source from type
|
||||||
|
__rsync /etc \
|
||||||
|
--source "$__type/files/package"
|
||||||
|
|
||||||
|
# Allow multiple __rsync objects to write to the same dir
|
||||||
|
__rsync mystuff \
|
||||||
|
--destination /usr/local/bin \
|
||||||
|
--source "$__type/files/package"
|
||||||
|
|
||||||
|
__rsync otherstuff \
|
||||||
|
--destination /usr/local/bin \
|
||||||
|
--source "$__type/files/package2"
|
||||||
|
|
||||||
|
# Use rsync option --exclude
|
||||||
|
__rsync /tmp/testdir \
|
||||||
|
--source /etc \
|
||||||
|
--rsync-opts exclude=sshd_conf
|
||||||
|
|
||||||
|
# Use rsync with multiple options --exclude --dry-run
|
||||||
|
__rsync /tmp/testing \
|
||||||
|
--source /home/tester \
|
||||||
|
--rsync-opts exclude=id_rsa \
|
||||||
|
--rsync-opts dry-run</pre></div><div class="section" title="8. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>8. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man1/rsync.html">rsync(1)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="9. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>9. COPYING</h2></div></div></div><p>Copyright (C) 2015 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
19
software/cdist/man/4.0.0/man7/cdist-type__rvm.html
Normal file
19
software/cdist/man/4.0.0/man7/cdist-type__rvm.html
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__rvm(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__rvm(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64738384"></a>cdist-type__rvm(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Evax</span> <span class="surname">Software</span></h3><code class="email"><<a class="email" href="mailto:contact@evax.fr">contact@evax.fr</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__rvm - Install rvm for a given user</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>RVM is the Ruby enVironment Manager for the Ruby programming language.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Install rvm for user billie
|
||||||
|
__rvm billie --state present
|
||||||
|
|
||||||
|
# Remove rvm
|
||||||
|
__rvm billie --state absent</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_ruby.html">cdist-type__rvm_ruby(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_gemset.html">cdist-type__rvm_gemset(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_gem.html">cdist-type__rvm_gem(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
35
software/cdist/man/4.0.0/man7/cdist-type__rvm_gem.html
Normal file
35
software/cdist/man/4.0.0/man7/cdist-type__rvm_gem.html
Normal file
|
|
@ -0,0 +1,35 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__rvm_gemset(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__rvm_gemset(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64746576"></a>cdist-type__rvm_gemset(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Evax</span> <span class="surname">Software</span></h3><code class="email"><<a class="email" href="mailto:contact@evax.fr">contact@evax.fr</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__rvm_gem - Manage Ruby gems through rvm</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>RVM is the Ruby enVironment Manager for the Ruby programming language.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
user
|
||||||
|
</span></dt><dd>
|
||||||
|
The remote user account to use
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
gemset
|
||||||
|
</span></dt><dd>
|
||||||
|
The gemset to use
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
default
|
||||||
|
</span></dt><dd>
|
||||||
|
Make the selected gemset the default
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Install the rails gem in gemset ruby-1.9.3-p0@myset for user bill
|
||||||
|
__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill --state present
|
||||||
|
|
||||||
|
# Do the same and also make ruby-1.9.3-p0@myset the default gemset
|
||||||
|
__rvm_gemset rails --gemset ruby-1.9.3-p0@myset --user bill \
|
||||||
|
--state present --default
|
||||||
|
|
||||||
|
# Remove it
|
||||||
|
__rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm.html">cdist-type__rvm(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_ruby.html">cdist-type__rvm_ruby(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_gemset.html">cdist-type__rvm_gemset(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
30
software/cdist/man/4.0.0/man7/cdist-type__rvm_gemset.html
Normal file
30
software/cdist/man/4.0.0/man7/cdist-type__rvm_gemset.html
Normal file
|
|
@ -0,0 +1,30 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__rvm_gemset(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__rvm_gemset(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp60556368"></a>cdist-type__rvm_gemset(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Evax</span> <span class="surname">Software</span></h3><code class="email"><<a class="email" href="mailto:contact@evax.fr">contact@evax.fr</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">4. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__rvm_gemset - Manage gemsets through rvm</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>RVM is the Ruby enVironment Manager for the Ruby programming language.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
user
|
||||||
|
</span></dt><dd>
|
||||||
|
The remote user account to use
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
</dd></dl></div></div><div class="section" title="4. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>4. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
default
|
||||||
|
</span></dt><dd>
|
||||||
|
If present, set the given gemset as default.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Install the gemset @myset for user charles on based on ruby-1.9.3-0
|
||||||
|
__rvm_gemset ruby-1.9.3-p0@myset --user charles --state present
|
||||||
|
|
||||||
|
# Do the same and make ruby-1.9.3-p0@myset the default gemset
|
||||||
|
__rvm_gemset ruby-1.9.3-p0@myset --user charles --state present --default
|
||||||
|
|
||||||
|
# Remove the gemset @myset for user john
|
||||||
|
__rvm_ruby ruby-1.9.3-p0@myset --user john --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm.html">cdist-type__rvm(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_ruby.html">cdist-type__rvm_ruby(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_gem.html">cdist-type__rvm_gem(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
27
software/cdist/man/4.0.0/man7/cdist-type__rvm_ruby.html
Normal file
27
software/cdist/man/4.0.0/man7/cdist-type__rvm_ruby.html
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__rvm_ruby(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__rvm_ruby(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681040"></a>cdist-type__rvm_ruby(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Evax</span> <span class="surname">Software</span></h3><code class="email"><<a class="email" href="mailto:contact@evax.fr">contact@evax.fr</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">4. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__rvm_ruby - Manage ruby installations through rvm</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>RVM is the Ruby enVironment Manager for the Ruby programming language.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
user
|
||||||
|
</span></dt><dd>
|
||||||
|
The remote user account to use
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
Either "present" or "absent", defaults to "present".
|
||||||
|
</dd></dl></div></div><div class="section" title="4. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>4. BOOLEAN PARAMETERS</h2></div></div></div><p>default:
|
||||||
|
Set the given version as default</p></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen"># Install ruby 1.9.3 through rvm for user thelonious
|
||||||
|
__rvm_ruby ruby-1.9.3-p0 --user thelonious --state present
|
||||||
|
|
||||||
|
# Install ruby 1.9.3 through rvm for user ornette and make it the default
|
||||||
|
__rvm_ruby ruby-1.9.3-p0 --user ornette --state present --default
|
||||||
|
|
||||||
|
# Remove ruby 1.9.3 for user john
|
||||||
|
__rvm_ruby ruby-1.9.3-p0 --user john --state absent</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm.html">cdist-type__rvm(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_gemset.html">cdist-type__rvm_gemset(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__rvm_gem.html">cdist-type__rvm_gem(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2012 Evax Software. Free use of this software is granted under
|
||||||
|
the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__ssh_authorized_key(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__ssh_authorized_key(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64673360"></a>cdist-type__ssh_authorized_key(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">5. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">6. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">7. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__ssh_authorized_key - manage a single ssh authorized key entry</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Manage a single authorized key entry in an authorized_key file.
|
||||||
|
This type was created to be used by the __ssh_authorized_keys type.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd>
|
||||||
|
the authorized_keys file to which the given key should be added
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
key
|
||||||
|
</span></dt><dd>
|
||||||
|
a string containing the ssh keytype, base 64 encoded key and optional
|
||||||
|
trailing comment which shall be added to the given authorized_keys file.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
comment
|
||||||
|
</span></dt><dd>
|
||||||
|
explicit comment instead of the one which may be trailing the given key
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
option
|
||||||
|
</span></dt><dd>
|
||||||
|
an option to set for this authorized_key entry.
|
||||||
|
Can be specified multiple times.
|
||||||
|
See sshd(8) for available options.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if the given keys should be <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>5. EXAMPLES</h2></div></div></div><pre class="screen">__ssh_authorized_key some-id \
|
||||||
|
--file "/home/user/.ssh/autorized_keys" \
|
||||||
|
--key "$(cat ~/.ssh/id_rsa.pub)"
|
||||||
|
|
||||||
|
__ssh_authorized_key some-id \
|
||||||
|
--file "/home/user/.ssh/autorized_keys" \
|
||||||
|
--key "$(cat ~/.ssh/id_rsa.pub)" \
|
||||||
|
--option 'command="/path/to/script"' \
|
||||||
|
--option 'environment="FOO=bar"' \
|
||||||
|
--comment 'one to rule them all'</pre></div><div class="section" title="6. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>6. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist__ssh_authorized_keys.html">cdist__ssh_authorized_keys(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
sshd(8)
|
||||||
|
</li></ul></div></div><div class="section" title="7. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>7. COPYING</h2></div></div></div><p>Copyright (C) 2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
|
|
@ -0,0 +1,86 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__ssh_authorized_keys(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__ssh_authorized_keys(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64681552"></a>cdist-type__ssh_authorized_keys(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Steven</span> <span class="surname">Armstrong</span></h3><code class="email"><<a class="email" href="mailto:steven-cdist--@--armstrong.cc">steven-cdist--@--armstrong.cc</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_required_parameters">3. REQUIRED PARAMETERS</a></span></dt><dt><span class="section"><a href="#_optional_parameters">4. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_boolean_parameters">5. BOOLEAN PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">7. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">8. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__ssh_authorized_keys - manage ssh authorized_keys files</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Adds or removes ssh keys from a authorized_keys file.</p><p>This type uses the __ssh_dot_ssh type to manage the directory containing
|
||||||
|
the authorized_keys file. You can disable this feature with the --noparent
|
||||||
|
boolean parameter.</p><p>The existence, ownership and permissions of the authorized_keys file itself are
|
||||||
|
also managed. This can be disabled with the --nofile boolean parameter. It is
|
||||||
|
then left to the user to ensure that the file exists and that ownership and
|
||||||
|
permissions work with ssh.</p></div><div class="section" title="3. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>3. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
key
|
||||||
|
</span></dt><dd>
|
||||||
|
the ssh key which shall be added to this authorized_keys file.
|
||||||
|
Must be a string and can be specified multiple times.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>4. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
comment
|
||||||
|
</span></dt><dd>
|
||||||
|
explicit comment instead of the one which may be trailing the given key
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
file
|
||||||
|
</span></dt><dd>
|
||||||
|
an alternative destination file, defaults to ~$owner/.ssh/authorized_keys
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
option
|
||||||
|
</span></dt><dd>
|
||||||
|
an option to set for all created authorized_key entries.
|
||||||
|
Can be specified multiple times.
|
||||||
|
See sshd(8) for available options.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
owner
|
||||||
|
</span></dt><dd>
|
||||||
|
the user owning the authorized_keys file, defaults to object_id.
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if the given keys should be <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd></dl></div></div><div class="section" title="5. BOOLEAN PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_parameters"></a>5. BOOLEAN PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
noparent
|
||||||
|
</span></dt><dd>
|
||||||
|
don’t create or change ownership and permissions of the directory containing
|
||||||
|
the authorized_keys file
|
||||||
|
</dd><dt><span class="term">
|
||||||
|
nofile
|
||||||
|
</span></dt><dd>
|
||||||
|
don’t manage existence, ownership and permissions of the the authorized_keys
|
||||||
|
file
|
||||||
|
</dd></dl></div></div><div class="section" title="6. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>6. EXAMPLES</h2></div></div></div><pre class="screen"># add your ssh key to remote root's authorized_keys file
|
||||||
|
__ssh_authorized_keys root \
|
||||||
|
--key "$(cat ~/.ssh/id_rsa.pub)"
|
||||||
|
|
||||||
|
# allow key to login as user-name
|
||||||
|
__ssh_authorized_keys user-name \
|
||||||
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
||||||
|
|
||||||
|
# allow key to login as user-name with options and expicit comment
|
||||||
|
__ssh_authorized_keys user-name \
|
||||||
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..." \
|
||||||
|
--option no-agent-forwarding \
|
||||||
|
--option 'from="*.example.com"' \
|
||||||
|
--comment 'backup server'
|
||||||
|
|
||||||
|
# same as above, but with explicit owner and two keys
|
||||||
|
# note that the options are set for all given keys
|
||||||
|
__ssh_authorized_keys some-fancy-id \
|
||||||
|
--owner user-name \
|
||||||
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..." \
|
||||||
|
--key "ssh-rsa AZXYAAB3NzaC1yc2..." \
|
||||||
|
--option no-agent-forwarding \
|
||||||
|
--option 'from="*.example.com"' \
|
||||||
|
--comment 'backup server'
|
||||||
|
|
||||||
|
# authorized_keys file in non standard location
|
||||||
|
__ssh_authorized_keys some-fancy-id \
|
||||||
|
--file /etc/ssh/keys/user-name/authorized_keys \
|
||||||
|
--owner user-name \
|
||||||
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..."
|
||||||
|
|
||||||
|
# same as above, but directory and authorized_keys file is created elswhere
|
||||||
|
__ssh_authorized_keys some-fancy-id \
|
||||||
|
--file /etc/ssh/keys/user-name/authorized_keys \
|
||||||
|
--owner user-name \
|
||||||
|
--noparent \
|
||||||
|
--nofile \
|
||||||
|
--key "ssh-rsa AXYZAAB3NzaC1yc2..."</pre></div><div class="section" title="7. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>7. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
sshd(8)
|
||||||
|
</li></ul></div></div><div class="section" title="8. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>8. COPYING</h2></div></div></div><p>Copyright (C) 2012-2014 Steven Armstrong. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
15
software/cdist/man/4.0.0/man7/cdist-type__ssh_dot_ssh.html
Normal file
15
software/cdist/man/4.0.0/man7/cdist-type__ssh_dot_ssh.html
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>cdist-type__ssh_dot_ssh(7)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.76.1" /></head><body><div xml:lang="en" class="article" title="cdist-type__ssh_dot_ssh(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp64742480"></a>cdist-type__ssh_dot_ssh(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Nico</span> <span class="surname">Schottelius</span></h3><code class="email"><<a class="email" href="mailto:nico-cdist--@--schottelius.org">nico-cdist--@--schottelius.org</a>></code></div></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl><dt><span class="section"><a href="#_name">1. NAME</a></span></dt><dt><span class="section"><a href="#_description">2. DESCRIPTION</a></span></dt><dt><span class="section"><a href="#_optional_parameters">3. OPTIONAL PARAMETERS</a></span></dt><dt><span class="section"><a href="#_examples">4. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_see_also">5. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">6. COPYING</a></span></dt></dl></div><div class="section" title="1. NAME"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. NAME</h2></div></div></div><p>cdist-type__ssh_dot_ssh - Manage .ssh directory</p></div><div class="section" title="2. DESCRIPTION"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_description"></a>2. DESCRIPTION</h2></div></div></div><p>Adds or removes .ssh directory to a user home.</p><p>This type is being used by __ssh_authorized_keys.</p></div><div class="section" title="3. OPTIONAL PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_optional_parameters"></a>3. OPTIONAL PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
||||||
|
state
|
||||||
|
</span></dt><dd>
|
||||||
|
if the directory should be <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</em></span>, defaults to <span class="emphasis"><em>present</em></span>.
|
||||||
|
</dd></dl></div></div><div class="section" title="4. EXAMPLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_examples"></a>4. EXAMPLES</h2></div></div></div><pre class="screen"># Ensure root has ~/.ssh with the right permissions
|
||||||
|
__ssh_dot_ssh root
|
||||||
|
|
||||||
|
# Nico does not need ~/.ssh anymore
|
||||||
|
__ssh_dot_ssh nico --state absent</pre></div><div class="section" title="5. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>5. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type.html">cdist-type(7)</a>
|
||||||
|
</li><li class="listitem">
|
||||||
|
<a href="../man7/cdist-type__ssh_authorized_keys.html">cdist-type__ssh_authorized_keys(7)</a>
|
||||||
|
</li></ul></div></div><div class="section" title="6. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>6. COPYING</h2></div></div></div><p>Copyright (C) 2014 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue