blob: 956e1ff240e763f7161910d95b1b075e5c262de3 [file] [log] [blame]
Ralph Knag1fca6ac2017-12-05 12:05:57 -05001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Configuration Quick Reference
5=============================
6
7The following types of configuration are supported by the DCAE Platform.
8
9+---------+---------+----------+---------+-----------+---+
10| Input | Default | Designer | Clamp | Policy | R\|
11| Sources | Values | Input | Input | Input | u\|
12| | | | | | n\|
13| | | | | | t\|
14| | | | | | i\|
15| | | | | | m\|
16| | | | | | e |
17| | | | | | I\|
18| | | | | | n\|
19| | | | | | p\|
20| | | | | | u\|
21| | | | | | t |
22+=========+=========+==========+=========+===========+===+
23| Notes | | This | This | | |
24| | | applies | applies | | |
25| | | only to | only to | | |
26| | | componen\| compone\| | |
27| | | ts | nts | | |
28| | | that are | that | | |
29| | | self-ser\| are | | |
30| | | vice | part of | | |
31| | | (support\| a | | |
32| | | ed | closed-\| | |
33| | | by SDC) | loop | | |
34| | | | interfa\| | |
35| | | | ce | | |
36+---------+---------+----------+---------+-----------+---+
37| Who | Compone\| Service | CLAMP | Operatio\ | R\|
38| provide\| nt | Designer | | ns | u\|
39| s? | Develop | | | | n\|
40| | er | | | | t\|
41| | | | | | i\|
42| | | | | | m\|
43| | | | | | e |
44| | | | | | P\|
45| | | | | | l\|
46| | | | | | a\|
47| | | | | | t\|
48| | | | | | f\|
49| | | | | | o\|
50| | | | | | r\|
51| | | | | | m |
52+---------+---------+----------+---------+-----------+---+
53| When/Wh\| During | At | At | Anytime | W\|
54| ere | onboard\| design | install\| – in the | h\|
55| it is | ing | time – | ation | POLICY | e\|
56| provide | – in | in the | – in | GUI | n |
57| d | the | SDC UI | the | | t\|
58| | compone\| | CLAMP | | h\|
59| | nt | | UI | | e |
60| | specifi\| | | | c\|
61| | cation | | | | o\|
62| | | | | | m\|
63| | | | | | p\|
64| | | | | | o\|
65| | | | | | n\|
66| | | | | | e\|
67| | | | | | n\|
68| | | | | | t |
69| | | | | | i\|
70| | | | | | s |
71| | | | | | d\|
72| | | | | | e\|
73| | | | | | p\|
74| | | | | | l\|
75| | | | | | o\|
76| | | | | | y\|
77| | | | | | e\|
78| | | | | | d |
79+---------+---------+----------+---------+-----------+---+
80| Compone\| For | ‘designe\| | ‘policy-\ | ‘\|
81| nt | CDAP: | r-editab\| | editable\ | s\|
82| Specifi\| ‘value’ | le’ | | ’ | o\|
83| cation | Name | must be | | must be | u\|
84| Details | and KV | set to | | set to | r\|
85| | pairs | ‘true’ | | ‘true’ | c\|
86| | in | for | | and | e\|
87| | AppConf\| variable | | ‘policy_s\| d\|
88| | ig | in | | chema’ | _\|
89| | or | ‘paramet\| | must be | a\|
90| | AppPref\| er’ | | provided | t\|
91| | erences | section. | | for | _\|
92| | For | | | variable | \ |
93| | Docker: | | | in | d\|
94| | ‘value’ | | | ‘paramet\ | e\|
95| | is | | | er’ | p\|
96| | provide | | | section | l\|
97| | d | | | | o\|
98| | for | | | | y\|
99| | variabl\| | | | m\|
100| | e | | | | e\|
101| | in | | | | n\|
102| | ‘parame\| | | | t\|
103| | ter’ | | | | ’ |
104| | section | | | | m\|
105| | | | | | u\|
106| | | | | | s\|
107| | | | | | t |
108| | | | | | b\|
109| | | | | | e |
110| | | | | | s\|
111| | | | | | e\|
112| | | | | | t |
113| | | | | | t\|
114| | | | | | o |
115| | | | | | ‘\|
116| | | | | | t\|
117| | | | | | r\|
118| | | | | | u\|
119| | | | | | e |
120| | | | | | ’\|
121| | | | | | f\|
122| | | | | | o\|
123| | | | | | r |
124| | | | | | v\|
125| | | | | | a\|
126| | | | | | r\|
127| | | | | | i\|
128| | | | | | a\|
129| | | | | | b\|
130| | | | | | l\|
131| | | | | | e\|
132| | | | | | i\|
133| | | | | | n\|
134| | | | | | ‘ |
135| | | | | | p\|
136| | | | | | a\|
137| | | | | | r\|
138| | | | | | a\|
139| | | | | | m\|
140| | | | | | e\|
141| | | | | | t\|
142| | | | | | e\|
143| | | | | | r\|
144| | | | | | ’ |
145| | | | | | s\|
146| | | | | | e\|
147| | | | | | c\|
148| | | | | | t\|
149| | | | | | i\|
150| | | | | | o\|
151| | | | | | n |
152+---------+---------+----------+---------+-----------+---+
153
154+---------+---------+----------+---------+-----------+---+
155| How it | This is | This | This | This | T\|
156| is used | passed | override\| overrid\| override\ | h\|
157| | to the | s | es | s | i\|
158| | compone\| any | any | any | s |
159| | nt | values | values | values | o\|
160| | in the | previous\| previou\| previous\ | v\|
161| | generat\| ly | sly | ly | e\|
162| | ed | set, but | set, | set, but | r\|
163| | configu\| can be | but can | can be | r\|
164| | ration | overridd\| be | overridd\ | i\|
165| | if not | en | overrid\| en | d\|
166| | overrid\| by CLAMP | den | at any | e\|
167| | den. | or | by | point | s |
168| | | POLICY. | POLICY. | thereaft\ | a\|
169| | | | | er. | n\|
170| | | | | | y |
171| | | | | | v\|
172| | | | | | a\|
173| | | | | | l\|
174| | | | | | u\|
175| | | | | | e\|
176| | | | | | s |
177| | | | | | p\|
178| | | | | | r\|
179| | | | | | e\|
180| | | | | | v\|
181| | | | | | i\|
182| | | | | | o\|
183| | | | | | u\|
184| | | | | | s\|
185| | | | | | l\|
186| | | | | | y |
187| | | | | | s\|
188| | | | | | e\|
189| | | | | | t\|
190| | | | | | , |
191| | | | | | b\|
192| | | | | | u\|
193| | | | | | t |
194| | | | | | c\|
195| | | | | | a\|
196| | | | | | n |
197| | | | | | b\|
198| | | | | | e |
199| | | | | | o\|
200| | | | | | v\|
201| | | | | | e\|
202| | | | | | r\|
203| | | | | | r\|
204| | | | | | i\|
205| | | | | | d\|
206| | | | | | d\|
207| | | | | | e\|
208| | | | | | n |
209| | | | | | a\|
210| | | | | | t |
211| | | | | | a\|
212| | | | | | n\|
213| | | | | | y |
214| | | | | | p\|
215| | | | | | o\|
216| | | | | | i\|
217| | | | | | n\|
218| | | | | | t |
219| | | | | | t\|
220| | | | | | h\|
221| | | | | | e\|
222| | | | | | r\|
223| | | | | | e\|
224| | | | | | a\|
225| | | | | | f\|
226| | | | | | t\|
227| | | | | | e\|
228| | | | | | r |
229| | | | | | b\|
230| | | | | | y |
231| | | | | | P\|
232| | | | | | o\|
233| | | | | | l\|
234| | | | | | i\|
235| | | | | | c\|
236| | | | | | y\|
237| | | | | | . |
238+---------+---------+----------+---------+-----------+---+
239| Additio\| For | | | For | |
240| nal | CDAP: | | | Docker: | |
241| Info | ‘value’ | | | In the | |
242| for | is | | | auxiliar\ | |
243| Compone\| provide\| | | y | |
244| nt | d | | | section: | |
245| Develop\| for | | | {“policy | |
246| er | variabl\| | | ”: | |
247| | e | | | {“trigge\ | |
248| | in the | | | r_type”: | |
249| | ‘AppCon\| | | “policy” | |
250| | fig’ | | | ,“script\ | |
251| | or | | | _path”: | |
252| | ‘AppPre\| | | “/opt/ap\ | |
253| | ference\| | | p/reconf\ | |
254| | s’ | | | igure.sh\ | |
255| | section\| | | ”} | |
256| | s | | | } Script | |
257| | For | | | interfac\ | |
258| | Docker: | | | e | |
259| | ‘value’ | | | must be | |
260| | is | | | “opt/app\ | |
261| | provide\| | | /reconfi\ | |
262| | d | | | gure.sh” | |
263| | for | | | $trigger\ | |
264| | variabl\| | | _type | |
265| | e | | | $updated\ | |
266| | in | | | _policie\ | |
267| | ‘parame\| | | s | |
268| | ter’ | | | $updated\ | |
269| | section | | | _appl_co\ | |
270| | | | | nfig" | |
271| | | | | where | |
272| | | | | $updated\ | |
273| | | | | _policie\ | |
274| | | | | s | |
275| | | | | is a | |
276| | | | | json | |
277| | | | | provided | |
278| | | | | by the | |
279| | | | | Policy | |
280| | | | | Handler | |
281| | | | | and | |
282| | | | | $update_a\| |
283| | | | | ppl_con\ | |
284| | | | | fig | |
285| | | | | is the | |
286| | | | | post-mer\ | |
287| | | | | ged | |
288| | | | | appl\ | |
289| | | | | config | |
290| | | | | which | |
291| | | | | may | |
292| | | | | contain | |
293| | | | | unresolv\ | |
294| | | | | ed | |
295| | | | | configur\ | |
296| | | | | ation | |
297| | | | | that | |
298| | | | | didn’t | |
299| | | | | come | |
300| | | | | from | |
301| | | | | policy. | |
302| | | | | Suggesti\ | |
303| | | | | on | |
304| | | | | is for | |
305| | | | | script | |
306| | | | | to call | |
307| | | | | CONFIG | |
308| | | | | BINDING | |
309| | | | | SERVICE | |
310| | | | | to | |
311| | | | | resolve | |
312| | | | | any | |
313| | | | | configur\ | |
314| | | | | ation. | |
315+---------+---------+----------+---------+-----------+---+