Skip to content

Commit

Permalink
Release 1.9.2
Browse files Browse the repository at this point in the history
  • Loading branch information
thiell committed Sep 29, 2023
1 parent c1c6fb1 commit e581b9a
Show file tree
Hide file tree
Showing 20 changed files with 136 additions and 96 deletions.
14 changes: 14 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
2023-09-29 S. Thiell <[email protected]>

* Version 1.9.2 released. The main changes are listed below.

* CLI: fix line buffering with Python 3 (#528)

* clush: fix --[r]copy dest when --dest is omitted (#525)

* NodeUtils: allow null values in cluster.yaml (#533)

* Topology: check that node groups/wildcards are non-empty (#527)

* rpm: xcat.conf.example missing (#526)

2023-02-09 S. Thiell <[email protected]>

* Version 1.9.1 released. The main changes are listed below.
Expand Down
3 changes: 3 additions & 0 deletions clustershell.spec.in
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,9 @@ rm -rf %{buildroot}
%{vimdatadir}/syntax/groupsconf.vim

%changelog
* Fri Sep 29 2023 Stephane Thiell <[email protected]> 1.9.2-1
- update to 1.9.2

* Thu Feb 9 2023 Stephane Thiell <[email protected]> 1.9.1-1
- update to 1.9.1

Expand Down
2 changes: 1 addition & 1 deletion doc/man/man1/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SOURCES := $(SRCDIR)/clubak.txt \
OBJECTS := $(SOURCES:$(SRCDIR)/%.txt=%.1)

%.1: ../../txt/%.txt
rst2man -v $< $@
rst2man $< $@

all: $(OBJECTS)

Expand Down
30 changes: 15 additions & 15 deletions doc/man/man1/clubak.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.\" Man page generated from reStructuredText.
.
.TH CLUBAK 1 "2023-09-29" "1.9.2" "ClusterShell User Manual"
.SH NAME
clubak \- format output from clush/pdsh-like output and more
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -27,22 +30,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUBAK" 1 "2023-02-09" "1.9.1" "ClusterShell User Manual"
.SH NAME
clubak \- format output from clush/pdsh-like output and more
.SH SYNOPSIS
.sp
\fBclubak\fP [ OPTIONS ]
.SH DESCRIPTION
.sp
\fBclubak\fP formats text from standard input containing lines of the form
\(dq\fInode:output\fP\(dq. It is fully backward compatible with \fBdshbak\fP(1) but
"\fInode:output\fP". It is fully backward compatible with \fBdshbak\fP(1) but
provides additional features. For instance, \fBclubak\fP always displays
its results sorted by node/nodeset.
.sp
You do not need to use \fBclubak\fP when using \fBclush\fP(1) as all output
formatting features are already included in. It is provided for other usages,
like post\-processing results of the form \(dq\fInode:output\fP\(dq.
like post\-processing results of the form "\fInode:output\fP".
.sp
Like \fBclush\fP(1), \fBclubak\fP uses the \fIClusterShell.MsgTree\fP module of the
ClusterShell library (see \fBpydoc ClusterShell.MsgTree\fP).
Expand All @@ -52,20 +52,20 @@ ClusterShell library (see \fBpydoc ClusterShell.MsgTree\fP).
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-version
.B \-\-version
show \fBclubak\fP version number and exit
.TP
.B \-b\fP,\fB \-c
.B \-b\fP,\fB \-c
gather nodes with same output (\-c is provided for \fBdshbak\fP(1)
compatibility)
.TP
.B \-d\fP,\fB \-\-debug
.B \-d\fP,\fB \-\-debug
output more messages for debugging purpose
.TP
.B \-L
.B \-L
disable header block and order output by nodes
.TP
.B \-r\fP,\fB \-\-regroup
.B \-r\fP,\fB \-\-regroup
fold nodeset using node groups
.TP
.BI \-s \ GROUPSOURCE\fR,\fB \ \-\-groupsource\fB= GROUPSOURCE
Expand All @@ -74,22 +74,22 @@ optional \fBgroups.conf\fP(5) group source to use
.BI \-\-groupsconf\fB= FILE
use alternate config file for groups.conf(5)
.TP
.B \-G\fP,\fB \-\-groupbase
.B \-G\fP,\fB \-\-groupbase
do not display group source prefix (always \fI@groupname\fP)
.TP
.BI \-S \ SEPARATOR\fR,\fB \ \-\-separator\fB= SEPARATOR
node / line content separator string (default: \fI:\fP)
.TP
.B \-F\fP,\fB \-\-fast
.B \-F\fP,\fB \-\-fast
faster but memory hungry mode (preload all messages per node)
.TP
.B \-T\fP,\fB \-\-tree
.B \-T\fP,\fB \-\-tree
message tree trace mode; switch to enable \fBClusterShell.MsgTree\fP trace mode, all keys/nodes being kept for each message element of the tree, thus allowing special output gathering
.TP
.BI \-\-color\fB= WHENCOLOR
\fBclush\fP can use NO_COLOR, CLICOLOR and CLICOLOR_FORCE environment variables. \fB\-\-color\fP command line option always takes precedence over environment variables. NO_COLOR takes precedence over CLICOLOR_FORCE which takes precedence over CLICOLOR. \fB\-\-color\fP tells whether to use ANSI colors to surround node or nodeset prefix/header with escape sequences to display them in color on the terminal. \fIWHENCOLOR\fP is \fBnever\fP, \fBalways\fP or \fBauto\fP (which use color if standard output refers to a terminal). Color is set to [34m (blue foreground text) and cannot be modified.
.TP
.B \-\-diff
.B \-\-diff
show diff between gathered outputs
.UNINDENT
.SH EXIT STATUS
Expand Down Expand Up @@ -121,7 +121,7 @@ Another example, iterate over \fInode*\fP text files in current directory and ga
.INDENT 3.0
.INDENT 3.5
.nf
# find \-name \(dqnode*\(dq \-exec wc \-c {} ; | awk \(aq{ gsub(\(dq./\(dq,\(dq\(dq,$2); print $2\(dq: \(dq$1 }\(aq | clubak \-bL
# find \-name "node*" \-exec wc \-c {} ; | awk \(aq{ gsub("./","",$2); print $2": "$1 }\(aq | clubak \-bL
node[1,3]: 7
node2: 9
.fi
Expand Down
44 changes: 22 additions & 22 deletions doc/man/man1/cluset.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
.\" Man page generated from reStructuredText.
.
.TH CLUSET 1 "2023-09-29" "1.9.2" "ClusterShell User Manual"
.SH NAME
cluset \- compute advanced cluster node set operations
.
.nr rst2man-indent-level 0
.
Expand Down Expand Up @@ -27,9 +30,6 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CLUSET" 1 "2023-02-09" "1.9.1" "ClusterShell User Manual"
.SH NAME
cluset \- compute advanced cluster node set operations
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
Expand All @@ -53,10 +53,10 @@ administration shell scripts.
.INDENT 3.5
.INDENT 0.0
.TP
.B \-\-version
.B \-\-version
show program\(aqs version number and exit
.TP
.B \-h\fP,\fB \-\-help
.B \-h\fP,\fB \-\-help
show this help message and exit
.TP
.BI \-s \ GROUPSOURCE\fR,\fB \ \-\-groupsource\fB= GROUPSOURCE
Expand All @@ -70,22 +70,22 @@ use alternate config file for groups.conf(5)
.B Commands:
.INDENT 7.0
.TP
.B \-c\fP,\fB \-\-count
.B \-c\fP,\fB \-\-count
show number of nodes in nodeset(s)
.TP
.B \-e\fP,\fB \-\-expand
.B \-e\fP,\fB \-\-expand
expand nodeset(s) to separate nodes (see also \-S \fISEPARATOR\fP)
.TP
.B \-f\fP,\fB \-\-fold
.B \-f\fP,\fB \-\-fold
fold nodeset(s) (or separate nodes) into one nodeset
.TP
.B \-l\fP,\fB \-\-list
.B \-l\fP,\fB \-\-list
list node groups, list node groups and nodes (\fB\-ll\fP) or list node groups, nodes and node count (\fB\-lll\fP). When no argument is specified at all, this command will list all node group names found in selected group source (see also \-s \fIGROUPSOURCE\fP). If any nodesets are specified as argument, this command will find node groups these nodes belongs to (individually). Optionally for each group, the fraction of these nodes being member of the group may be displayed (with \fB\-ll\fP), and also member count/total group node count (with \fB\-lll\fP). If a single hyphen\-minus (\-) is given as a nodeset, it will be read from standard input.
.TP
.B \-r\fP,\fB \-\-regroup
.B \-r\fP,\fB \-\-regroup
fold nodes using node groups (see \-s \fIGROUPSOURCE\fP)
.TP
.B \-\-groupsources
.B \-\-groupsources
list all active group sources (see \fBgroups.conf\fP(5))
.UNINDENT
.TP
Expand All @@ -105,23 +105,23 @@ calculate symmetric difference between sets
.B Options:
.INDENT 7.0
.TP
.B \-a\fP,\fB \-\-all
.B \-a\fP,\fB \-\-all
call external node groups support to display all nodes
.TP
.BI \-\-autostep\fB= AUTOSTEP
enable a\-b/step style syntax when folding nodesets, value is min node count threshold (integer \(aq4\(aq, percentage \(aq50%\(aq or \(aqauto\(aq). If not specified, auto step is disabled (best for compatibility with other cluster tools. Example: autostep=4, \(dqnode2 node4 node6\(dq folds in node[2,4,6] but autostep=3, \(dqnode2 node4 node6\(dq folds in node[2\-6/2].
enable a\-b/step style syntax when folding nodesets, value is min node count threshold (integer \(aq4\(aq, percentage \(aq50%\(aq or \(aqauto\(aq). If not specified, auto step is disabled (best for compatibility with other cluster tools. Example: autostep=4, "node2 node4 node6" folds in node[2,4,6] but autostep=3, "node2 node4 node6" folds in node[2\-6/2].
.TP
.B \-d\fP,\fB \-\-debug
.B \-d\fP,\fB \-\-debug
output more messages for debugging purpose
.TP
.B \-q\fP,\fB \-\-quiet
.B \-q\fP,\fB \-\-quiet
be quiet, print essential output only
.TP
.B \-R\fP,\fB \-\-rangeset
.B \-R\fP,\fB \-\-rangeset
switch to RangeSet instead of NodeSet. Useful when
working on numerical cluster ranges, eg. 1,5,18\-31
.TP
.B \-G\fP,\fB \-\-groupbase
.B \-G\fP,\fB \-\-groupbase
hide group source prefix (always \fI@groupname\fP)
.TP
.BI \-S \ SEPARATOR\fR,\fB \ \-\-separator\fB= SEPARATOR
Expand All @@ -132,13 +132,13 @@ separator string to use when expanding nodesets
output format (default: \(aq%s\(aq)
.TP
.BI \-I \ SLICE_RANGESET\fR,\fB \ \-\-slice\fB= SLICE_RANGESET
return sliced off result; examples of SLICE_RANGESET are \(dq0\(dq for simple index selection, or \(dq1\-9/2,16\(dq for complex rangeset selection
return sliced off result; examples of SLICE_RANGESET are "0" for simple index selection, or "1\-9/2,16" for complex rangeset selection
.TP
.BI \-\-split\fB= MAXSPLIT
split result into a number of subsets
.TP
.B \-\-contiguous
split result into contiguous subsets (ie. for nodeset, subsets will contain nodes with same pattern name and a contiguous range of indexes, like foobar[1\-100]; for rangeset, subsets with consists in contiguous index ranges)\(dq\(dq\(dq
.B \-\-contiguous
split result into contiguous subsets (ie. for nodeset, subsets will contain nodes with same pattern name and a contiguous range of indexes, like foobar[1\-100]; for rangeset, subsets with consists in contiguous index ranges)"""
.TP
.BI \-\-axis\fB= RANGESET
for nD nodesets, fold along provided axis only. Axis are indexed from 1 to n and can be specified here either using the rangeset syntax, eg. \(aq1\(aq, \(aq1\-2\(aq, \(aq1,3\(aq, or by a single negative number meaning that the indices is counted from the end. Because some nodesets may have several different dimensions, axis indices are silently truncated to fall in the allowed range.
Expand Down Expand Up @@ -225,7 +225,7 @@ node[0\-4,11\-13]
.sp
This computes a folded nodeset containing nodes found in group @gpu and @slurm:bigmem, but not in both, minus the nodes found in odd chassis groups from 1 to 9.
.TP
.B \(dqAll nodes\(dq extension
.B "All nodes" extension
The \fB@*\fP and \fB@SOURCE:*\fP special notations may be used in extended patterns to represent all nodes (in SOURCE) according to the \fIall\fP external shell command (see \fBgroups.conf\fP(5)) and are equivalent to:
.INDENT 7.0
.INDENT 3.5
Expand Down Expand Up @@ -469,7 +469,7 @@ dc3n[4\-5]
.SH HISTORY
.sp
\fBcluset\fP was added in 1.7.3 to avoid a conflict with xCAT\(aqs \fBnodeset\fP
command and also to conform with ClusterShell\(aqs \(dqclu*\(dq command nomenclature.
command and also to conform with ClusterShell\(aqs "clu*" command nomenclature.
.SH SEE ALSO
.sp
\fBclubak\fP(1), \fBclush\fP(1), \fBnodeset\fP(1), \fBgroups.conf\fP(5).
Expand Down
5 changes: 1 addition & 4 deletions doc/man/man1/clush.1
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH CLUSH 1 "2023-02-09" "1.9.1" "ClusterShell User Manual"
.TH CLUSH 1 "2023-09-29" "1.9.2" "ClusterShell User Manual"
.SH NAME
clush \- execute shell commands on a cluster
.
Expand Down Expand Up @@ -165,9 +165,6 @@ optional \fBgroups.conf\fP(5) group source to use
.B \-n\fP,\fB \-\-nostdin
do not watch for possible input from stdin; this should be used when \fBclush\fP is run in the background (or in scripts).
.TP
.B \-\-sudo
enable sudo password prompt: a prompt will ask for your sudo password and sudo will be used to run your commands on the target nodes. The password must be the same on all target nodes. The actual sudo command used by \fBclush\fP can be changed in \fBclush.conf\fP(5) or in command line using \fB\-O sudo_command="..."\fP\&. The configured \fBsudo_command\fP must be able to read a password on stdin followed by a new line (which is what \fBsudo \-S\fP does).
.TP
.BI \-\-groupsconf\fB= FILE
use alternate config file for groups.conf(5)
.TP
Expand Down
Loading

0 comments on commit e581b9a

Please sign in to comment.