finish manpage cdist-explorer
Signed-off-by: Nico Schottelius <nico@kr.ethz.ch>
This commit is contained in:
Nico Schottelius
parent
a8c5f225b2
commit
19d3b52d73
4 changed files with 68 additions and 45 deletions
2
Makefile
2
Makefile
|
|
@ -12,7 +12,6 @@ MANDIR=doc/man
|
|||
# Unchecked
|
||||
MANSRC=$(MANDIR)/cdist-config-layout.text \
|
||||
$(MANDIR)/cdist-config.text \
|
||||
$(MANDIR)/cdist-explorer.text \
|
||||
$(MANDIR)/cdist-quickstart.text \
|
||||
$(MANDIR)/cdist-stages.text \
|
||||
$(MANDIR)/cdist-terms.text \
|
||||
|
|
@ -23,6 +22,7 @@ MANGENERATED=$(MANDIR)/cdist-reference.text
|
|||
MANSRC=$(MANDIR)/cdist.text \
|
||||
$(MANDIR)/cdist-bin-transfer.text \
|
||||
$(MANDIR)/cdist-deploy-to.text \
|
||||
$(MANDIR)/cdist-explorer.text \
|
||||
$(MANDIR)/cdist-manifest.text \
|
||||
$(MANDIR)/cdist-stages.text \
|
||||
$(MANDIR)/cdist-type.text \
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
1.0.2: upcoming
|
||||
* Add manpages: cdist-type, cdist-type__file, cdist-reference
|
||||
* Add manpages: cdist-type, cdist-type__file, cdist-reference, cdist-explorer
|
||||
* Make doc/man/ usable as MANPATH entry
|
||||
|
||||
1.0.1: 2011-03-08
|
||||
|
|
|
|||
66
doc/man/cdist-explorer.text
Normal file
66
doc/man/cdist-explorer.text
Normal file
|
|
@ -0,0 +1,66 @@
|
|||
cdist-explorer(7)
|
||||
=================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-explorer - Explore the target systems
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
Explorers can reuse other explorers on the target system by calling
|
||||
$__explorer/<explorer_name> (general and type explorer) or
|
||||
$__type_explorer/<explorer name> (type explorer).
|
||||
|
||||
In case of significant errors, the explorer may exit non-zero and return an
|
||||
error message on stderr, which will cause the cdist run to abort.
|
||||
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
A very simple explorer may look like this:
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
hostname
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
Which is in practise the "hostname" explorer.
|
||||
|
||||
A type explorer, which could check for the status of a package may look like this:
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
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
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
- cdist(7)
|
||||
- cdist-reference(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,43 +0,0 @@
|
|||
cdist-explorer(7)
|
||||
=================
|
||||
Nico Schottelius <nico-cdist--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
cdist-explorer - Explore the target systems
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
Cdist 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.
|
||||
The explorer output the result of its investigation
|
||||
to stdout and should be a one-liner. The output may be empty,
|
||||
though.
|
||||
|
||||
Cdist knows about general explorers, which are run in an early
|
||||
stage and type specific explorers. Both work 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 types.
|
||||
|
||||
Explorers can reuse other explorers on the target system
|
||||
by calling ./<explorer_name> (i.e. explorers are run
|
||||
from their location).
|
||||
|
||||
In case of significant errors, the shell script may exit
|
||||
non-zero and return an error message on stderr, which
|
||||
will cause the cdist run to abort.
|
||||
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
cdist(7), 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).
|
||||
Loading…
Reference in a new issue