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 pa‐
42              rameter 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  clush can use NO_COLOR, CLICOLOR and CLICOLOR_FORCE  environment
52              variables.  NO_COLOR  takes precedence over CLICOLOR_FORCE which
53              takes precedence over CLICOLOR. When the option is set  in  con‐
54              figuration  file  environment  variables  are taken into account
55              only with auto argument.  color tells  whether to use ANSI  col‐
56              ors  to  surround  node or nodeset prefix/header with escape se‐
57              quences to display them in color on the terminal.   Valid  argu‐
58              ments  are  never,  always  or auto (which use color if standard
59              output/error refer to a terminal). Colors are set to [34m  (blue
60              foreground  text)  for stdout and [31m (red foreground text) for
61              stderr, and cannot be modified.
62
63       fd_max Maximum number of open  file  descriptors  permitted  per  clush
64              process  (soft  resource  limit  for open files). This limit can
65              never exceed the system (hard) limit. The fd_max (soft) and sys‐
66              tem  (hard)  limits should be high enough to run clush, although
67              their values depend on your fanout value.
68
69       history_size
70              Set the maximum number of history entries saved in the GNU read‐
71              line  history list. Negative values imply unlimited history file
72              size.
73
74       node_count
75              Should clush display additional (node count) information in buf‐
76              fer header? (yes/no)
77
78       maxrc  Should  clush  return  the  largest  of  command  return  codes?
79              (yes/no)
80
81       verbosity
82              Set the verbosity level: 0 (quiet), 1 (default), 2 (verbose)  or
83              more (debug).
84
85       ssh_user
86              Set the ssh user to use for remote connection (default is to not
87              specify).
88
89       ssh_path
90              Set the ssh binary path to use for remote connection (default is
91              ssh).
92
93       ssh_options
94              Set additional options to pass to the underlying ssh command.
95
96       scp_path
97              Set the scp binary path to use for remote copy (default is scp).
98
99       scp_options
100              Set additional options to pass to the underlying scp command. If
101              not specified, ssh_options are used instead.
102
103       rsh_path
104              Set the rsh binary path to use for remote connection (default is
105              rsh).  You could easily use mrsh or krsh by simply changing this
106              value.
107
108       rcp_path
109              Same a rsh_path for rcp command. (Default is rcp)
110
111       rsh_options
112              Set additional options to pass to the  underlying  rsh/rcp  com‐
113              mand.
114

EXAMPLES

116       Simple configuration file.
117
118   clush.conf
119       [Main]
120       fanout: 128
121       connect_timeout: 15
122       command_timeout: 0
123       history_size: 100
124       color: auto
125       fd_max: 10240
126       maxrc: no
127       node_count: yes
128
129
130

FILES

132       /etc/clustershell/clush.conf
133              System-wide clush configuration file.
134
135       $XDG_CONFIG_HOME/clustershell/clush.conf
136              User  configuration  file  for clush. If $XDG_CONFIG_HOME is not
137              defined, $HOME/.config/clustershell/clush.conf is used instead.
138
139       $HOME/.local/etc/clustershell/clush.conf
140              Local user configuration file for  clush  (default  installation
141              for pip --user)
142
143       ~/.clush.conf
144              Deprecated per-user clush configuration file.
145

HISTORY

147       As  of  ClusterShell version 1.3, the External section has been removed
148       from clush.conf.  External commands whose outputs were  used  by  clush
149       (-a,  -g,  -X)  are  now  handled  by the library itself and defined in
150       groups.conf(5).
151

AUTHOR

158       Stephane Thiell, <sthiell@stanford.edu>
159

COPYRIGHT

161       GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
162
163
164
165
1661.8.4                             2021-11-03                     CLUSH.CONF(5)