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