tom/cdist
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update confdir paths

Browse source 
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
This commit is contained in:
Nico Schottelius 2012-12-09 14:41:50 -08:00
commit dd9083327d
5 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/man/cdist-reference.text.sh
View file

@ -59,7 +59,7 @@ cat << eof
PATHS
-----
$HOME/.cdist::
\$HOME/.cdist::
The standard cdist configuration directory relative to your home directory
This is usually the place you want to store your site specific configuration
@ -72,7 +72,7 @@ confdir::
a temporary confdir containing links to the real configuration directories.
This way it is possible to merge configuration directories.
By default it consists of everything in $HOME/.cdist and cdist/conf/.
By default it consists of everything in \$HOME/.cdist and cdist/conf/.
For more details see cdist(1)

2
docs/man/man1/cdist.text
View file

@ -78,7 +78,7 @@ EXAMPLES
# Configure ikq05.ethz.ch with debug enabled
cdist config -d ikq05.ethz.ch
# Configure hosts in parallel and use a different home directory
# Configure hosts in parallel and use a different configuration directory
cdist config -c ~/p/cdist-nutzung \
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch

2
docs/man/man7/cdist-hacker.text
View file

@ -44,7 +44,7 @@ work nor kill the authors brain:
- All files should contain the usual header (Author, Copying, etc.)
- Code submission must be done via git
- Do not add conf/manifest/init - This file should only be touched in your
- Do not add cdist/conf/manifest/init - This file should only be touched in your
private branch!
- Code to be included should be branched of the upstream "master" branch
- Exception: Bugfixes to a version branch

8
docs/man/man7/cdist-manifest.text
View file

@ -16,8 +16,8 @@ An object is represented by the combination of
**type + slash + object name**: **__file/etc/cdist-configured** is an
object of the type ***__file*** with the name ***etc/cdist-configured***.
All available types can be found in the **conf/type/** directory,
use **ls conf/type** to get the list of available types. If you have
All available types can be found in the **cdist/conf/type/** directory,
use **ls cdist/conf/type** to get the list of available types. If you have
setup the MANPATH correctly, you can use **man cdist-reference** to access
the reference with pointers to the manpages.
@ -57,7 +57,7 @@ DEFINE STATE IN THE INITIAL MANIFEST
------------------------------------
The **initial manifest** is the entry point for cdist to find out, which
**objects** to configure on the selected host.
Cdist searches for the initial manifest at **conf/manifest/init**.
Cdist searches for the initial manifest at **cdist/conf/manifest/init**.
Within this initial manifest, you define, which objects should be
created on which host. To distinguish between hosts, you can use the
@ -88,7 +88,7 @@ command.
SPLITTING UP THE INITIAL MANIFEST
---------------------------------
If you want to split up your initial manifest, you can create other shell
scripts in **conf/manifest/** and include them in **conf/manifest/init**.
scripts in **cdist/conf/manifest/** and include them in **cdist/conf/manifest/init**.
Cdist provides the environment variable ***__manifest*** to reference to
the directory containing the initial manifest (see cdist-reference(7)).

18
docs/man/man7/cdist-type.text
View file

@ -64,10 +64,10 @@ A type consists of
- explorer (optional)
- gencode (optional)
Types are stored below conf/type/. Their name should always be prefixed with
Types are stored below cdist/conf/type/. Their name should always be prefixed with
two underscores (__) to prevent collisions with other executables in $PATH.
To begin a new type, just create the directory **conf/type/__NAME**.
To begin a new type, just create the directory **cdist/conf/type/__NAME**.
DEFINING PARAMETERS
@ -84,10 +84,10 @@ or no parameters at all.
Example:
--------------------------------------------------------------------------------
echo servername >> conf/type/__nginx_vhost/parameter/required
echo logdirectory >> conf/type/__nginx_vhost/parameter/optional
echo server_alias >> conf/type/__nginx_vhost/parameter/optional_multiple
echo use_ssl >> conf/type/__nginx_vhost/parameter/boolean
echo servername >> cdist/conf/type/__nginx_vhost/parameter/required
echo logdirectory >> cdist/conf/type/__nginx_vhost/parameter/optional
echo server_alias >> cdist/conf/type/__nginx_vhost/parameter/optional_multiple
echo use_ssl >> cdist/conf/type/__nginx_vhost/parameter/boolean
--------------------------------------------------------------------------------
@ -98,7 +98,7 @@ The parameters given to a type can be accessed and used in all type scripts
represented by file existence. File exists -> True,
file does not exist -> False
Example: (e.g. in conf/type/__nginx_vhost/manifest)
Example: (e.g. in cdist/conf/type/__nginx_vhost/manifest)
--------------------------------------------------------------------------------
# required parameter
servername="$(cat "$__object/parameter/servername")"
@ -129,7 +129,7 @@ INPUT FROM STDIN
Every type can access what has been written on stdin when it has been called.
The result is saved into the ***stdin*** file in the object directory.
Example use of a type: (e.g. in conf/type/__archlinux_hostname)
Example use of a type: (e.g. in cdist/conf/type/__archlinux_hostname)
--------------------------------------------------------------------------------
__file /etc/rc.conf --source - << eof
...
@ -186,7 +186,7 @@ mark it as a singleton: Just create the (empty) file "singleton" in your type
directory:
--------------------------------------------------------------------------------
touch conf/type/__NAME/singleton
touch cdist/conf/type/__NAME/singleton
--------------------------------------------------------------------------------
This will also change the way your type must be called: