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