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

update stages man page to reflect new situation

Browse source 
Signed-off-by: Steven Armstrong <steven@icarus.ethz.ch>
This commit is contained in:
Steven Armstrong 2011-03-29 16:11:38 +02:00
parent 7ff2400830
commit 7c920231b7
1 changed files with 41 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
doc/man/cdist-stages.text
View file

@ -1,6 +1,7 @@
cdist-stages(7) cdist-stages(7)
=============== ===============
Nico Schottelius <nico-cdist--@--schottelius.org> Nico Schottelius <nico-cdist--@--schottelius.org>
Steven Armstrong <steven-dist--@--armstrong.cc>
NAME NAME
@ -12,8 +13,8 @@ DESCRIPTION
----------- -----------
Starting the execution of deployment with cdist-deploy-to(1), cdist passes Starting the execution of deployment with cdist-deploy-to(1), cdist passes
through different stages, each can be triggered and debugged on its own. through different stages, each can be triggered and debugged on its own.
Reading the source of the cdist-deploy-to executable shous the scripts Reading the source of the cdist-deploy-to and cdist-object-run-all executables
responsible for each stage. shows the scripts responsible for each stage.
STAGE 0: INTERNAL PREPERATION STAGE 0: INTERNAL PREPERATION
@ -23,7 +24,7 @@ to contain cdist binaries and creates a clean environment for the
configuration run. configuration run.
Related manpages: Related manpages:
- cdist-bin-transfer(1) - cdist-bin-transfer(1) FIXME: does not exist
STAGE 1: TARGET INFORMATION RETRIEVAL STAGE 1: TARGET INFORMATION RETRIEVAL
@ -34,6 +35,8 @@ explorers are copied back into the local cache. The results can be used by
manifests and types. manifests and types.
Related manpages: Related manpages:
- cdist-explorer-run-global(1)
- cdist-remote-explorer-run(1)
- cdist-explorer(7) - cdist-explorer(7)
@ -46,16 +49,27 @@ no conflicts may occur, i.e. no object of the same type with the same id may
be created. be created.
Related manpages: Related manpages:
- cdist-manifest(7)
- cdist-manifest-run(1)
- cdist-manifest-run-init(1) - cdist-manifest-run-init(1)
- cdist-manifest-run(1)
- cdist-manifest(7)
STAGE 3: EXECUTION OF OBJECTS STAGE 3: OBJECT INFORMATION RETRIEVAL
----------------------------- -------------------------------------
Each object in the cconfig database is run through the following stages: Every object is checked whether its type has explorers and if so, these are
- transfered to the target host and executed. The results are transfered back
and can be used in the following stages to decide what changes need to made
on the target to implement the desired state.
Related manpages:
- cdist-object-explorer-run(1)
- cdist-remote-explorer-run(1)
- cdist-type(7)
- cdist-explorer(7)
STAGE 4: RUN THE OBJECT MANIFEST
--------------------------------
Every object is checked whether its type has a manifest file. If the type has Every object is checked whether its type has a manifest file. If the type has
a manifest file and it is executable, it will be executed. The manifest script a manifest file and it is executable, it will be executed. The manifest script
may generate and change the created objects. In other words, one type can reuse may generate and change the created objects. In other words, one type can reuse
@ -69,12 +83,12 @@ may occur during the merge. A conflict would mean that two different objects
try to create the same object, which indicates a broken configuration. try to create the same object, which indicates a broken configuration.
Related manpages: Related manpages:
- cdist-object-manifest-run(1)
- cdist-manifest-run(1) - cdist-manifest-run(1)
- cdist-manifest-run-all(1)
- cdist-type(7) - cdist-type(7)
STAGE 4: CODE GENERATION STAGE 5: CODE GENERATION
------------------------ ------------------------
In this stage for every created objects its type is checked whether it has a In this stage for every created objects its type is checked whether it has a
gencode script. If the type has a gencode script and it is executable it will gencode script. If the type has a gencode script and it is executable it will
@ -83,19 +97,27 @@ on stdout. If the gencode executable fails, it must print diagnostic messages
on stderr and exit non-zero. on stderr and exit non-zero.
Related manpages: Related manpages:
- cdist-gencode(1) - cdist-object-gencode-run(1)
- cdist-gencode-all(1) - cdist-object-gencode(1)
- cdist-type(7) - cdist-type(7)
STAGE 5: CODE EXECUTION STAGE 6: CODE EXECUTION
----------------------- -----------------------
The resulting code from the previous stage is transferred to the target host For every object the resulting code from the previous stage is transferred to
and executed there to apply the configuration changes, the target host and executed there to apply the configuration changes.
Related manpages: Related manpages:
- cdist-exec-run(1) - cdist-object-code-run(1)
- cdist-exec-transfer(1) - cdist-code-run(1)
STAGE 7: CACHE
--------------
The cache stores the information from the current run for later use.
Related manpages:
- cdist-cache(1)
SUMMARY SUMMARY
@ -115,5 +137,5 @@ SEE ALSO
COPYING COPYING
------- -------
Copyright \(C) 2010-2011 Nico Schottelius. Free use of this software is Copyright \(C) 2010-2011 Nico Schottelius, Steven Armstrong. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3). granted under the terms of the GNU General Public License version 3 (GPLv3).