Add local cache overview docs.
This commit is contained in:
parent
9703e0f08e
commit
7558af1707
3 changed files with 99 additions and 0 deletions
96
docs/src/cdist-cache.rst
Normal file
96
docs/src/cdist-cache.rst
Normal file
|
@ -0,0 +1,96 @@
|
||||||
|
Local cache overview
|
||||||
|
====================
|
||||||
|
|
||||||
|
Description
|
||||||
|
-----------
|
||||||
|
While executing, cdist stores data to local cache. Currently this feature is
|
||||||
|
one way only. That means that cdist does not use stored data for future runs.
|
||||||
|
Anyway, those data can be used for debugging cdist, debugging types and
|
||||||
|
debugging after host configuration fails.
|
||||||
|
|
||||||
|
Local cache is saved under $HOME/.cdist/cache directory, one directory entry
|
||||||
|
for each host. Subdirectory path is specified by
|
||||||
|
:strong:`-C/--cache-path-pattern` option, :strong:`cache_path_pattern`
|
||||||
|
configuration option or by using :strong:`CDIST_CACHE_PATH_PATTERN`
|
||||||
|
environment variable.
|
||||||
|
|
||||||
|
For more info on cache path pattern see :strong:`CACHE PATH PATTERN FORMAT`
|
||||||
|
section in cdist man page.
|
||||||
|
|
||||||
|
|
||||||
|
Cache overview
|
||||||
|
--------------
|
||||||
|
As noted above each configured host has got its subdirectory in local cache.
|
||||||
|
Entries in host's cache directory are as follows.
|
||||||
|
|
||||||
|
bin
|
||||||
|
directory with cdist type emulators
|
||||||
|
|
||||||
|
conf
|
||||||
|
dynamically determined cdist conf directory, union of all specified
|
||||||
|
conf directories
|
||||||
|
|
||||||
|
explorer
|
||||||
|
directory containing global explorer named files containing explorer output
|
||||||
|
after running on target host
|
||||||
|
|
||||||
|
messages
|
||||||
|
file containing messages
|
||||||
|
|
||||||
|
object
|
||||||
|
directory containing subdirectory for each cdist object
|
||||||
|
|
||||||
|
object_marker
|
||||||
|
object marker for this particular cdist run
|
||||||
|
|
||||||
|
stderr
|
||||||
|
directory containing init manifest and remote stderr stream output
|
||||||
|
|
||||||
|
stdout
|
||||||
|
directory containing init manifest and remote stdout stream output
|
||||||
|
|
||||||
|
target_host
|
||||||
|
file containing target host of this cdist run, as specified when running
|
||||||
|
cdist
|
||||||
|
|
||||||
|
typeorder
|
||||||
|
file containing types in order of execution.
|
||||||
|
|
||||||
|
|
||||||
|
Object cache overview
|
||||||
|
~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
Each object under :strong:`object` directory has its own structurue.
|
||||||
|
|
||||||
|
code-local
|
||||||
|
code generated from gencode-local, present only if something is
|
||||||
|
generated
|
||||||
|
|
||||||
|
code-remote
|
||||||
|
code generated from gencode-remote, present only if something is
|
||||||
|
generated
|
||||||
|
|
||||||
|
explorer
|
||||||
|
directory containing type explorer named files containing explorer output
|
||||||
|
after running on target host
|
||||||
|
|
||||||
|
files
|
||||||
|
directory with object files created during type execution
|
||||||
|
|
||||||
|
parameter
|
||||||
|
directory containing type parameter named files containing parameter
|
||||||
|
values
|
||||||
|
|
||||||
|
source
|
||||||
|
this type's source (init manifest)
|
||||||
|
|
||||||
|
state
|
||||||
|
this type execution state ('done' when finished)
|
||||||
|
|
||||||
|
stderr
|
||||||
|
directory containing type's gencode-* and code-* stderr stream outputs
|
||||||
|
|
||||||
|
stdin
|
||||||
|
this type stdin content
|
||||||
|
|
||||||
|
stdout
|
||||||
|
directory containing type's gencode-* and code-* stdout stream outputs.
|
|
@ -30,6 +30,7 @@ Contents:
|
||||||
cdist-reference
|
cdist-reference
|
||||||
cdist-best-practice
|
cdist-best-practice
|
||||||
cdist-stages
|
cdist-stages
|
||||||
|
cdist-cache
|
||||||
cdist-remote-exec-copy
|
cdist-remote-exec-copy
|
||||||
cdist-hacker
|
cdist-hacker
|
||||||
cdist-troubleshooting
|
cdist-troubleshooting
|
||||||
|
|
|
@ -571,6 +571,8 @@ FILES
|
||||||
~/.cdist
|
~/.cdist
|
||||||
Your personal cdist config directory. If exists it will be
|
Your personal cdist config directory. If exists it will be
|
||||||
automatically used.
|
automatically used.
|
||||||
|
~/.cdist/cache
|
||||||
|
Local cache directory.
|
||||||
~/.cdist/inventory
|
~/.cdist/inventory
|
||||||
The home inventory directory. If ~/.cdist exists it will be used as
|
The home inventory directory. If ~/.cdist exists it will be used as
|
||||||
default inventory directory.
|
default inventory directory.
|
||||||
|
|
Loading…
Reference in a new issue