finish cdist-manifest.text
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
parent
c5eadb8e5b
commit
a07aafdc88
5 changed files with 103 additions and 91 deletions
8
Makefile
8
Makefile
|
@ -10,15 +10,17 @@ WEBPAGE=software/cdist.mdwn
|
|||
|
||||
MANSRC=doc/man/cdist-config-layout.text \
|
||||
doc/man/cdist-config.text \
|
||||
doc/man/cdist-deploy-to.text \
|
||||
doc/man/cdist-explorer.text \
|
||||
doc/man/cdist-manifest.text \
|
||||
doc/man/cdist-quickstart.text \
|
||||
doc/man/cdist-stages.text \
|
||||
doc/man/cdist-terms.text \
|
||||
doc/man/cdist.text \
|
||||
doc/man/cdist-type.text
|
||||
|
||||
MANSRC=doc/man/cdist.text \
|
||||
doc/man/cdist-deploy-to.text \
|
||||
doc/man/cdist-manifest.text \
|
||||
|
||||
|
||||
################################################################################
|
||||
# User targets
|
||||
#
|
||||
|
|
42
doc/man/cdist-deploy-to.text
Normal file
42
doc/man/cdist-deploy-to.text
Normal file
|
@ -0,0 +1,42 @@
|
|||
cdist-deploy-to(1)
|
||||
==================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-deploy-to - Deploy configuration to host
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-deploy-to HOSTNAME
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Deploy configurations to the specified host, as configured in the initial
|
||||
manifest. This script triggers the execution of several other scripts, in so
|
||||
called stages. It is intented to run either from the command line or from cron.
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
If the environment variable **__cdist_conf_dir** is not set, the
|
||||
configuration is read from /etc/cdist. The local output directory can
|
||||
be changed by the variable **__cdist_local_base_dir**. All environment
|
||||
variables are handled by cdist-config.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist(7),
|
||||
cdist-config(1),
|
||||
cdist-config-layout(7),
|
||||
cdist-stages(7)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
56
doc/man/cdist-manifest.text
Normal file
56
doc/man/cdist-manifest.text
Normal file
|
@ -0,0 +1,56 @@
|
|||
cdist-manifest(7)
|
||||
=================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-manifest - Define types to be used
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Manifests exist to define which configurations should be applied to a specific
|
||||
host as well as to define which configurations should be applied within a
|
||||
type. Manifests are executed locally and the resulting objects are stored in
|
||||
an internal database.
|
||||
|
||||
In general, manifests are used to define which types are used depending
|
||||
on given conditions
|
||||
|
||||
EXAMPLE
|
||||
-------
|
||||
The initial manifest may for instance contain the following code:
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# 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
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
The manifest of the type "nologin" may look like this:
|
||||
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
__file /etc/nologin --type file --source "$__type/files/default.nologin"
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist-manifest-run(1),
|
||||
cdist-manifest-run-all(1),
|
||||
cdist-manifest-run-init(1)
|
||||
cdist-type(7)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
@ -1,37 +0,0 @@
|
|||
cdist-deploy-to(1)
|
||||
==================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-deploy-to - Deploy configuration to host
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
cdist-deploy-to HOSTNAME
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Cdist-deploy-to deploys the configuration to the specified host.
|
||||
It triggers the execution of several other scripts, which are
|
||||
explained (or referenced) in cdist-stages(7).
|
||||
It is intented to run either from the command line or from cron.
|
||||
|
||||
|
||||
REQUIREMENTS
|
||||
------------
|
||||
Cdist-deploy-to requires an enabled ssh-server and a posix shell on the target
|
||||
host and a ssh-client and posix shell on the server.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist(7), cdist-stages(7)
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
@ -1,51 +0,0 @@
|
|||
cdist-manifests(7)
|
||||
==================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-manifests - Map configuration to hosts
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Using the available types and shell language, you can create mappings of what
|
||||
should be configured on a host.
|
||||
|
||||
ENTRYPOINT: $prefix/manifests/init
|
||||
|
||||
unsorted: cache / objects
|
||||
|
||||
- If cdist encounters type in manifest,
|
||||
a wrapper script is run, that creates a
|
||||
new entry in the cconfig database and adds
|
||||
attribute values. This defines a cconfig
|
||||
tree, that may look as follows:
|
||||
|
||||
|
||||
<hostname>/<type>/<id>/<parameters>:
|
||||
|
||||
myhost/__file/cdist_bin/source
|
||||
myhost/__file/cdist_bin/destination
|
||||
...
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
ENVIRONMENT
|
||||
-----------
|
||||
The following variables are available in manifests:
|
||||
|
||||
- __{explorer|fact}_{name}
|
||||
- __core_hostname: Hostname that we are deploying to
|
||||
- __core_localhostname: Hostname that we are deploying from
|
||||
|
||||
EXAPMLES
|
||||
--------
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
Loading…
Reference in a new issue