-wrong version
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
Nico Schottelius
parent
f17c387073
commit
308c7bedef
48 changed files with 0 additions and 1715 deletions
|
|
@ -1,66 +0,0 @@
|
||||||
<?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="idp25203744"></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="#_banner">4. BANNER</a></span></dt><dt><span class="section"><a href="#_config">5. CONFIG</a></span></dt><dt><span class="section"><a href="#_examples">6. EXAMPLES</a></span></dt><dt><span class="section"><a href="#_environment">7. ENVIRONMENT</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 - 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] [-V]</p><p>cdist banner</p><p>cdist config [-h] [-d] [-V] [-c CDIST_HOME] [-i MANIFEST] [-p] [-s] host [host …]</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 as explained below. The options to the main
|
|
||||||
program are:</p><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
-h, --help
|
|
||||||
</span></dt><dd>
|
|
||||||
Show the help screen
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
-V, --version
|
|
||||||
</span></dt><dd>
|
|
||||||
Show version and exit
|
|
||||||
</dd></dl></div></div><div class="section" title="4. BANNER"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_banner"></a>4. BANNER</h2></div></div></div><p>Displays the cdist banner.</p></div><div class="section" title="5. CONFIG"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_config"></a>5. CONFIG</h2></div></div></div><p>Configure a system</p><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
-h, --help
|
|
||||||
</span></dt><dd>
|
|
||||||
Show the help screen
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
-c CDIST_HOME, --cdist-home CDIST_HOME
|
|
||||||
</span></dt><dd>
|
|
||||||
Instead of using the parent of the bin directory as cdist home,
|
|
||||||
use the specified directory
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
-d, --debug
|
|
||||||
</span></dt><dd>
|
|
||||||
Enable debug output
|
|
||||||
</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></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 ikq05.ethz.ch with debug enabled
|
|
||||||
cdist config -d ikq05.ethz.ch
|
|
||||||
|
|
||||||
# Configure hosts in parallel and use a different home directory
|
|
||||||
cdist config -c ~/p/cdist-nutzung \
|
|
||||||
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
|
|
||||||
|
|
||||||
# Display banner
|
|
||||||
cdist banner
|
|
||||||
|
|
||||||
# Show help
|
|
||||||
cdist --help
|
|
||||||
|
|
||||||
# Show Version
|
|
||||||
cdist --version</pre></div><div class="section" title="7. ENVIRONMENT"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment"></a>7. 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></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">
|
|
||||||
cdist(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type-emulator(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-reference(7)
|
|
||||||
</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-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>
|
|
||||||
|
|
@ -1,100 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_multi_master_or_environment_setups">4. MULTI MASTER OR ENVIRONMENT SETUPS</a></span></dt><dt><span class="section"><a href="#_seperating_work_by_groups">5. SEPERATING WORK BY GROUPS</a></span></dt><dt><span class="section"><a href="#_maintaining_multiple_configurations">6. MAINTAINING MULTIPLE CONFIGURATIONS</a></span></dt><dt><span class="section"><a href="#_multiple_developers_with_different_trust">7. MULTIPLE DEVELOPERS WITH DIFFERENT TRUST</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-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 ssh-keygen(1).</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. MULTI MASTER OR ENVIRONMENT SETUPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_multi_master_or_environment_setups"></a>4. 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="5. SEPERATING WORK BY GROUPS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_seperating_work_by_groups"></a>5. 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="6. MAINTAINING MULTIPLE CONFIGURATIONS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_maintaining_multiple_configurations"></a>6. 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 git-remote(1) to adjust the remote configuration, which allows</p></div><div class="section" title="7. MULTIPLE DEVELOPERS WITH DIFFERENT TRUST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_multiple_developers_with_different_trust"></a>7. 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="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">
|
|
||||||
cdist(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-tutorial(7)
|
|
||||||
</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-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>
|
|
||||||
|
|
@ -1,77 +0,0 @@
|
||||||
<?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="idp25202576"></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
|
|
||||||
cdist-quickstart(7) 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 in is recommended, for use as backup as well to allow easy collaboration
|
|
||||||
with others.</p><p>For more sophisticated setups developing cdist configurations with multiple
|
|
||||||
people, have a look at cdist-best-practice(7).</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 cdist-quickstart(7) 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 decide on which branch you want to base your own work:
|
|
||||||
master contains more recent changes, newer types, but may also break.
|
|
||||||
The versions branches are stable, but thus may miss the latest features.
|
|
||||||
Your decision can be changed later on, but may result in merge conflicts,
|
|
||||||
which you’d have 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">
|
|
||||||
cdist(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-tutorial(7)
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
<?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="idp25202576"></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
|
|
||||||
|
|
||||||
# Except 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">
|
|
||||||
cdist(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-reference(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-stages(7)
|
|
||||||
</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-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>
|
|
||||||
|
|
@ -1,43 +0,0 @@
|
||||||
<?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="idp25203744"></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="#_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-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 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
|
|
||||||
seperate 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, you can contact me
|
|
||||||
(IRC, Mailinglist, Phone, RFC 1149) and I’ll check your code before
|
|
||||||
including it.</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 cdist-type(7).</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. 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">
|
|
||||||
cdist(7)
|
|
||||||
</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-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>
|
|
||||||
|
|
@ -1,72 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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-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 orientated programming languages.
|
|
||||||
An object is represented by the combination of
|
|
||||||
<span class="strong"><strong>type + slash + object name</strong></span>: <span class="strong"><strong><span class="emphasis"><em>file/etc/cdist-configured</em></span> is an
|
|
||||||
object of the type <span class="strong"><strong><span class="strong"><strong></strong></span>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>conf/type/</strong></span> directory,
|
|
||||||
use <span class="strong"><strong>ls 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 = removed
|
|
||||||
__package apache2 --state removed
|
|
||||||
|
|
||||||
# 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 nows 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 cdist-type(7).</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 searches for the initial manifest at <span class="strong"><strong>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>conf/manifest/</strong></span> and include them in <span class="strong"><strong>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 to
|
|
||||||
the directory containing the initial manifest (see cdist-reference(7)).</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 seperated.</p><pre class="screen"># No dependency
|
|
||||||
__file /etc/cdist-configured
|
|
||||||
|
|
||||||
# Require above object
|
|
||||||
require="__file/etc/cdist-configured" __link /tmp/cdist-testfile \
|
|
||||||
--source /etc/cdist-configured --type symbolic
|
|
||||||
|
|
||||||
# Require two objects
|
|
||||||
require="__file/etc/cdist-configured __link/tmp/cdist-testfile" \
|
|
||||||
__file /tmp/cdist-another-testfile</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></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><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 --type file
|
|
||||||
|
|
||||||
case "$__target_host" in
|
|
||||||
my.server.name)
|
|
||||||
__file /root/bin/ --type directory
|
|
||||||
__file /etc/issue.net --type file --source "$__manifest/issue.net
|
|
||||||
;;
|
|
||||||
esac</pre><p>The manifest of the type "nologin" may look like this:</p><pre class="screen">__file /etc/nologin --type file --source "$__type/files/default.nologin"</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">
|
|
||||||
cdist-tutorial(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type(7)
|
|
||||||
</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) 2010-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>
|
|
||||||
|
|
@ -1,51 +0,0 @@
|
||||||
<?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="idp25202576"></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 ssh-agent(1) and ssh-add(1) 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
|
|
||||||
git clone git://git.schottelius.org/cdist
|
|
||||||
|
|
||||||
# Create manifest (maps configuration to host(s)
|
|
||||||
cd cdist
|
|
||||||
echo '__file /etc/cdist-configured' > 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">
|
|
||||||
cdist(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-tutorial(7)
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,161 +0,0 @@
|
||||||
<?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="idp25202576"></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">6. ENVIRONMENT VARIABLES</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-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">
|
|
||||||
hostname
|
|
||||||
</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">
|
|
||||||
os
|
|
||||||
</li><li class="listitem">
|
|
||||||
os_version
|
|
||||||
</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><p>If not specified otherwise, all paths are relative to the checkout directory.</p><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
conf/
|
|
||||||
</span></dt><dd>
|
|
||||||
Contains the (static) configuration like manifests, types and explorers.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/manifest/init
|
|
||||||
</span></dt><dd>
|
|
||||||
This is the central entry point used by cdist-manifest-init(1).
|
|
||||||
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.
|
|
||||||
It should be primary used to define mapping from configurations to hosts.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/manifest/*
|
|
||||||
</span></dt><dd>
|
|
||||||
All other files in this directory are not directly used by cdist, but you
|
|
||||||
can seperate configuration mappings, if you have a lot of code in the
|
|
||||||
manifest/init file. This may also be helpful to have different admins
|
|
||||||
maintain different groups of hosts.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/explorer/<name>
|
|
||||||
</span></dt><dd>
|
|
||||||
Contains explorers to be run on the target hosts, see cdist-explorer(7).
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/
|
|
||||||
</span></dt><dd>
|
|
||||||
Contains all available types, which are used to provide
|
|
||||||
some kind of functionality. See cdist-type(7).
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/
|
|
||||||
</span></dt><dd><p class="simpara">
|
|
||||||
Home of the type <name>.
|
|
||||||
</p><pre class="literallayout">This directory is referenced by the variable __type (see below).</pre></dd><dt><span class="term">
|
|
||||||
conf/type/<name>/man.text
|
|
||||||
</span></dt><dd>
|
|
||||||
Manpage in Asciidoc format (required for inclusion into upstream)
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/manifest
|
|
||||||
</span></dt><dd>
|
|
||||||
Used to generate additional objects from a type.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/gencode-local
|
|
||||||
</span></dt><dd>
|
|
||||||
Used to generate code to be executed on the server.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/gencode-remote
|
|
||||||
</span></dt><dd>
|
|
||||||
Used to generate code to be executed on the client.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/parameters/required
|
|
||||||
</span></dt><dd>
|
|
||||||
Parameters required by type, \n seperated list.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/parameters/optional
|
|
||||||
</span></dt><dd>
|
|
||||||
Parameters optionally accepted by type, \n seperated list.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
conf/type/<name>/explorer
|
|
||||||
</span></dt><dd>
|
|
||||||
Location of the type specific explorers.
|
|
||||||
This directory is referenced by the variable __type_explorer (see below).
|
|
||||||
See cdist-explorer(7).
|
|
||||||
</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><dt><span class="term">
|
|
||||||
tmp_dir
|
|
||||||
</span></dt><dd>
|
|
||||||
A tempdir and a tempfile is used by cdist internally,
|
|
||||||
which will be removed when the scripts end automatically.
|
|
||||||
</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">
|
|
||||||
<span class="emphasis"><em>_* (cdist-type_</em></span>*(7))
|
|
||||||
</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">
|
|
||||||
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></dl></div></div><div class="section" title="6. ENVIRONMENT VARIABLES"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_environment_variables"></a>6. ENVIRONMENT VARIABLES</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
__explorer
|
|
||||||
</span></dt><dd>
|
|
||||||
Directory that contains all global explorers.
|
|
||||||
Available for: explorer
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
__manifest
|
|
||||||
</span></dt><dd>
|
|
||||||
Directory that contains the initial manifest.
|
|
||||||
Available for: initial manifest
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
__global
|
|
||||||
</span></dt><dd>
|
|
||||||
Directory that contains generic output like explorer.
|
|
||||||
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
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
__object_id
|
|
||||||
</span></dt><dd><p class="simpara">
|
|
||||||
The type unique object id.
|
|
||||||
Available for: type manifest, type explorer, type gencode
|
|
||||||
</p><pre class="literallayout">Note: The leading and the trailing "/" will always be stripped (caused by
|
|
||||||
the filesystem database and ensured by the core).</pre><pre class="literallayout"> Note: Double slashes ("//") will not be fixed and result in an error.
|
|
||||||
__self::
|
|
||||||
DEPRECATED: Same as __object_name, do not use anymore, use __object_name instead.
|
|
||||||
Will be removed in cdist 3.x.
|
|
||||||
__object_name::
|
|
||||||
The full qualified name of the current object.
|
|
||||||
Available for: type manifest, type explorer, type gencode
|
|
||||||
__target_host::
|
|
||||||
The host we are deploying to.
|
|
||||||
Available for: initial manifest, type manifest, type gencode
|
|
||||||
__type::
|
|
||||||
Path to the current type.
|
|
||||||
Available for: type manifest, type gencode
|
|
||||||
__type_explorer::
|
|
||||||
Directory that contains the type explorers.
|
|
||||||
Available for: type explorer</pre></dd></dl></div></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">
|
|
||||||
cdist(1)
|
|
||||||
</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-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>
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
<?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="idp25203744"></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.</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 transfered 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.test.ch 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">
|
|
||||||
cdist(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-reference(7)
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,54 +0,0 @@
|
||||||
<?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="idp25202576"></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">
|
|
||||||
cdist(1)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-best-practice(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-stages(7)
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,89 +0,0 @@
|
||||||
<?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="idp25203744"></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="#_writing_the_manifest">8. WRITING THE MANIFEST</a></span></dt><dt><span class="section"><a href="#_singleton_only_instance_only">9. SINGLETON - ONLY INSTANCE ONLY</a></span></dt><dt><span class="section"><a href="#_the_type_explorers">10. THE TYPE EXPLORERS</a></span></dt><dt><span class="section"><a href="#_writing_the_gencode_script">11. WRITING THE GENCODE SCRIPT</a></span></dt><dt><span class="section"><a href="#_hints_for_typewriters">12. HINTS FOR TYPEWRITERS</a></span></dt><dt><span class="section"><a href="#_how_to_include_a_type_into_upstream_cdist">13. HOW TO INCLUDE A TYPE INTO UPSTREAM CDIST</a></span></dt><dt><span class="section"><a href="#_see_also">14. SEE ALSO</a></span></dt><dt><span class="section"><a href="#_copying">15. 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 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 cdist-reference(7) 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 conf/type/. Their name should always be prefixed with
|
|
||||||
two underscores (__) to prevent collisions with other executables in $PATH.</p><p>To begin a new type, just create the directory <span class="strong"><strong>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 optional and required parameters, which must
|
|
||||||
be created in a newline seperated file in <span class="strong"><strong><span class="strong"><strong>parameters/required</strong></span></strong></span> and
|
|
||||||
<span class="strong"><strong><span class="strong"><strong>parameters/optional</strong></span></strong></span>. If either or both missing, the type will have
|
|
||||||
no required, no optional or no parameters at all.</p><p>Example:</p><pre class="screen">echo servername >> conf/type/__nginx_vhost/parameter/required
|
|
||||||
echo logdirectory >> conf/type/__nginx_vhost/parameter/optional</pre></div><div class="section" title="8. WRITING THE MANIFEST"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_the_manifest"></a>8. 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 cdist-reference(7).</p><p>Always ensure the manifest is executable, otherwise cdist will not be able
|
|
||||||
to execute it. For more information about manifests see cdist-manifest(7).</p></div><div class="section" title="9. SINGLETON - ONLY INSTANCE ONLY"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_singleton_only_instance_only"></a>9. SINGLETON - ONLY 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 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="10. THE TYPE EXPLORERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_the_type_explorers"></a>10. 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="11. WRITING THE GENCODE SCRIPT"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_writing_the_gencode_script"></a>11. 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.</p><p>The gencode scripts can make use of the parameters, the global explorers
|
|
||||||
and the type specific explorers. The output (stdout) of these script is
|
|
||||||
saved by cdist and will be executed on the target.</p><p>If the gencode scripts encounter 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="12. HINTS FOR TYPEWRITERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_hints_for_typewriters"></a>12. 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 <span class="emphasis"><em>file), you can save them in the subdirectory
|
|
||||||
"files" below $</em></span>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="13. 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>13. 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 submit the git url containing the type 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><p>Ensure a corresponding manpage named man.text in asciidoc format with
|
|
||||||
the manpage-name "cdist-type__NAME" is included in the type directory.</p></div><div class="section" title="14. SEE ALSO"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_see_also"></a>14. SEE ALSO</h2></div></div></div><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
|
||||||
cdist-explorer(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-stages(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-tutorial(7)
|
|
||||||
</li></ul></div></div><div class="section" title="15. COPYING"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_copying"></a>15. 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>
|
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
<?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__addifnosuchline(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__addifnosuchline(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__addifnosuchline(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Daniel</span> <span class="surname">Roth</span></h3><code class="email"><<a class="email" href="mailto:dani-cdist--@--d-roth.li">dani-cdist--@--d-roth.li</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__addifnosuchline - Add a line (if not existing already)</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 can be used to check a file for existence of a
|
|
||||||
specific line and adding it, if it was not found.</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">
|
|
||||||
line
|
|
||||||
</span></dt><dd>
|
|
||||||
Specifies the content which shall be added if not existing.
|
|
||||||
</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>
|
|
||||||
If supplied, use this as the destination file.
|
|
||||||
Otherwise the object_id is used.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
regex
|
|
||||||
</span></dt><dd>
|
|
||||||
If supplied, search for this regex.
|
|
||||||
Otherwise entire line must be matched.
|
|
||||||
</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 or appends the line specifiend in "include_www" to the file "lighttpd.conf"
|
|
||||||
__addifnosuchline www --file /etc/lighttpd.conf --line include_www
|
|
||||||
|
|
||||||
# Adds the line "include_git" to the file "lighttpd.conf"
|
|
||||||
__addifnosuchline /etc/lighttpd.conf --line include_git</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 Daniel Roth. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
<?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="idp25202576"></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 "enabled" or "disabled".
|
|
||||||
</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 --state enabled
|
|
||||||
|
|
||||||
# Disable a ppa repository
|
|
||||||
__apt_ppa ppa:sans-intern/missing-bits --state disabled</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>
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
<?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="idp25202576"></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>
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
<?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__autofs_map(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__autofs_map(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__autofs_map(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="#_object_id">3. OBJECT ID</a></span></dt><dt><span class="section"><a href="#_required_parameters">4. REQUIRED 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__autofs_map - Manage autofs maps</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 maps for autofs.</p></div><div class="section" title="3. OBJECT ID"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_object_id"></a>3. OBJECT ID</h2></div></div></div><p>The object_id is used as the mount-point as described in auto.master(5).</p></div><div class="section" title="4. REQUIRED PARAMETERS"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_required_parameters"></a>4. REQUIRED PARAMETERS</h2></div></div></div><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
map
|
|
||||||
</span></dt><dd>
|
|
||||||
Name of the map to use. See auto.master(5).
|
|
||||||
</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">
|
|
||||||
type
|
|
||||||
</span></dt><dd>
|
|
||||||
Type of map used for this mount point. Defaults to <span class="emphasis"><em>file</em></span>.
|
|
||||||
See map-type in auto.master(5) for possible values.
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
options
|
|
||||||
</span></dt><dd>
|
|
||||||
See auto.master(5).
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
comment
|
|
||||||
</span></dt><dd>
|
|
||||||
A comment describing this map. Is added to the generated entry in
|
|
||||||
auto.master.
|
|
||||||
</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 auto mounter at /net
|
|
||||||
__autofs_map /net --map /etc/auto.net --type program
|
|
||||||
|
|
||||||
# Add auto mounter at /pub
|
|
||||||
__autofs_map /pub --map /etc/auto.pub \
|
|
||||||
--type file --options nosuid,rw,bg,hard,intr --ghost</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">
|
|
||||||
cdist-type(7)
|
|
||||||
</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 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>
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
<?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__autofs_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__autofs_master(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__autofs_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="#_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__autofs_master - Generate the auto.master 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 cdist type generates a auto.master configuration from given <span class="emphasis"><em>autofs_map
|
|
||||||
definitions. See cdist-type</em></span>auto_map(7).</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">
|
|
||||||
header
|
|
||||||
</span></dt><dd>
|
|
||||||
Absolute path to a file used as the header for the generated auto.master
|
|
||||||
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"># auto.master with default header
|
|
||||||
__autofs_master
|
|
||||||
|
|
||||||
# auto.master with custom header
|
|
||||||
__autofs_master --header /path/to/header</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>
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
<?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="idp25202576"></a>cdist-type__cdistmarker(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Daniel Maher <phrawzty+cdist at gmail.com></span></h3></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 --file /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">
|
|
||||||
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 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>
|
|
||||||
|
|
@ -1,44 +0,0 @@
|
||||||
<?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="idp25202576"></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></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 cronjob
|
|
||||||
__cron some-id --user root --command "/path/to/script"
|
|
||||||
|
|
||||||
# remove cronjob
|
|
||||||
__cron some-id --user root --command "/path/to/script" --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">
|
|
||||||
cdist-type(7)
|
|
||||||
</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 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>
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
<?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="idp25202496"></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>
|
|
||||||
If supplied, use the given filename as input for debconf-set-selections(1)
|
|
||||||
</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"</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">
|
|
||||||
cdist-type(7)
|
|
||||||
</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 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>
|
|
||||||
|
|
@ -1,48 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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__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><dt><span class="term">
|
|
||||||
parents
|
|
||||||
</span></dt><dd>
|
|
||||||
Whether to create parents as well (mkdir -p behaviour). Must be yes or no.
|
|
||||||
</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.
|
|
||||||
Must be yes or no.
|
|
||||||
</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"># 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 yes
|
|
||||||
|
|
||||||
# Change permissions recursively
|
|
||||||
__directory /home/services --recursive yes --owner root --group root
|
|
||||||
|
|
||||||
# Setup a temp directory
|
|
||||||
__directory /local --mode 1777</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 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>
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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__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></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><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.
|
|
||||||
</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 /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</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-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>
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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__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">
|
|
||||||
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. 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 a group 'foobar' with operating system default settings
|
|
||||||
__group foobar
|
|
||||||
|
|
||||||
# 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="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>
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
<?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="idp25202576"></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">
|
|
||||||
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 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>
|
|
||||||
|
|
@ -1,40 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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__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></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"># 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 '='
|
|
||||||
|
|
||||||
# Remove existing key/value
|
|
||||||
__key_value LEGACY_KEY --file /etc/somefile --state absent --delimiter '='</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>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
<?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="idp25202576"></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">
|
|
||||||
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-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>
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
<?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__mkfs(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__mkfs(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__mkfs(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__mkfs - build a linux file system</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 is a wrapper for the mkfs command.</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>
|
|
||||||
The filesystem type to use. Same as mkfs -t.
|
|
||||||
</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">
|
|
||||||
device
|
|
||||||
</span></dt><dd>
|
|
||||||
defaults to object_id
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
options
|
|
||||||
</span></dt><dd>
|
|
||||||
file system-specific options to be passed to the mkfs command
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
blocks
|
|
||||||
</span></dt><dd>
|
|
||||||
the number of blocks to be used for the file system
|
|
||||||
</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"># reiserfs /dev/sda5
|
|
||||||
__mkfs /dev/sda5 --type reiserfs
|
|
||||||
# same thing with explicit device
|
|
||||||
__mkfs whatever --device /dev/sda5 --type reiserfs
|
|
||||||
|
|
||||||
# jfs with journal on /dev/sda2
|
|
||||||
__mkfs /dev/sda1 --type jfs --options "-j /dev/sda2"</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><li class="listitem">
|
|
||||||
mkfs(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) 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>
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
<?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="idp25202576"></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">
|
|
||||||
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 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>
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
<?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__user(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__user(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__user(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 dependant 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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
The state the package should be in, either "installed" or "removed"
|
|
||||||
</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 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
|
|
||||||
choosen 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></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 installed
|
|
||||||
|
|
||||||
# Same but install specific version
|
|
||||||
__package vim --state installed --version 7.3.50
|
|
||||||
|
|
||||||
# Force use of a specific package type
|
|
||||||
__package vim --state installed --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">
|
|
||||||
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>
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
<?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="idp25202576"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
If supplied, use the name and not the object id as the package name.
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# In case you only want *a* webserver, but don't care which one
|
|
||||||
__package_apt webserver --state installed --name nginx
|
|
||||||
|
|
||||||
# Remove obsolete package
|
|
||||||
__package_apt puppet --state removed</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
<?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="idp25202576"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
If supplied, use the name and not the object id as the package name.
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# Remove package
|
|
||||||
__package_luarocks luasocket --state removed</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
<?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="idp25202576"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
If supplied, use the name and not the object id as the package name.
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
|
||||||
__package_pacman python --state installed --name python2
|
|
||||||
|
|
||||||
# Remove obsolete package
|
|
||||||
__package_pacman puppet --state removed</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
<?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="idp25202576"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "present" or "absent".
|
|
||||||
</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>
|
|
||||||
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></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</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
<?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="idp25202496"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
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></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 installed
|
|
||||||
|
|
||||||
# Ensure vim is installed, use flavor no_x11
|
|
||||||
__package_pkg_openbsd vim --state installed --flavor no_x11
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
|
||||||
__package_pkg_openbsd python --state installed --name python2
|
|
||||||
|
|
||||||
# Remove obsolete package
|
|
||||||
__package_pkg_openbsd puppet --state removed</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
<?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="idp25202576"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
If supplied, use the name and not the object id as the package name.
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# Remove package
|
|
||||||
__package_rubygem rails --state removed</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
<?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="idp25202576"></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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
state
|
|
||||||
</span></dt><dd>
|
|
||||||
Either "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
If supplied, use the name and not the object id as the package name.
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# If you don't want to follow pythonX packages, but always use python
|
|
||||||
__package_yum python --state installed --name python2
|
|
||||||
|
|
||||||
# Remove obsolete package
|
|
||||||
__package_yum puppet --state removed</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><li class="listitem">
|
|
||||||
cdist-type__package(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 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>
|
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
<?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__partition_msdos(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__partition_msdos(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__partition_msdos(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__partition_msdos - creates msdos partitions</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 msdos paritions.</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>
|
|
||||||
the partition type used in fdisk (such as 82 or 83) or "extended"
|
|
||||||
</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">
|
|
||||||
partition
|
|
||||||
</span></dt><dd>
|
|
||||||
defaults to object_id
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
bootable
|
|
||||||
</span></dt><dd>
|
|
||||||
mark partition as bootable, true or false, defaults to false
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
size
|
|
||||||
</span></dt><dd>
|
|
||||||
the size of the partition (such as 32M or 15G, whole numbers
|
|
||||||
only), <span class="emphasis"><em>+</em></span> for remaining space, or <span class="emphasis"><em>n%</em></span> for percentage of remaining
|
|
||||||
(these should only be used after all specific partition sizes are
|
|
||||||
specified). Defaults 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"># 128MB, linux, bootable
|
|
||||||
__partition_msdos /dev/sda1 --type 83 --size 128M --bootable true
|
|
||||||
# 512MB, swap
|
|
||||||
__partition_msdos /dev/sda2 --type 82 --size 512M
|
|
||||||
# 100GB, extended
|
|
||||||
__partition_msdos /dev/sda3 --type extended --size 100G
|
|
||||||
# 10GB, linux
|
|
||||||
__partition_msdos /dev/sda5 --type 83 --size 10G
|
|
||||||
# 50% of the free space of the extended partition, linux
|
|
||||||
__partition_msdos /dev/sda6 --type 83 --size 50%
|
|
||||||
# rest of the extended partition, linux
|
|
||||||
__partition_msdos /dev/sda7 --type 83 --size +</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>
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
<?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__partition_msdos_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__partition_msdos_apply(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202496"></a>cdist-type__partition_msdos_apply(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__partition_msdos_apply - Apply dos partition settings</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>Create the partitions defined with __partition_msdos</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">__partition_msdos_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">
|
|
||||||
cdist-type(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__partition_msdos_apply(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>
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
<?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="idp25202496"></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="#_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__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. 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 <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</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><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
owner
|
|
||||||
</span></dt><dd>
|
|
||||||
the role owning this 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">__postgres_database mydbname --state present --owner mydbusername</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>
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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="#_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. 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 <span class="emphasis"><em>present</em></span> or <span class="emphasis"><em>absent</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>All optional parameter map directly to the corresponding postgres createrole
|
|
||||||
parameters.</p><div class="variablelist"><dl><dt><span class="term">
|
|
||||||
password
|
|
||||||
, </span><span class="term">
|
|
||||||
login
|
|
||||||
, </span><span class="term">
|
|
||||||
createdb
|
|
||||||
, </span><span class="term">
|
|
||||||
createrole
|
|
||||||
, </span><span class="term">
|
|
||||||
superuser
|
|
||||||
, </span><span class="term">
|
|
||||||
inherit
|
|
||||||
</span></dt><dd>
|
|
||||||
EXAMPLES
|
|
||||||
</dd></dl></div><pre class="screen"></pre><p>__postgres_role myrole --state present</p><p>__postgres_role myrole --state present --password <span class="emphasis"><em>secret</em></span></p><p>__postgres_role admin --state present --password <span class="emphasis"><em>very-secret</em></span> --superuser true</p><p>__postgres_role dbcustomer --state present --password <span class="emphasis"><em>bla</em></span> --createdb true</p><pre class="screen">SEE ALSO</pre><div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
|
|
||||||
cdist-type(7)
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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__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. 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>
|
|
||||||
State of the process: Either stopped or running.
|
|
||||||
</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><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="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"># Start if not running
|
|
||||||
__process /usr/sbin/syslog-ng --state running
|
|
||||||
|
|
||||||
# Start if not running with a different binary
|
|
||||||
__process /usr/sbin/nginx --state running --start "/etc/rc.d/nginx start"
|
|
||||||
|
|
||||||
# Stop the process using kill (the type default) - DO NOT USE THIS
|
|
||||||
__process /usr/sbin/sshd --state stopped
|
|
||||||
|
|
||||||
# Stop the process using /etc/rc.d/sshd stop - THIS ONE NOT AS WELL
|
|
||||||
__process /usr/sbin/sshd --state stopped --stop "/etc/rc.d/sshd stop"
|
|
||||||
|
|
||||||
# Ensure cups is running, which runs with -C ...:
|
|
||||||
__process cups --start "/etc/rc.d/cups start" --state running \
|
|
||||||
--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 running --start "/etc/init.d/statd start" \
|
|
||||||
--name "rpc.statd.*"</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 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>
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
<?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__removeline(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__removeline(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__removeline(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Daniel</span> <span class="surname">Roth</span></h3><code class="email"><<a class="email" href="mailto:dani-cdist--@--d-roth.li">dani-cdist--@--d-roth.li</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__removeline - Remove a line (if existing)</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 can be used to check a file for existence of a
|
|
||||||
specific line and removeing it, if it was found.</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">
|
|
||||||
line
|
|
||||||
</span></dt><dd>
|
|
||||||
Specifies the content which shall be removed if existing.
|
|
||||||
</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>
|
|
||||||
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"># Removes the line specifiend in "include_www" from the file "lighttpd.conf"
|
|
||||||
__removeline www --file /etc/lighttpd.conf --line include_www
|
|
||||||
|
|
||||||
# Removes the line "include_git" from the file "lighttpd.conf"
|
|
||||||
__removeline /etc/lighttpd.conf --line include_git</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 Daniel Roth. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
<?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="idp25202576"></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 "installed" or "removed".
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# Remove rvm
|
|
||||||
__rvm billie --state removed</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">
|
|
||||||
cdist-type(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_ruby(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_gemset(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_gem(7)
|
|
||||||
</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>
|
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
<?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="idp25202576"></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 "installed" or "removed".
|
|
||||||
</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 installed
|
|
||||||
|
|
||||||
# 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 installed --default yes
|
|
||||||
|
|
||||||
# Remove it
|
|
||||||
__rvm_ruby rails --gemset ruby-1.9.3-p0@myset --user bill --state removed</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><li class="listitem">
|
|
||||||
cdist-type__rvm(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_ruby(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_gemset(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 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>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
<?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="idp25202576"></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_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 "installed" or "removed".
|
|
||||||
</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>
|
|
||||||
If set to anything but "no" (the default), 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 installed
|
|
||||||
|
|
||||||
# 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 installed --default yes
|
|
||||||
|
|
||||||
# Remove the gemset @myset for user john
|
|
||||||
__rvm_ruby ruby-1.9.3-p0@myset --user john --state removed</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><li class="listitem">
|
|
||||||
cdist-type__rvm(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_ruby(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_gem(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 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>
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
<?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="idp25202576"></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="#_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_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 "installed" or "removed".
|
|
||||||
</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>default:
|
|
||||||
If set to anything but "no" (the 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 installed
|
|
||||||
|
|
||||||
# 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 installed --default yes
|
|
||||||
|
|
||||||
# Remove ruby 1.9.3 for user john
|
|
||||||
__rvm_ruby ruby-1.9.3-p0 --user john --state removed</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><li class="listitem">
|
|
||||||
cdist-type__rvm(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_gemset(7)
|
|
||||||
</li><li class="listitem">
|
|
||||||
cdist-type__rvm_gem(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 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>
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
<?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="idp25202496"></a>cdist-type__ssh_authorized_key(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Aurélien Bondis - aurelien.bondis AT gmail DOT com</span></h3></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 - Sends a user’s public key to another user’s authorized_keys</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 sends a rsa key. By default uses root’s key and sends it to root’s authorized_keys</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">
|
|
||||||
srcuser
|
|
||||||
</span></dt><dd>
|
|
||||||
the user to take the rsa public key from
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
dstuser
|
|
||||||
</span></dt><dd>
|
|
||||||
the user to give the rsa public key 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">#deploy root's public key
|
|
||||||
__ssh_authorized_key admin
|
|
||||||
#deploy bob's public key to alice's authorized_keys
|
|
||||||
__ssh_authorized_key --srcuser bob --dstuser alice</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>Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
<?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__timezone(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__timezone(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__timezone(7)</h2></div><div><div class="author"><h3 class="author"><span class="firstname">Ramon Salvadó - rsalvado at gnuine dot com</span></h3></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__timezone - Allows to configure the desired localtime timezone.</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 creates a symlink (/etc/localtime) to the selected timezone
|
|
||||||
(which should be available in /usr/share/zoneinfo).</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">#Set up Europe/Andorra as our timezone.
|
|
||||||
__timezone Europe/Andorra
|
|
||||||
|
|
||||||
#Set up US/Central as our timezone.
|
|
||||||
__timezone US/Central</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>Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).</p></div></div></body></html>
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
<?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__user(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__user(7)" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idp25202576"></a>cdist-type__user(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__user - Manage users</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 users 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">
|
|
||||||
comment
|
|
||||||
</span></dt><dd>
|
|
||||||
see usermod(8)
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
home
|
|
||||||
</span></dt><dd>
|
|
||||||
see above
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
gid
|
|
||||||
</span></dt><dd>
|
|
||||||
see above
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
groups
|
|
||||||
</span></dt><dd>
|
|
||||||
see above
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
password
|
|
||||||
</span></dt><dd>
|
|
||||||
see above
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
shell
|
|
||||||
</span></dt><dd>
|
|
||||||
see above
|
|
||||||
</dd><dt><span class="term">
|
|
||||||
uid
|
|
||||||
</span></dt><dd>
|
|
||||||
see above
|
|
||||||
</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 user account for foobar with operating system default settings
|
|
||||||
__user foobar
|
|
||||||
|
|
||||||
# Same but with a different shell
|
|
||||||
__user foobar --shell /bin/zsh
|
|
||||||
|
|
||||||
# Set explicit uid and home
|
|
||||||
__user foobar --uid 1001 --shell /bin/zsh --home /home/foobar</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>
|
|
||||||
Loading…
Reference in a new issue