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