summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2019-02-22 21:02:25 +0000
committerGerrit Code Review <review@openstack.org>2019-02-22 21:02:25 +0000
commit6058bbeeba2777b6dfbd0aac40c424396083f59c (patch)
treea08ac24d057a0605c1297599c768df10fae15532
parente8ac13027e35e804712467f46740542287d0992f (diff)
parentc4f4279cb358e16d732af0cbf9945499a8f2d757 (diff)
Merge "doc bugfix for static provider"
-rw-r--r--doc/source/configuration.rst81
1 files changed, 46 insertions, 35 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst
index e4ab60b..882f87a 100644
--- a/doc/source/configuration.rst
+++ b/doc/source/configuration.rst
@@ -977,17 +977,16 @@ Selecting the static driver adds the following options to the
977 nodes: 977 nodes:
978 - name: trusty.example.com 978 - name: trusty.example.com
979 labels: trusty-static 979 labels: trusty-static
980 host-key: fake-key
981 timeout: 13 980 timeout: 13
982 connection-port: 22022 981 connection-port: 22022
982 host-key: fake-key
983 username: zuul 983 username: zuul
984 max-parallel-jobs: 1 984 max-parallel-jobs: 1
985 985
986 .. attr:: pools 986 .. attr:: pools
987 :type: list 987 :type: list
988 988
989 Each entry in a pool's nodes section indicates a static node and 989 A pool defines a group of statically declared nodes.
990 it's corresponding label.
991 990
992 .. note:: 991 .. note::
993 992
@@ -1001,56 +1000,68 @@ Selecting the static driver adds the following options to the
1001 :type: str 1000 :type: str
1002 :required: 1001 :required:
1003 1002
1004 The hostname or ip address of the static node. This must be 1003 Pool name
1005 unique across all nodes defined within the configuration file.
1006 1004
1007 .. attr:: labels 1005 .. attr:: nodes
1008 :type: list 1006 :type: list
1009 :required: 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 1011 .. attr:: name
1014 :type: str 1012 :type: str
1015 :default: zuul 1013 :required:
1016 1014
1017 The username nodepool will use to validate it can connect to the 1015 The hostname or ip address of the static node. This must be
1018 node. 1016 unique across all nodes defined within the configuration file.
1019 1017
1020 .. attr:: timeout 1018 .. attr:: labels
1021 :type: int 1019 :type: list
1022 :default: 5 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 1024 .. attr:: timeout
1027 :type: str 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 1030 .. attr:: connection-type
1032 :type: string 1031 :type: string
1033 1032
1034 The connection type that a consumer should use when connecting 1033 The connection type that a consumer should use when connecting
1035 to the node. 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 1040 .. attr:: connection-port
1042 :type: int 1041 :type: int
1043 :default: 22 / 5986 1042 :default: 22 / 5986
1044 1043
1045 The port that a consumer should use when connecting to the node. 1044 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 1045 For most nodes this is not necessary. This defaults to 22 when
1047 ``connection-type`` is 'ssh' and 5986 when it is 'winrm'. 1046 ``connection-type`` is 'ssh' and 5986 when it is 'winrm'.
1048 1047
1049 .. attr:: max-parallel-jobs 1048 .. attr:: host-key
1050 :type: int 1049 :type: str
1051 :default: 1 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
1056Kubernetes Driver 1067Kubernetes Driver