forked from ungleich-public/cdist
finish first version of cdist-reference
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius
parent
1048c42c6d
commit
ef761b73df
3 changed files with 132 additions and 191 deletions
1
Makefile
1
Makefile
|
|
@ -22,6 +22,7 @@ MANSRC=$(MANDIR)/cdist.text \
|
||||||
$(MANDIR)/cdist-bin-transfer.text \
|
$(MANDIR)/cdist-bin-transfer.text \
|
||||||
$(MANDIR)/cdist-deploy-to.text \
|
$(MANDIR)/cdist-deploy-to.text \
|
||||||
$(MANDIR)/cdist-manifest.text \
|
$(MANDIR)/cdist-manifest.text \
|
||||||
|
$(MANDIR)/cdist-reference.text \
|
||||||
$(MANDIR)/cdist-stages.text \
|
$(MANDIR)/cdist-stages.text \
|
||||||
$(MANDIR)/cdist-type.text \
|
$(MANDIR)/cdist-type.text \
|
||||||
$(MANDIR)/cdist-type-template.text \
|
$(MANDIR)/cdist-type-template.text \
|
||||||
|
|
|
||||||
131
doc/man/cdist-reference.text
Normal file
131
doc/man/cdist-reference.text
Normal file
|
|
@ -0,0 +1,131 @@
|
||||||
|
cdist-reference(7)
|
||||||
|
==================
|
||||||
|
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||||
|
|
||||||
|
NAME
|
||||||
|
----
|
||||||
|
cdist-reference - Variable, path and type reference
|
||||||
|
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
-----------
|
||||||
|
Various scripts which are not in the core need information on how
|
||||||
|
to find information. This manpage summarises the available environment
|
||||||
|
variables and paths and clearifies with part may access with variables.
|
||||||
|
|
||||||
|
|
||||||
|
PATHS
|
||||||
|
-----
|
||||||
|
If not specified otherwise, all paths are relative to the checkout directory.
|
||||||
|
|
||||||
|
conf/::
|
||||||
|
Contains the (static) configuration like manifests, types and explorers.
|
||||||
|
|
||||||
|
conf/manifest/init::
|
||||||
|
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.
|
||||||
|
|
||||||
|
conf/manifest/*::
|
||||||
|
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 very helpful to have different admins
|
||||||
|
maintain different groups of hosts.
|
||||||
|
|
||||||
|
conf/explorer/<name>:
|
||||||
|
Contains explorers to be run on the target hosts, see cdist-explorer(7).
|
||||||
|
|
||||||
|
conf/type/:
|
||||||
|
Contains all available types, which are used to provide
|
||||||
|
some kind of functionality. See cdist-type(7).
|
||||||
|
|
||||||
|
conf/type/<name>/::
|
||||||
|
Home of the type <name>.
|
||||||
|
|
||||||
|
This directory is referenced by the variable __type (see below).
|
||||||
|
|
||||||
|
conf/type/<name>/manifest::
|
||||||
|
Used to generate additional objects from a type.
|
||||||
|
|
||||||
|
conf/type/<name>/gencode::
|
||||||
|
Used to generate code to be executed on the client.
|
||||||
|
|
||||||
|
conf/type/<name>/parameters/required::
|
||||||
|
Parameters required by type, \n seperated list.
|
||||||
|
|
||||||
|
conf/type/<name>/parameters/optional::
|
||||||
|
Parameters optionally accepted by type, \n seperated list.
|
||||||
|
|
||||||
|
conf/type/<name>/explorer::
|
||||||
|
Location of the type specific explorers.
|
||||||
|
|
||||||
|
This directory is referenced by the variable __type_explorer (see below).
|
||||||
|
|
||||||
|
See cdist-explorer(7).
|
||||||
|
|
||||||
|
out/:
|
||||||
|
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).
|
||||||
|
|
||||||
|
out/explorer::
|
||||||
|
Output of general explorers.
|
||||||
|
|
||||||
|
out/object::
|
||||||
|
Objects created for the host.
|
||||||
|
|
||||||
|
out/object/<object>::
|
||||||
|
Contains all object specific information.
|
||||||
|
|
||||||
|
This directory is referenced by the variable __object (see below).
|
||||||
|
|
||||||
|
out/object/<object>/explorers::
|
||||||
|
Output of type specific explorers, per object.
|
||||||
|
|
||||||
|
tmp_dir: Temporary storage:
|
||||||
|
A tempdir and a tempfile is used by cdist internally,
|
||||||
|
which will be removed when the scripts end automatically.
|
||||||
|
See cdist-config(1).
|
||||||
|
|
||||||
|
|
||||||
|
VARIABLES
|
||||||
|
---------
|
||||||
|
__explorer::
|
||||||
|
Directory that contains all explorers
|
||||||
|
Available for: explorer
|
||||||
|
__manifest::
|
||||||
|
Directory that contains the initial manifest
|
||||||
|
Available for: initial manifest
|
||||||
|
__global::
|
||||||
|
Directory that contains generic output like explorer
|
||||||
|
Available for: initial manifest, type manifest, type explorer, type codegen
|
||||||
|
__object::
|
||||||
|
Directory that contains the current object
|
||||||
|
Available for: type manifest, type explorer, type codegen
|
||||||
|
__object_id::
|
||||||
|
The type unique object id
|
||||||
|
Available for: type manifest, type explorer, type codegen
|
||||||
|
__target_host::
|
||||||
|
The host we are deploying to.
|
||||||
|
Available for: initial manifest, type manifest, type codegen
|
||||||
|
__type::
|
||||||
|
Path to the current type
|
||||||
|
Available for: type manifest
|
||||||
|
__type_explorers::
|
||||||
|
Directory that contains the type explorers
|
||||||
|
Available for: type explorer
|
||||||
|
|
||||||
|
|
||||||
|
SEE ALSO
|
||||||
|
--------
|
||||||
|
- cdist(7)
|
||||||
|
|
||||||
|
|
||||||
|
COPYING
|
||||||
|
-------
|
||||||
|
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
||||||
|
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||||
|
|
@ -1,191 +0,0 @@
|
||||||
cdist-reference(7)
|
|
||||||
==================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-reference - Variables, paths and types offered by cdist
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
Various scripts which are not in the core need information on how
|
|
||||||
to find information. This manpage summarises the available environment
|
|
||||||
variables and clearifies with part may access with variables.
|
|
||||||
|
|
||||||
PATHS
|
|
||||||
-----
|
|
||||||
|
|
||||||
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
cdist-config-layout(7)
|
|
||||||
======================
|
|
||||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
|
||||||
|
|
||||||
|
|
||||||
NAME
|
|
||||||
----
|
|
||||||
cdist-config-layout - Usage of paths in cdist
|
|
||||||
|
|
||||||
|
|
||||||
DESCRIPTION
|
|
||||||
-----------
|
|
||||||
If not specified otherwise, all paths are relative to the configuration
|
|
||||||
directory, which is normally /etc/cdist (but can be changed using environment
|
|
||||||
variables, see cdist-environment(7)).
|
|
||||||
|
|
||||||
- conf_dir/:
|
|
||||||
Contains the (static) configuration like manifests, types and
|
|
||||||
explorers.
|
|
||||||
|
|
||||||
- conf_dir/manifest/init:
|
|
||||||
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.
|
|
||||||
|
|
||||||
- conf_dir/manifest/*:
|
|
||||||
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 very helpful to have different admins
|
|
||||||
maintain different groups of hosts.
|
|
||||||
|
|
||||||
- conf_dir/explorer/<name>
|
|
||||||
Contains explorers to be run on the target hosts, see cdist-explorers(7).
|
|
||||||
|
|
||||||
- conf_dir/type/
|
|
||||||
Contains all available types, which are used to provide
|
|
||||||
some kind of functionality. See cdist-stages(7).
|
|
||||||
|
|
||||||
- conf_dir/type/<name>/manifest:
|
|
||||||
Used to generate additional objects from a type.
|
|
||||||
See cdist-stages(7), cdist-types(7).
|
|
||||||
|
|
||||||
- conf_dir/type/<name>/gencode:
|
|
||||||
Used to generate code to be executed on the client.
|
|
||||||
See cdist-types(7).
|
|
||||||
|
|
||||||
- conf_dir/type/<name>/parameters/required:
|
|
||||||
Parameters required by type, \n seperated list.
|
|
||||||
See cdist-types(7).
|
|
||||||
|
|
||||||
- conf_dir/type/<name>/parameters/optional:
|
|
||||||
Parameters optionally accepted by type, \n seperated list.
|
|
||||||
See cdist-types(7).
|
|
||||||
|
|
||||||
- conf_dir/type/<name>/explorer:
|
|
||||||
Location of the type specific explorers.
|
|
||||||
See cdist-explorers(7).
|
|
||||||
|
|
||||||
- out_dir/
|
|
||||||
This directory contains output of cdist and is mirrored into the
|
|
||||||
cache after a successful run. This directory may be placed below
|
|
||||||
the tmpdir or at any other location and is also available on the
|
|
||||||
target.
|
|
||||||
|
|
||||||
- out_dir/explorer:
|
|
||||||
Output of general explorers.
|
|
||||||
|
|
||||||
- out_dir/object:
|
|
||||||
Objects created for the host.
|
|
||||||
|
|
||||||
- out_dir/object/<object>/explorers:
|
|
||||||
Output of type specific explorers, per object.
|
|
||||||
|
|
||||||
- tmp_dir: Temporary storage
|
|
||||||
A tempdir and a tempfile is provided by cdist-config(1), which
|
|
||||||
will be removed when the scripts ends automatically.
|
|
||||||
|
|
||||||
|
|
||||||
FUTURE
|
|
||||||
------
|
|
||||||
The following functionality may be implemented in one of the next releases:
|
|
||||||
|
|
||||||
- cache_dir/
|
|
||||||
The cache contains the out_dir from previous runs, which
|
|
||||||
may also be used in types to gather information about other hosts
|
|
||||||
(like ssh-keys).
|
|
||||||
|
|
||||||
- cache_dir/host/<name>:
|
|
||||||
Contains the last out_dir of the specific host.
|
|
||||||
|
|
||||||
|
|
||||||
AUTHOR
|
|
||||||
------
|
|
||||||
Nico Schottelius <mailto:nico-cdist--@--schottelius.org[]>
|
|
||||||
|
|
||||||
|
|
||||||
RESOURCES
|
|
||||||
---------
|
|
||||||
Main web site: http://www.nico.schottelius.org/cdist/[]
|
|
||||||
|
|
||||||
|
|
||||||
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).
|
|
||||||
--------------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
VARIABLES
|
|
||||||
---------
|
|
||||||
__explorer::
|
|
||||||
Directory that contains all explorers
|
|
||||||
__manifest::
|
|
||||||
Directory that contains the initial manifest
|
|
||||||
__global::
|
|
||||||
Directory that contains generic output like explorer
|
|
||||||
__object::
|
|
||||||
Directory that contains the current object
|
|
||||||
__object_id::
|
|
||||||
The type unique object id
|
|
||||||
__type_explorers::
|
|
||||||
Directory that contains the type explorers
|
|
||||||
|
|
||||||
|
|
||||||
EXPLORER
|
|
||||||
--------
|
|
||||||
- __explorer
|
|
||||||
|
|
||||||
|
|
||||||
INITIAL MANIFEST
|
|
||||||
----------------
|
|
||||||
- __manifest
|
|
||||||
- __global
|
|
||||||
|
|
||||||
|
|
||||||
TYPE MANIFEST
|
|
||||||
-------------
|
|
||||||
- __object
|
|
||||||
- __object_id
|
|
||||||
- __global
|
|
||||||
|
|
||||||
|
|
||||||
TYPE EXPLORER
|
|
||||||
-------------
|
|
||||||
- __object
|
|
||||||
- __object_id
|
|
||||||
- __type_explorers
|
|
||||||
- __global
|
|
||||||
|
|
||||||
|
|
||||||
TYPE CODEGEN
|
|
||||||
------------
|
|
||||||
- __object
|
|
||||||
- __object_id
|
|
||||||
- __global
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
SEE ALSO
|
|
||||||
--------
|
|
||||||
- cdist(7)
|
|
||||||
|
|
||||||
|
|
||||||
COPYING
|
|
||||||
-------
|
|
||||||
Copyright \(C) 2011 Nico Schottelius. Free use of this software is
|
|
||||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue