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

NAME

6       groups.conf - Configuration file for ClusterShell external node groups
7

DESCRIPTION

9       The ClusterShell library obtains node groups configuration options from
10       the system-wide configuration file /etc/clustershell/groups.conf.
11
12       The configuration file has a format in the style of RFC 822 composed of
13       several sections which may be present in any order. Sections are:
14
15       Main   General options definition
16
17       Group_source
18
19              External commands definition for group source Group_source (map,
20              all, list and reverse)
21
22   [Main]
23       Configuration parameters of the Main section are described below.
24
25       default
26              Specify the default group source used by the NodeSet parser when
27              the  user  does  not  specify  explicitly  the group source (eg.
28              "@io").
29
30   Group_source
31       Configuration parameters of each group  source  section  are  described
32       below.
33
34       map    Specify  the external shell command used to resolve a group name
35              into a nodeset, list of nodes or list of nodeset  (separated  by
36              space characters or by carriage returns). The variable $GROUP is
37              replaced before executing the command.
38
39       all    Optional external shell command that should  return  a  nodeset,
40              list  of  nodes  or  list of nodeset of all nodes for this group
41              source. If not specified, the library will try  to  resolve  all
42              nodes  by  using  the  list  external  command in the same group
43              source followed by map for each group.
44
45       list   Optional external shell command that should return the  list  of
46              all  groups for this group source (separated by space characters
47              or by carriage returns).
48
49       reverse
50              Optional external shell command used to find the group(s)  of  a
51              single  node. The variable $NODE is previously replaced. If this
52              upcall is not specified, the reverse operation  is  computed  in
53              memory  by  the  library  from  the list and map external calls.
54              Also, if the number of nodes to reverse is greater than the num‐
55              ber of available groups, the reverse external command is avoided
56              automatically.
57
58       Each external command might return a  non-zero  return  code  when  the
59       operation is not doable. But if the call return zero, for instance, for
60       a non-existing group, the user will not receive any error  when  trying
61       to resolve such unknown group.  The desired behaviour is up to the sys‐
62       tem administrator.
63

RESOURCE USAGE

65       All external command results are cached in  memory  to  avoid  multiple
66       calls.
67

EXAMPLES

69       Simple  configuration  file for local groups and slurm partitions bind‐
70       ing.
71
72   groups.conf
73       [Main]
74       default: local
75
76       [local]
77       map:  awk -F: '/^$GROUP:/ {print $2}' /etc/clustershell/groups
78       list: awk -F: '/^w/ {print $1}' /etc/clustershell/groups
79
80       [slurm]
81       map: sinfo -h -o "%N" -p $GROUP
82       all: sinfo -h -o "%N"
83       list: sinfo -h -o "%P"
84       reverse: sinfo -h -N -o "%P" -n $NODE
85
86

FILES

88       /etc/clustershell/groups.conf
89
90              System-wide external node groups configuration file.
91

SEE ALSO

93       clush(1), clubak(1), nodeset(1)
94
95       http://clustershell.sourceforge.net/
96

AUTHOR

98       Stephane Thiell, CEA DAM  <stephane.thiell@cea.fr>
99

101       CeCILL-C V1
102
103
104
105
1061.5.1                             2011-06-09                    GROUPS.CONF(5)
Impressum