Configuration Quick Reference\r
=============================\r
\r
-The following types of configuration are supported by the DCAE Platform.\r
+Default Values\r
+^^^^^^^^^^^^^^\r
\r
-+---------+---------+----------+---------+-----------+---+\r
-| Input | Default | Designer | Clamp | Policy | R\|\r
-| Sources | Values | Input | Input | Input | u\|\r
-| | | | | | n\|\r
-| | | | | | t\|\r
-| | | | | | i\|\r
-| | | | | | m\|\r
-| | | | | | e |\r
-| | | | | | I\|\r
-| | | | | | n\|\r
-| | | | | | p\|\r
-| | | | | | u\|\r
-| | | | | | t |\r
-+=========+=========+==========+=========+===========+===+\r
-| Notes | | This | This | | |\r
-| | | applies | applies | | |\r
-| | | only to | only to | | |\r
-| | | componen\| compone\| | |\r
-| | | ts | nts | | |\r
-| | | that are | that | | |\r
-| | | self-ser\| are | | |\r
-| | | vice | part of | | |\r
-| | | (support\| a | | |\r
-| | | ed | closed-\| | |\r
-| | | by SDC) | loop | | |\r
-| | | | interfa\| | |\r
-| | | | ce | | |\r
-+---------+---------+----------+---------+-----------+---+\r
-| Who | Compone\| Service | CLAMP | Operatio\ | R\|\r
-| provide\| nt | Designer | | ns | u\|\r
-| s? | Develop | | | | n\|\r
-| | er | | | | t\|\r
-| | | | | | i\|\r
-| | | | | | m\|\r
-| | | | | | e |\r
-| | | | | | P\|\r
-| | | | | | l\|\r
-| | | | | | a\|\r
-| | | | | | t\|\r
-| | | | | | f\|\r
-| | | | | | o\|\r
-| | | | | | r\|\r
-| | | | | | m |\r
-+---------+---------+----------+---------+-----------+---+\r
-| When/Wh\| During | At | At | Anytime | W\|\r
-| ere | onboard\| design | install\| – in the | h\|\r
-| it is | ing | time – | ation | POLICY | e\|\r
-| provide | – in | in the | – in | GUI | n |\r
-| d | the | SDC UI | the | | t\|\r
-| | compone\| | CLAMP | | h\|\r
-| | nt | | UI | | e |\r
-| | specifi\| | | | c\|\r
-| | cation | | | | o\|\r
-| | | | | | m\|\r
-| | | | | | p\|\r
-| | | | | | o\|\r
-| | | | | | n\|\r
-| | | | | | e\|\r
-| | | | | | n\|\r
-| | | | | | t |\r
-| | | | | | i\|\r
-| | | | | | s |\r
-| | | | | | d\|\r
-| | | | | | e\|\r
-| | | | | | p\|\r
-| | | | | | l\|\r
-| | | | | | o\|\r
-| | | | | | y\|\r
-| | | | | | e\|\r
-| | | | | | d |\r
-+---------+---------+----------+---------+-----------+---+\r
-| Compone\| For | ‘designe\| | ‘policy-\ | ‘\|\r
-| nt | CDAP: | r-editab\| | editable\ | s\|\r
-| Specifi\| ‘value’ | le’ | | ’ | o\|\r
-| cation | Name | must be | | must be | u\|\r
-| Details | and KV | set to | | set to | r\|\r
-| | pairs | ‘true’ | | ‘true’ | c\|\r
-| | in | for | | and | e\|\r
-| | AppConf\| variable | | ‘policy_s\| d\|\r
-| | ig | in | | chema’ | _\|\r
-| | or | ‘paramet\| | must be | a\|\r
-| | AppPref\| er’ | | provided | t\|\r
-| | erences | section. | | for | _\|\r
-| | For | | | variable | \ |\r
-| | Docker: | | | in | d\|\r
-| | ‘value’ | | | ‘paramet\ | e\|\r
-| | is | | | er’ | p\|\r
-| | provide | | | section | l\|\r
-| | d | | | | o\|\r
-| | for | | | | y\|\r
-| | variabl\| | | | m\|\r
-| | e | | | | e\|\r
-| | in | | | | n\|\r
-| | ‘parame\| | | | t\|\r
-| | ter’ | | | | ’ |\r
-| | section | | | | m\|\r
-| | | | | | u\|\r
-| | | | | | s\|\r
-| | | | | | t |\r
-| | | | | | b\|\r
-| | | | | | e |\r
-| | | | | | s\|\r
-| | | | | | e\|\r
-| | | | | | t |\r
-| | | | | | t\|\r
-| | | | | | o |\r
-| | | | | | ‘\|\r
-| | | | | | t\|\r
-| | | | | | r\|\r
-| | | | | | u\|\r
-| | | | | | e |\r
-| | | | | | ’\|\r
-| | | | | | f\|\r
-| | | | | | o\|\r
-| | | | | | r |\r
-| | | | | | v\|\r
-| | | | | | a\|\r
-| | | | | | r\|\r
-| | | | | | i\|\r
-| | | | | | a\|\r
-| | | | | | b\|\r
-| | | | | | l\|\r
-| | | | | | e\|\r
-| | | | | | i\|\r
-| | | | | | n\|\r
-| | | | | | ‘ |\r
-| | | | | | p\|\r
-| | | | | | a\|\r
-| | | | | | r\|\r
-| | | | | | a\|\r
-| | | | | | m\|\r
-| | | | | | e\|\r
-| | | | | | t\|\r
-| | | | | | e\|\r
-| | | | | | r\|\r
-| | | | | | ’ |\r
-| | | | | | s\|\r
-| | | | | | e\|\r
-| | | | | | c\|\r
-| | | | | | t\|\r
-| | | | | | i\|\r
-| | | | | | o\|\r
-| | | | | | n |\r
-+---------+---------+----------+---------+-----------+---+\r
+The component developer can provide default values for any ``parameter``\r
+in the component specification. These defaults will be passed to the\r
+component in its generated configuration.\r
+\r
+Overridden/Entered Values\r
+^^^^^^^^^^^^^^^^^^^^^^^^^\r
+\r
+Depending on the other properties set for the parameter, the default\r
+value can be overridden at ‘design-time’, ‘deploy-time’ or once the\r
+microservice is running (‘run-time’). (*In the future, when Policy is\r
+supported, configuration will also be able to be provided/changed in the\r
+Policy UI at any time).*\r
+\r
+\r
++--------+--------+--------+--------+------------+\r
+| | Design\| CLAMP | Policy | Deploy-Time|\r
+| | -Time | Input | Input | Input |\r
+| | Input | | (futur\| |\r
+| | | | e) | |\r
++========+========+========+========+============+\r
+| Descri\| Applie\| Applie\| (not | Applies to |\r
+| ption | s | s | yet | manually |\r
+| | to SDC | to | suppor\| deployed |\r
+| | self-s\| compon\| ted) | services |\r
+| | ervice | ents | | |\r
+| | compon\| deploy\| | |\r
+| | ents | ed | | |\r
+| | | by | | |\r
+| | | CLAMP | | |\r
++--------+--------+--------+--------+------------+\r
+| Input | Servic\| CLAMP | Operat\| DevOps |\r
+| provid\| e | | ions | |\r
+| ed | Design | | | |\r
+| by | er | | | |\r
++--------+--------+--------+--------+------------+\r
+| How it | In the | In the | In the | In the DCAE|\r
+| is | SDC UI | CLAMP | POLICY | Dashboard |\r
+| provid\| | UI | GUI | (or Jenkins|\r
+| ed | | | | job) |\r
++--------+--------+--------+--------+------------+\r
+| Compon\| ‘desig\| None. | ‘polic\| ‘sourced\ |\r
+| ent | ner-ed\| Develo\| y_edit\| _at_deploy\|\r
+| Specif\| itable\| per | able’ | ment’ must |\r
+| icatio\| ’ | provid\| must | be set to |\r
+| n | set to | es | be set | ‘true’ |\r
+| Detail\| ‘true’ | CLAMP | to | |\r
+| s | | an | ‘true’ | |\r
+| | | email | and | |\r
+| | | with | ‘polic\| |\r
+| | | parame\| y_sche\| |\r
+| | | ters | ma’ | |\r
+| | | to be | must | |\r
+| | | suppor\| be | |\r
+| | | ted | provid\| |\r
+| | | | ed | |\r
+| | | | | |\r
+| | | | | |\r
++--------+--------+--------+--------+------------+\r
+| Additi\| | | For | |\r
+| onal | | | Docker | |\r
+| Info | | | only: | |\r
+| for | | | In the | |\r
+| Compon\| | | auxili\| |\r
+| ent | | | ary | |\r
+| Develo\| | | sectio\| |\r
+| per | | | n: | |\r
+| | | | {“poli\| |\r
+| | | | cy”: | |\r
+| | | | {“trig\| |\r
+| | | | ger_ty\| |\r
+| | | | pe”: | |\r
+| | | | “polic\| |\r
+| | | | y”,“sc\| |\r
+| | | | ript_p\| |\r
+| | | | ath”: | |\r
+| | | | “/opt/\| |\r
+| | | | app/re\| |\r
+| | | | config\| |\r
+| | | | ure.sh | |\r
+| | | | ”} | |\r
+| | | | } | |\r
+| | | | Script | |\r
+| | | | interf\| |\r
+| | | | ace | |\r
+| | | | would | |\r
+| | | | then | |\r
+| | | | be | |\r
+| | | | “/opt/\| |\r
+| | | | app/re\| |\r
+| | | | config\| |\r
+| | | | ure.sh | |\r
+| | | | ” | |\r
+| | | | $trigg\| |\r
+| | | | er_typ\| |\r
+| | | | e | |\r
+| | | | $updat\| |\r
+| | | | ed_pol\| |\r
+| | | | icy" | |\r
+| | | | where | |\r
+| | | | $updat\| |\r
+| | | | ed_pol\| |\r
+| | | | icy | |\r
+| | | | is | |\r
+| | | | json | |\r
+| | | | provid\| |\r
+| | | | ed | |\r
+| | | | by the | |\r
+| | | | Policy | |\r
+| | | | Handle\| |\r
+| | | | r. | |\r
++--------+--------+--------+--------+------------+\r
\r
-+---------+---------+----------+---------+-----------+---+\r
-| How it | This is | This | This | This | T\|\r
-| is used | passed | override\| overrid\| override\ | h\|\r
-| | to the | s | es | s | i\|\r
-| | compone\| any | any | any | s |\r
-| | nt | values | values | values | o\|\r
-| | in the | previous\| previou\| previous\ | v\|\r
-| | generat\| ly | sly | ly | e\|\r
-| | ed | set, but | set, | set, but | r\|\r
-| | configu\| can be | but can | can be | r\|\r
-| | ration | overridd\| be | overridd\ | i\|\r
-| | if not | en | overrid\| en | d\|\r
-| | overrid\| by CLAMP | den | at any | e\|\r
-| | den. | or | by | point | s |\r
-| | | POLICY. | POLICY. | thereaft\ | a\|\r
-| | | | | er. | n\|\r
-| | | | | | y |\r
-| | | | | | v\|\r
-| | | | | | a\|\r
-| | | | | | l\|\r
-| | | | | | u\|\r
-| | | | | | e\|\r
-| | | | | | s |\r
-| | | | | | p\|\r
-| | | | | | r\|\r
-| | | | | | e\|\r
-| | | | | | v\|\r
-| | | | | | i\|\r
-| | | | | | o\|\r
-| | | | | | u\|\r
-| | | | | | s\|\r
-| | | | | | l\|\r
-| | | | | | y |\r
-| | | | | | s\|\r
-| | | | | | e\|\r
-| | | | | | t\|\r
-| | | | | | , |\r
-| | | | | | b\|\r
-| | | | | | u\|\r
-| | | | | | t |\r
-| | | | | | c\|\r
-| | | | | | a\|\r
-| | | | | | n |\r
-| | | | | | b\|\r
-| | | | | | e |\r
-| | | | | | o\|\r
-| | | | | | v\|\r
-| | | | | | e\|\r
-| | | | | | r\|\r
-| | | | | | r\|\r
-| | | | | | i\|\r
-| | | | | | d\|\r
-| | | | | | d\|\r
-| | | | | | e\|\r
-| | | | | | n |\r
-| | | | | | a\|\r
-| | | | | | t |\r
-| | | | | | a\|\r
-| | | | | | n\|\r
-| | | | | | y |\r
-| | | | | | p\|\r
-| | | | | | o\|\r
-| | | | | | i\|\r
-| | | | | | n\|\r
-| | | | | | t |\r
-| | | | | | t\|\r
-| | | | | | h\|\r
-| | | | | | e\|\r
-| | | | | | r\|\r
-| | | | | | e\|\r
-| | | | | | a\|\r
-| | | | | | f\|\r
-| | | | | | t\|\r
-| | | | | | e\|\r
-| | | | | | r |\r
-| | | | | | b\|\r
-| | | | | | y |\r
-| | | | | | P\|\r
-| | | | | | o\|\r
-| | | | | | l\|\r
-| | | | | | i\|\r
-| | | | | | c\|\r
-| | | | | | y\|\r
-| | | | | | . |\r
-+---------+---------+----------+---------+-----------+---+\r
-| Additio\| For | | | For | |\r
-| nal | CDAP: | | | Docker: | |\r
-| Info | ‘value’ | | | In the | |\r
-| for | is | | | auxiliar\ | |\r
-| Compone\| provide\| | | y | |\r
-| nt | d | | | section: | |\r
-| Develop\| for | | | {“policy | |\r
-| er | variabl\| | | ”: | |\r
-| | e | | | {“trigge\ | |\r
-| | in the | | | r_type”: | |\r
-| | ‘AppCon\| | | “policy” | |\r
-| | fig’ | | | ,“script\ | |\r
-| | or | | | _path”: | |\r
-| | ‘AppPre\| | | “/opt/ap\ | |\r
-| | ference\| | | p/reconf\ | |\r
-| | s’ | | | igure.sh\ | |\r
-| | section\| | | ”} | |\r
-| | s | | | } Script | |\r
-| | For | | | interfac\ | |\r
-| | Docker: | | | e | |\r
-| | ‘value’ | | | must be | |\r
-| | is | | | “opt/app\ | |\r
-| | provide\| | | /reconfi\ | |\r
-| | d | | | gure.sh” | |\r
-| | for | | | $trigger\ | |\r
-| | variabl\| | | _type | |\r
-| | e | | | $updated\ | |\r
-| | in | | | _policie\ | |\r
-| | ‘parame\| | | s | |\r
-| | ter’ | | | $updated\ | |\r
-| | section | | | _appl_co\ | |\r
-| | | | | nfig" | |\r
-| | | | | where | |\r
-| | | | | $updated\ | |\r
-| | | | | _policie\ | |\r
-| | | | | s | |\r
-| | | | | is a | |\r
-| | | | | json | |\r
-| | | | | provided | |\r
-| | | | | by the | |\r
-| | | | | Policy | |\r
-| | | | | Handler | |\r
-| | | | | and | |\r
-| | | | | $update_a\| |\r
-| | | | | ppl_con\ | |\r
-| | | | | fig | |\r
-| | | | | is the | |\r
-| | | | | post-mer\ | |\r
-| | | | | ged | |\r
-| | | | | appl\ | |\r
-| | | | | config | |\r
-| | | | | which | |\r
-| | | | | may | |\r
-| | | | | contain | |\r
-| | | | | unresolv\ | |\r
-| | | | | ed | |\r
-| | | | | configur\ | |\r
-| | | | | ation | |\r
-| | | | | that | |\r
-| | | | | didn’t | |\r
-| | | | | come | |\r
-| | | | | from | |\r
-| | | | | policy. | |\r
-| | | | | Suggesti\ | |\r
-| | | | | on | |\r
-| | | | | is for | |\r
-| | | | | script | |\r
-| | | | | to call | |\r
-| | | | | CONFIG | |\r
-| | | | | BINDING | |\r
-| | | | | SERVICE | |\r
-| | | | | to | |\r
-| | | | | resolve | |\r
-| | | | | any | |\r
-| | | | | configur\ | |\r
-| | | | | ation. | |\r
-+---------+---------+----------+---------+-----------+---+\r
Code Review / dcaegen2.git / blobdiff