Browse Source

doc bugfix for static provider

Insert `nodes` level for driver `static`; it was missing.
Now it's `pools.[static].nodes.labels` etc.
The previous `pools.[static].labels` was failing a config.

Indent all the node's attributes.

Move `username` and `host-key` for readability.

Change-Id: Ia61fd73884f77f1d96f36038c1cd74eb37016f5c
tags/3.5.0
jabielecki 3 months ago
parent
commit
c4f4279cb3
1 changed files with 46 additions and 35 deletions
  1. 46
    35
      doc/source/configuration.rst

+ 46
- 35
doc/source/configuration.rst View File

@@ -977,17 +977,16 @@ Selecting the static driver adds the following options to the
977 977
               nodes:
978 978
                 - name: trusty.example.com
979 979
                   labels: trusty-static
980
-                  host-key: fake-key
981 980
                   timeout: 13
982 981
                   connection-port: 22022
982
+                  host-key: fake-key
983 983
                   username: zuul
984 984
                   max-parallel-jobs: 1
985 985
 
986 986
    .. attr:: pools
987 987
       :type: list
988 988
 
989
-      Each entry in a pool's nodes section indicates a static node and
990
-      it's corresponding label.
989
+      A pool defines a group of statically declared nodes.
991 990
 
992 991
       .. note::
993 992
 
@@ -1001,56 +1000,68 @@ Selecting the static driver adds the following options to the
1001 1000
          :type: str
1002 1001
          :required:
1003 1002
 
1004
-         The hostname or ip address of the static node. This must be
1005
-         unique across all nodes defined within the configuration file.
1003
+         Pool name
1006 1004
 
1007
-      .. attr:: labels
1005
+      .. attr:: nodes
1008 1006
          :type: list
1009 1007
          :required:
1010 1008
 
1011
-         The list of labels associated with the node.
1009
+         Each entry indicates a static node and it's attributes.
1012 1010
 
1013
-      .. attr:: username
1014
-         :type: str
1015
-         :default: zuul
1011
+         .. attr:: name
1012
+            :type: str
1013
+            :required:
1016 1014
 
1017
-         The username nodepool will use to validate it can connect to the
1018
-         node.
1015
+            The hostname or ip address of the static node. This must be
1016
+            unique across all nodes defined within the configuration file.
1019 1017
 
1020
-      .. attr:: timeout
1021
-         :type: int
1022
-         :default: 5
1018
+         .. attr:: labels
1019
+            :type: list
1020
+            :required:
1023 1021
 
1024
-         The timeout in second before the ssh ping is considered failed.
1022
+            The list of labels associated with the node.
1025 1023
 
1026
-      .. attr:: host-key
1027
-         :type: str
1024
+         .. attr:: timeout
1025
+            :type: int
1026
+            :default: 5
1028 1027
 
1029
-         The ssh host key of the node.
1028
+            The timeout in second before the ssh ping is considered failed.
1030 1029
 
1031
-      .. attr:: connection-type
1032
-         :type: string
1030
+         .. attr:: connection-type
1031
+            :type: string
1033 1032
 
1034
-         The connection type that a consumer should use when connecting
1035
-         to the node.
1033
+            The connection type that a consumer should use when connecting
1034
+            to the node.
1036 1035
 
1037
-         .. value:: winrm
1036
+            .. value:: winrm
1038 1037
 
1039
-         .. value:: ssh
1038
+            .. value:: ssh
1040 1039
 
1041
-      .. attr:: connection-port
1042
-         :type: int
1043
-         :default: 22 / 5986
1040
+         .. attr:: connection-port
1041
+            :type: int
1042
+            :default: 22 / 5986
1044 1043
 
1045
-         The port that a consumer should use when connecting to the node.
1046
-         For most nodes this is not necessary. This defaults to 22 when
1047
-         ``connection-type`` is 'ssh' and 5986 when it is 'winrm'.
1044
+            The port that a consumer should use when connecting to the node.
1045
+            For most nodes this is not necessary. This defaults to 22 when
1046
+            ``connection-type`` is 'ssh' and 5986 when it is 'winrm'.
1048 1047
 
1049
-      .. attr:: max-parallel-jobs
1050
-         :type: int
1051
-         :default: 1
1048
+         .. attr:: host-key
1049
+            :type: str
1050
+
1051
+            The ssh host key of the node.
1052
+
1053
+         .. attr:: username
1054
+            :type: str
1055
+            :default: zuul
1056
+
1057
+            The username nodepool will use to validate it can connect to the
1058
+            node.
1059
+
1060
+         .. attr:: max-parallel-jobs
1061
+            :type: int
1062
+            :default: 1
1052 1063
 
1053
-         The number of jobs that can run in parallel on this node.
1064
+            The number of jobs that can run in parallel on this node.
1054 1065
 
1055 1066
 
1056 1067
 Kubernetes Driver

Loading…
Cancel
Save