Browse Source

Add documentation for nodes configs

Added new sub-key definition to documentation. Refactor nodes
and roles key types description in docs.

Change-Id: Ie8f15044e05c67e1ed1a8919e07ded3518e6b24c
Depends-on: I379f4840e6093b7910b5d7dd612de62b1fe0ac2e
Related-bug: #1653077
Peter Razumovsky 2 years ago
parent
commit
df907ee698
1 changed files with 50 additions and 10 deletions
  1. 50
    10
      doc/source/config/types.rst

+ 50
- 10
doc/source/config/types.rst View File

@@ -44,7 +44,8 @@ of the microservices and credentials for connecting to Kubernetes cluster.
44 44
 - :ref:`configs`
45 45
 - :ref:`files`
46 46
 - :ref:`kubernetes`
47
-- :ref:`nodes_roles`
47
+- :ref:`nodes`
48
+- :ref:`roles`
48 49
 - :ref:`replicas`
49 50
 
50 51
 Other specific variables
@@ -469,10 +470,10 @@ For example:
469 470
  replicas:
470 471
    heat-engine: 3
471 472
 
472
-.. _nodes_roles:
473
+.. _nodes:
473 474
 
474
-nodes and roles key
475
--------------------
475
+nodes
476
+-----
476 477
 
477 478
 Isolation:
478 479
 
@@ -483,15 +484,54 @@ Allowed content:
483 484
 
484 485
 - This key contains a regular expression to match one or several nodes at once,
485 486
   example can be found in ``fuel-ccp`` git repository in
486
-  ``etc/topology-example.yaml`` file.
487
-  If your environment contains more than 9 nodes, you must explicitly specify
488
-  the "end-of-line", because expression like node([1-5]|10|11) will also match
489
-  node12, node13 etc. Example can be found in ``fuel-ccp`` git repository in
490
-  ``etc/topology-with-large-number-of-nodes.yaml`` file.
487
+  ``etc/topology-example.yaml`` file. If your environment contains more than 9
488
+  nodes, you must explicitly specify the "end-of-line", because expression like
489
+  node([1-5]|10|11) will also match node12, node13 etc. Example can be found in
490
+  ``fuel-ccp`` git repository in
491
+  ``etc/topology-with-large-number-of-nodes.yaml`` file. This key includes
492
+  next two sub-keys:
493
+
494
+  * *roles* sub-key, which contains a list of roles names. Example of such
495
+    definition can be found in `topology example file <https://github.com
496
+    /openstack/fuel-ccp/blob/master/etc/topology-example.yaml>`_.
497
+
498
+  * *configs* key, which defines dict of configs, specific for particular node
499
+    and service. Configs serve to override global config defaults, for example,
500
+    for variables, dependent on node hardware configuration. Example:
501
+
502
+    ::
503
+
504
+       nodes:
505
+         node[2-3]:
506
+           roles:
507
+             - openstack
508
+           configs:
509
+             nova:
510
+               logging_debug: true
511
+
512
+    .. NOTE:: It's very important: global configs merged with specific nodes
513
+    configs in lexicographic order, i.e. if you have override key *test* with
514
+    value *2* for `node[1-3]` and with value *4* `node[2-4]`, then `node2` will
515
+    have key-value pair *(test, 4)* in configs.
516
+
517
+.. _roles:
518
+
519
+roles
520
+-----
521
+
522
+Isolation:
523
+
524
+- Not used in any template file, only used by the CCP CLI to create a cluster
525
+  topology.
526
+
527
+Allowed content:
491 528
 
492 529
 - The roles specified in the 'roles' key for node will apply to all matched
493 530
   nodes. If a node matches several 'nodes' keys, each with different roles,
494
-  then roles from all keys will be added to node.
531
+  then roles from all keys will be added to node. Example can be found in the
532
+  `topology example file
533
+  <https://github.com/openstack/fuel-ccp/blob/master/etc/
534
+  topology-example.yaml>`_.
495 535
 
496 536
 .. _registry:
497 537
 

Loading…
Cancel
Save