Debian Codegraph @

docs/src/cdist-cache.rst

raw
1 Local cache overview
2 ====================
3
4 Description
5 -----------
6 While executing, cdist stores data to local cache. Currently this feature is
7 one way only. That means that cdist does not use stored data for future runs.
8 Anyway, those data can be used for debugging cdist, debugging types and
9 debugging after host configuration fails.
10
11 Local cache is saved under $HOME/.cdist/cache directory, one directory entry
12 for each host. Subdirectory path is specified by
13 :strong:`-C/--cache-path-pattern` option, :strong:`cache_path_pattern`
14 configuration option or by using :strong:`CDIST_CACHE_PATH_PATTERN`
15 environment variable.
16
17 For more info on cache path pattern see :strong:`CACHE PATH PATTERN FORMAT`
18 section in cdist man page.
19
20
21 Cache overview
22 --------------
23 As noted above each configured host has got its subdirectory in local cache.
24 Entries in host's cache directory are as follows.
25
26 bin
27 directory with cdist type emulators
28
29 conf
30 dynamically determined cdist conf directory, union of all specified
31 conf directories
32
33 explorer
34 directory containing global explorer named files containing explorer output
35 after running on target host
36
37 messages
38 file containing messages
39
40 object
41 directory containing subdirectory for each cdist object
42
43 object_marker
44 object marker for this particular cdist run
45
46 stderr
47 directory containing init manifest and remote stderr stream output
48
49 stdout
50 directory containing init manifest and remote stdout stream output
51
52 target_host
53 file containing target host of this cdist run, as specified when running
54 cdist
55
56 typeorder
57 file containing types in order of execution.
58
59
60 Object cache overview
61 ~~~~~~~~~~~~~~~~~~~~~
62 Each object under :strong:`object` directory has its own structure.
63
64 autorequire
65 file containing a list of object auto requirements
66
67 children
68 file containing a list of object children, i.e. objects of types that this
69 type reuses (along with 'parents' it is used for maintaining parent-child
70 relationship graph)
71
72 code-local
73 code generated from gencode-local, present only if something is
74 generated
75
76 code-remote
77 code generated from gencode-remote, present only if something is
78 generated
79
80 explorer
81 directory containing type explorer named files containing explorer output
82 after running on target host
83
84 files
85 directory with object files created during type execution
86
87 parameter
88 directory containing type parameter named files containing parameter
89 values
90
91 parents
92 file containing a list of object parents, i.e. objects of types that reuse
93 this type (along with 'children' it is used for maintaining parent-child
94 relationship graph); objects without parents are objects specified in init
95 manifest
96
97 require
98 file containing a list of object requirements
99
100 source
101 this type's source (init manifest)
102
103 state
104 this type execution state ('done' when finished)
105
106 stderr
107 directory containing type's manifest, gencode-* and code-* stderr stream
108 outputs
109
110 stdin
111 this type stdin content
112
113 stdout
114 directory containing type's manifest, gencode-* and code-* stdout stream
115 outputs.