clush.conf(5)

1CLUSH.CONF(5)              ClusterShell User Manual              CLUSH.CONF(5)
2
3
4

NAME

6       clush.conf - Configuration file for clush
7

DESCRIPTION

9       clush(1)  obtains  configuration  options from the following sources in
10       the following order:
11
12          1. command-line options
13
14          2. user      configuration      file      ($XDG_CONFIG_HOME/cluster‐
15             shell/clush.conf)
16
17          3. local    pip    user    installation   ($HOME/.local/etc/cluster‐
18             shell/clush.conf)
19
20          4. system-wide configuration file (/etc/clustershell/clush.conf)
21
22       For each parameter, the first obtained value will be used.
23
24       The configuration file has a format in the style of RFC 822 composed of
25       one main section:
26
27       Main   Program options definition
28
29   [Main]
30       Configuration parameters of the Main section are described below.
31
32       fanout Size  of  the  sliding  window  (fanout)  of active commands for
33              clush. This fanout is used to avoid too many concurrent  connec‐
34              tions and to conserve resources on the initiating hosts. In tree
35              mode, the same fanout value is used on the head node and on each
36              gateway  (the  fanout  value  is  propagated).   That is, if the
37              fanout is 16 on the head node, each gateway will initate  up  to
38              16 connections to their target nodes at the same time.
39
40       connect_timeout
41              Timeout  in  seconds  to  allow  a connection to establish. This
42              parameter is passed to ssh. If set to 0, no timeout occurs.
43
44       command_timeout
45              Timeout in seconds to allow a command to complete since the con‐
46              nection  has  been established. This parameter is passed to ssh.
47              In addition, the ClusterShell library ensures that any  commands
48              complete  in less than ( connect_timeout + command_timeout ). If
49              set to 0, no timeout occurs.
50
51       color  Whether to use ANSI colors to  surround  node  or  nodeset  pre‐
52              fix/header with escape sequences to display them in color on the
53              terminal. Valid arguments are never, always or auto  (which  use
54              color  if standard output/error refer to a terminal). Colors are
55              set to [34m (blue foreground text)  for  stdout  and  [31m  (red
56              foreground text) for stderr, and cannot be modified.
57
58       fd_max Maximum  number  of  open  file  descriptors permitted per clush
59              process (soft resource limit for open  files).  This  limit  can
60              never exceed the system (hard) limit. The fd_max (soft) and sys‐
61              tem (hard) limits should be high enough to run  clush,  although
62              their values depend on your fanout value.
63
64       history_size
65              Set the maximum number of history entries saved in the GNU read‐
66              line history list. Negative values imply unlimited history  file
67              size.
68
69       node_count
70              Should clush display additional (node count) information in buf‐
71              fer header? (yes/no)
72
73       verbosity
74              Set the verbosity level: 0 (quiet), 1 (default), 2 (verbose)  or
75              more (debug).
76
77       ssh_user
78              Set the ssh user to use for remote connection (default is to not
79              specify).
80
81       ssh_path
82              Set the ssh binary path to use for remote connection (default is
83              ssh).
84
85       ssh_options
86              Set additional options to pass to the underlying ssh command.
87
88       scp_path
89              Set the scp binary path to use for remote copy (default is scp).
90
91       scp_options
92              Set additional options to pass to the underlying scp command. If
93              not specified, ssh_options are used instead.
94
95       rsh_path
96              Set the rsh binary path to use for remote connection (default is
97              rsh).  You could easily use mrsh or krsh by simply changing this
98              value.
99
100       rcp_path
101              Same a rsh_path for rcp command. (Default is rcp)
102
103       rsh_options
104              Set additional options to pass to the  underlying  rsh/rcp  com‐
105              mand.
106

EXAMPLES

108       Simple configuration file.
109
110   clush.conf
111       [Main]
112       fanout: 128
113       connect_timeout: 15
114       command_timeout: 0
115       history_size: 100
116       color: auto
117       fd_max: 10240
118       node_count: yes
119
120
121

FILES

123       /etc/clustershell/clush.conf
124              System-wide clush configuration file.
125
126       $XDG_CONFIG_HOME/clustershell/clush.conf
127              User  configuration  file  for clush. If $XDG_CONFIG_HOME is not
128              defined, $HOME/.config/clustershell/clush.conf is used instead.
129
130       $HOME/.local/etc/clustershell/clush.conf
131              Local user configuration file for  clush  (default  installation
132              for pip --user)
133
134       ~/.clush.conf
135              Deprecated per-user clush configuration file.
136

HISTORY

138       As  of  ClusterShell version 1.3, the External section has been removed
139       from clush.conf.  External commands whose outputs were  used  by  clush
140       (-a,  -g,  -X)  are  now  handled  by the library itself and defined in
141       groups.conf(5).
142

AUTHOR

149       Stephane Thiell, <sthiell@stanford.edu>
150

COPYRIGHT

152       GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
153
154
155
156
1571.8.3                             2019-12-01                     CLUSH.CONF(5)