[VES-OPENAPI] Update docs with kafka
[dcaegen2.git] / docs / sections / design-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 Default Values\r
8 ^^^^^^^^^^^^^^\r
9 \r
10 The component developer can provide default values for any ``parameter``\r
11 in the component specification. These defaults will be passed to the\r
12 component in its generated configuration.\r
13 \r
14 Overridden/Entered Values\r
15 ^^^^^^^^^^^^^^^^^^^^^^^^^\r
16 \r
17 Depending on the other properties set for the parameter, the default\r
18 value can be overridden at ‘design-time’, ‘deploy-time’ or once the\r
19 microservice is running (‘run-time’). \r
20 \r
21 +--------+--------+--------+--------+------------+\r
22 |        | Design\| CLAMP  | Policy | Deploy-Time|\r
23 |        | -Time  | Input  | Input  | Input      |\r
24 |        | Input  |        |        |            |\r
25 |        |        |        |        |            |\r
26 +========+========+========+========+============+\r
27 | Descri\| Applie\| Applie\| (not   | Applies to |\r
28 | ption  | s      | s      | yet    | manually   |\r
29 |        | to     | to     | suppor\| deployed   |\r
30 |        | self-s\| compon\| ted)   | services   |\r
31 |        | ervice | ents   |        |            |\r
32 |        | compon\| deploy\|        |            |\r
33 |        | ents   | ed     |        |            |\r
34 |        |        | by     |        |            |\r
35 |        |        | CLAMP  |        |            |\r
36 +--------+--------+--------+--------+------------+\r
37 | Input  | Servic\| CLAMP  | Operat\| DevOps     |\r
38 | provid\| e      |        | ions   |            |\r
39 | ed     | Designe|        |        |            |\r
40 | by     | r      |        |        |            |\r
41 +--------+--------+--------+--------+------------+\r
42 | How it | In the | In the | In the | In the DCAE|\r
43 | is     | SDC/MOD| CLAMP  | POLICY | Dashboard  |\r
44 | provid\| UI     | UI     | GUI    | (or Jenkins|\r
45 | ed     |        |        |        | job)       |\r
46 +--------+--------+--------+--------+------------+\r
47 | Compon\| ‘desig\| None.  | ‘polic\| ‘sourced\  |\r
48 | ent    | ner-ed\| Develo\| y_edit\| _at_deploy\|\r
49 | Specif\| itable\| per    | able’  | ment’ must |\r
50 | icatio\| ’      | provid\| must   | be set to  |\r
51 | n      | set to | es     | be set | ‘true’     |\r
52 | Detail\| ‘true’ | CLAMP  | to     |            |\r
53 | s      |        | an     | ‘true’ |            |\r
54 |        |        | email  | and    |            |\r
55 |        |        | with   | ‘polic\|            |\r
56 |        |        | parame\| y_sche\|            |\r
57 |        |        | ters   | ma’    |            |\r
58 |        |        | to be  | must   |            |\r
59 |        |        | suppor\| be     |            |\r
60 |        |        | ted    | provid\|            |\r
61 |        |        |        | ed     |            |\r
62 |        |        |        |        |            |\r
63 |        |        |        |        |            |\r
64 +--------+--------+--------+--------+------------+\r
65 | Additi\|        |        | For    |            |\r
66 | onal   |        |        | Docker |            |\r
67 | Info   |        |        | only:  |            |\r
68 | for    |        |        | In the |            |\r
69 | Compon\|        |        | auxili\|            |\r
70 | ent    |        |        | ary    |            |\r
71 | Develo\|        |        | sectio\|            |\r
72 | per    |        |        | n:     |            |\r
73 |        |        |        | {“poli\|            |\r
74 |        |        |        | cy”:   |            |\r
75 |        |        |        | {“trig\|            |\r
76 |        |        |        | ger_ty\|            |\r
77 |        |        |        | pe”:   |            |\r
78 |        |        |        | “polic\|            |\r
79 |        |        |        | y”,“sc\|            |\r
80 |        |        |        | ript_p\|            |\r
81 |        |        |        | ath”:  |            |\r
82 |        |        |        | “/opt/\|            |\r
83 |        |        |        | app/re\|            |\r
84 |        |        |        | config\|            |\r
85 |        |        |        | ure.sh |            |\r
86 |        |        |        | ”}     |            |\r
87 |        |        |        | }      |            |\r
88 |        |        |        | Script |            |\r
89 |        |        |        | interf\|            |\r
90 |        |        |        | ace    |            |\r
91 |        |        |        | would  |            |\r
92 |        |        |        | then   |            |\r
93 |        |        |        | be     |            |\r
94 |        |        |        | “/opt/\|            |\r
95 |        |        |        | app/re\|            |\r
96 |        |        |        | config\|            |\r
97 |        |        |        | ure.sh |            |\r
98 |        |        |        | ”      |            |\r
99 |        |        |        | $trigg\|            |\r
100 |        |        |        | er_typ\|            |\r
101 |        |        |        | e      |            |\r
102 |        |        |        | $updat\|            |\r
103 |        |        |        | ed_pol\|            |\r
104 |        |        |        | icy"   |            |\r
105 |        |        |        | where  |            |\r
106 |        |        |        | $updat\|            |\r
107 |        |        |        | ed_pol\|            |\r
108 |        |        |        | icy    |            |\r
109 |        |        |        | is     |            |\r
110 |        |        |        | json   |            |\r
111 |        |        |        | provid\|            |\r
112 |        |        |        | ed     |            |\r
113 |        |        |        | by the |            |\r
114 |        |        |        | Policy |            |\r
115 |        |        |        | Handle\|            |\r
116 |        |        |        | r.     |            |\r
117 +--------+--------+--------+--------+------------+\r
118 \r