DCAE Controller documentation DCAEGEN2-213
[dcaegen2.git] / 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
new file mode 100755 (executable)
index 0000000..956e1ff
--- /dev/null
@@ -0,0 +1,315 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
+.. http://creativecommons.org/licenses/by/4.0\r
+\r
+Configuration Quick Reference\r
+=============================\r
+\r
+The following types of configuration are supported by the DCAE Platform.\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
+\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