Release 1.8.2

thiell · thiell · commit 8fb420421856 · 2019-08-12T23:16:52.000-07:00
https://clustershell.readthedocs.io/en/v1.8.2/release.html Docs: - add xCAT group bindings - add Library Defaults use cases: rsh and slurm Change-Id: I5e675a0c710033359bcf8b92215d6fc41c5c65d6
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,22 @@
+2019-08-12 S. Thiell <sthiell@stanford.edu>
+
+	* Version 1.8.2 released. The main changes are listed below.
+
+	* CLI/Display: use utf-8 (or non-ascii) encoding (#400)
+
+	* Defaults: add NodeSet's default folding axis (#401)
+
+	* EngineTimer: fix misuse of epsilon when firing timer (#399)
+
+	* xCAT group bindings: performance update (#398)
+
+	* Slurm group bindings: fix issue where job ids were used instead of user
+	names (#405)
+
+	* Doc: disable smartquotes (#402) and fix typo, %r is not for rank (#409)
+
+	* Packaging: add support for RHEL8 (#413)
+
 2018-10-30 S. Thiell <sthiell@stanford.edu>
 
 	* Version 1.8.1 released. The main changes are listed below.
diff --git a/clustershell.spec.in b/clustershell.spec.in
@@ -218,6 +218,9 @@ rm -rf %{buildroot}
 %{vimdatadir}/syntax/groupsconf.vim
 
 %changelog
+* Mon Aug 12 2019 Stephane Thiell <sthiell@stanford.edu> 1.8.2-1
+- update to 1.8.2
+
 * Tue Oct 30 2018 Stephane Thiell <sthiell@stanford.edu> 1.8.1-1
 - update to 1.8.1
 
diff --git a/doc/man/man1/clubak.1 b/doc/man/man1/clubak.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CLUBAK 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"
+.TH CLUBAK 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"
 .SH NAME
 clubak \- format output from clush/pdsh-like output and more
 .
diff --git a/doc/man/man1/cluset.1 b/doc/man/man1/cluset.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CLUSET 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"
+.TH CLUSET 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"
 .SH NAME
 cluset \- compute advanced cluster node set operations
 .
diff --git a/doc/man/man1/clush.1 b/doc/man/man1/clush.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CLUSH 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"
+.TH CLUSH 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"
 .SH NAME
 clush \- execute shell commands on a cluster
 .
diff --git a/doc/man/man1/nodeset.1 b/doc/man/man1/nodeset.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH NODESET 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"
+.TH NODESET 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"
 .SH NAME
 nodeset \- compute advanced nodeset operations
 .
diff --git a/doc/man/man5/clush.conf.5 b/doc/man/man5/clush.conf.5
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH CLUSH.CONF 5 "2018-10-30" "1.8.1" "ClusterShell User Manual"
+.TH CLUSH.CONF 5 "2019-08-12" "1.8.2" "ClusterShell User Manual"
 .SH NAME
 clush.conf \- Configuration file for clush
 .
diff --git a/doc/man/man5/groups.conf.5 b/doc/man/man5/groups.conf.5
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH GROUPS.CONF 5 "2018-10-30" "1.8.1" "ClusterShell User Manual"
+.TH GROUPS.CONF 5 "2019-08-12" "1.8.2" "ClusterShell User Manual"
 .SH NAME
 groups.conf \- Configuration file for ClusterShell node groups
 .
diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.8.1'
+version = '1.8.2'
 # The full version, including alpha/beta/rc tags.
-release = '1.8.1'
+release = '1.8.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/doc/sphinx/config.rst b/doc/sphinx/config.rst
@@ -367,8 +367,10 @@ is not doable. But if the call return zero, for instance, for a non-existing
 group, the user will not receive any error when trying to resolve such unknown
 group. The desired behavior is up to the system administrator.
 
-Slurm bindings (example)
-""""""""""""""""""""""""
+.. _group-slurm-bindings:
+
+Slurm group bindings
+""""""""""""""""""""
 
 Enable Slurm node group bindings by renaming the example configuration file
 usually installed as ``/etc/clustershell/groups.conf.d/slurm.conf.example`` to
@@ -445,15 +447,15 @@ allocated for jobs belonging to the username::
 
     [slurmuser,su]
     map: squeue -h -u $GROUP -o "%N" -t R
-    list: squeue -h -o "%i" -t R
+    list: squeue -h -o "%u" -t R
     reverse: squeue -h -w $NODE -o "%i"
     cache_time: 60
 
 Example of use with :ref:`clush <clush-tool>` to execute a command on all nodes
 with running jobs of username::
 
     $ clush -bw@su:username 'df -Ph /scratch'
-    $ clush -bw@su:username 'du -s /scratch/username' 
+    $ clush -bw@su:username 'du -s /scratch/username'
 
 :ref:`cache_time <group-external-caching>` is also set to 60 seconds instead
 of the default (3600s) to avoid caching results in memory for too long, because
@@ -467,6 +469,50 @@ You can then easily find nodes associated with a Slurm job ID::
      $ nodeset -f @sj:686518
      cluster-[0003,0005,0010,0012,0015,0017,0021,0055]
 
+.. _group-xcat-bindings:
+
+xCAT group bindings
+"""""""""""""""""""
+
+Enable xCAT node group bindings by renaming the example configuration file
+usually installed as ``/etc/clustershell/groups.conf.d/xcat.conf.example`` to
+``xcat.conf``. A single group source is defined in this file and is detailed
+below.
+
+.. warning:: xCAT installs its own `nodeset`_ command which
+   usually takes precedence over ClusterShell's :ref:`nodeset-tool` command.
+   In that case, simply use :ref:`cluset <cluset-tool>` instead.
+
+While examples below are based on the :ref:`cluset-tool` tool, all Python
+tools using ClusterShell and the :class:`.NodeSet`  class will automatically
+benefit from these additional node groups.
+
+.. highlight:: ini
+
+The section **xcat** defines a group source based on xCAT static node groups::
+
+    [xcat]
+
+    # list the nodes in the specified node group
+    map: lsdef -s -t node $GROUP | cut -d' ' -f1
+    
+    # list all the nodes defined in the xCAT tables
+    all: lsdef -s -t node | cut -d' ' -f1
+    
+    # list all groups
+    list: lsdef -t group | cut -d' ' -f1
+
+.. highlight:: console
+
+Example of use with :ref:`cluset-tool`::
+
+    $ lsdef -s -t node dtn
+    sh-dtn01  (node)
+    sh-dtn02  (node)
+    
+    $ cluset -s xcat -f @dtn
+    sh-dtn[01-02]
+
 .. highlight:: text
 
 .. _defaults-config:
@@ -493,5 +539,40 @@ following files is found, in priority order::
     $HOME/.config/clustershell/defaults.conf (only if $XDG_CONFIG_HOME is not defined)
     $HOME/.local/etc/clustershell/defaults.conf
 
+Use case: rsh
+^^^^^^^^^^^^^^
+
+If your cluster uses a rsh variant like ``mrsh`` or ``krsh``, you may want to
+change it in the library defaults.
+
+An example file is usually available in
+``/usr/share/doc/clustershell-*/examples/defaults.conf-rsh`` and could be
+copied to ``/etc/clustershell/defaults.conf`` or to an alternate path
+described above. Basically, the change consists in defining an alternate
+distant worker by Python module name as follow::
+
+    [task.default]
+    distant_workername: Rsh
+
+
+.. _defaults-config-slurm:
+
+Use case: Slurm
+^^^^^^^^^^^^^^^
+
+If your cluster naming scheme has multiple dimensions, as in ``node-93-02``, we
+recommend that you disengage some nD folding when using Slurm, which is
+currently unable to detect some multidimensional node indexes when not
+explicitly enclosed with square brackets.
+
+To do so, define ``fold_axis`` to -1 in the :ref:`defaults-config` so that nD
+folding is only computed on the last axis (seems to work best with Slurm)::
+
+    [nodeset]
+    fold_axis: -1
+
+That way, node sets computed by ClusterShell tools can be passed to Slurm
+without error.
 
 .. _ConfigParser: http://docs.python.org/library/configparser.html
+.. _nodeset: https://xcat-docs.readthedocs.io/en/stable/guides/admin-guides/references/man8/nodeset.8.html
diff --git a/doc/sphinx/guide/taskmgnt.rst b/doc/sphinx/guide/taskmgnt.rst
@@ -227,6 +227,8 @@ executed remotely are not necessary stopped (this is due to *ssh(1)*
 behavior).
 
 
+.. _configuring-a-timer:
+
 Configuring a Timer
 ^^^^^^^^^^^^^^^^^^^
 
diff --git a/doc/sphinx/release.rst b/doc/sphinx/release.rst
@@ -13,6 +13,43 @@ farms! Special thanks to the many of you that have sent us feedback on GitHub!
 
 .. warning:: Support for Python 2.5 and below has been dropped in this version.
 
+Version 1.8.2
+^^^^^^^^^^^^^
+
+This version contains a few minor fixes:
+
+* :ref:`clush-tool`: support UTF-8 string encoding with
+  :ref:`--diff <clush-diff>`
+
+* in some cases, :ref:`timers <configuring-a-timer>` were too fast due to an
+  issue in :class:`.EngineTimer`
+
+* fix issue in the :ref:`Slurm group bindings <group-slurm-bindings>` where job
+  ids were used instead of user names
+
+* performance update for :ref:`xCAT group bindings <group-xcat-bindings>`
+
+For more details, please have a look at `GitHub Issues for 1.8.2 milestone`_.
+
+Python support
+""""""""""""""
+
+Version 1.8.2 adds support for Python 3.7.
+
+.. note:: This version still supports Python 2.6 and thus also RHEL/CentOS
+   6, but please note that ClusterShell 1.9 is expected to require at least
+   Python 2.7.
+
+OS support
+""""""""""
+
+Version 1.8.2 adds support for RHEL 8/CentOS 8 and Fedora 31+, where only the
+Python 3 package is provided. The ``clustershell`` packages will be made
+available in EPEL-8 as soon as possible.
+
+No packaging changes were made to ``clustershell`` in RHEL/CentOS 6 or 7.
+
+
 Version 1.8.1
 ^^^^^^^^^^^^^
 
@@ -499,6 +536,7 @@ Please see :ref:`install-pip-user`.
 .. _GitHub Issues for 1.7.3 milestone: https://github.com/cea-hpc/clustershell/issues?utf8=%E2%9C%93&q=is%3Aissue+milestone%3A1.7.3
 .. _GitHub Issues for 1.8 milestone: https://github.com/cea-hpc/clustershell/issues?utf8=%E2%9C%93&q=is%3Aissue+milestone%3A1.8
 .. _GitHub Issues for 1.8.1 milestone: https://github.com/cea-hpc/clustershell/issues?utf8=%E2%9C%93&q=is%3Aissue+milestone%3A1.8.1
+.. _GitHub Issues for 1.8.2 milestone: https://github.com/cea-hpc/clustershell/issues?utf8=%E2%9C%93&q=is%3Aissue+milestone%3A1.8.2
 .. _LGPL v2.1+: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
 .. _CeCILL-C V1: http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html
 .. _xCAT: https://xcat.org/
diff --git a/doc/sphinx/tools/clush.rst b/doc/sphinx/tools/clush.rst
@@ -388,6 +388,8 @@ even if all nodes have successfully run the command. When you hit CTRL-C with
     2.6.18-164.11.1.el5
     Keyboard interrupt (node1 did not complete).
 
+.. _clush-diff:
+
 Performing *diff* of cluster-wide outputs
 """""""""""""""""""""""""""""""""""""""""
 
diff --git a/doc/sphinx/tools/nodeset.rst b/doc/sphinx/tools/nodeset.rst
@@ -566,6 +566,9 @@ useful to fold along the last axis whatever number of dimensions used::
     $ nodeset --axis=-1 -f comp-[1-2]-[1-36],login-[1-2]
     comp-1-[1-36],comp-2-[1-36],login-[1-2]
 
+See also the :ref:`defaults-config-slurm` of Library Defaults for changing it
+permanently.
+
 .. _nodeset-pick:
 
 Picking N node(s) at random
diff --git a/doc/txt/clubak.txt b/doc/txt/clubak.txt
@@ -7,9 +7,9 @@ format output from clush/pdsh-like output and more
 --------------------------------------------------
 
 :Author: Stephane Thiell <sthiell@stanford.edu>
-:Date:   2018-10-30
+:Date:   2019-08-12
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.1
+:Version: 1.8.2
 :Manual section: 1
 :Manual group: ClusterShell User Manual
 
diff --git a/doc/txt/cluset.txt b/doc/txt/cluset.txt
@@ -7,9 +7,9 @@ compute advanced cluster node set operations
 --------------------------------------------
 
 :Author: Stephane Thiell <sthiell@stanford.edu>
-:Date:   2018-10-30
+:Date:   2019-08-12
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.1
+:Version: 1.8.2
 :Manual section: 1
 :Manual group: ClusterShell User Manual
 
diff --git a/doc/txt/clush.conf.txt b/doc/txt/clush.conf.txt
@@ -7,9 +7,9 @@ Configuration file for `clush`
 ------------------------------
 
 :Author: Stephane Thiell, <sthiell@stanford.edu>
-:Date:   2018-10-30
+:Date:   2019-08-12
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.1
+:Version: 1.8.2
 :Manual section: 5
 :Manual group: ClusterShell User Manual
 
diff --git a/doc/txt/clush.txt b/doc/txt/clush.txt
@@ -7,9 +7,9 @@ execute shell commands on a cluster
 -----------------------------------
 
 :Author: Stephane Thiell <sthiell@stanford.edu>
-:Date:   2018-10-30
+:Date:   2019-08-12
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.1
+:Version: 1.8.2
 :Manual section: 1
 :Manual group: ClusterShell User Manual
 
diff --git a/doc/txt/groups.conf.txt b/doc/txt/groups.conf.txt
@@ -7,9 +7,9 @@ Configuration file for ClusterShell node groups
 -----------------------------------------------
 
 :Author: Stephane Thiell, <sthiell@stanford.edu>
-:Date:   2018-10-30
+:Date:   2019-08-12
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.1
+:Version: 1.8.2
 :Manual section: 5
 :Manual group: ClusterShell User Manual
 
diff --git a/doc/txt/nodeset.txt b/doc/txt/nodeset.txt
@@ -7,9 +7,9 @@ compute advanced nodeset operations
 -----------------------------------
 
 :Author: Stephane Thiell <sthiell@stanford.edu>
-:Date:   2018-10-30
+:Date:   2019-08-12
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.1
+:Version: 1.8.2
 :Manual section: 1
 :Manual group: ClusterShell User Manual
 
diff --git a/lib/ClusterShell/__init__.py b/lib/ClusterShell/__init__.py
@@ -34,8 +34,8 @@
   - ClusterShell.Task
 """
 
-__version__ = '1.8.1'
+__version__ = '1.8.2'
 __version_info__ = tuple([ int(_n) for _n in __version__.split('.')])
-__date__    = '2018/10/30'
+__date__    = '2019/08/12'
 __author__  = 'Stephane Thiell <sthiell@stanford.edu>'
 __url__     = 'http://clustershell.readthedocs.org/'
diff --git a/setup.py b/setup.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 #
 # Copyright (C) 2008-2016 CEA/DAM
-# Copyright (C) 2016-2018 Stephane Thiell <sthiell@stanford.edu>
+# Copyright (C) 2016-2019 Stephane Thiell <sthiell@stanford.edu>
 #
 # This file is part of ClusterShell.
 #
@@ -23,7 +23,7 @@
 from setuptools import setup, find_packages
 
 
-VERSION = '1.8.1'
+VERSION = '1.8.2'
 
 # Default CFGDIR: in-prefix config install (rpmbuild or pip as user)
 CFGDIR = 'etc/clustershell'

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.\" Man page generated from reStructuredText.`
`2`	`2`	`.`
`3`		`-.TH CLUBAK 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"`
	`3`	`+.TH CLUBAK 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`clubak \- format output from clush/pdsh-like output and more`
`6`	`6`	`.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.\" Man page generated from reStructuredText.`
`2`	`2`	`.`
`3`		`-.TH CLUSET 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"`
	`3`	`+.TH CLUSET 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`cluset \- compute advanced cluster node set operations`
`6`	`6`	`.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.\" Man page generated from reStructuredText.`
`2`	`2`	`.`
`3`		`-.TH CLUSH 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"`
	`3`	`+.TH CLUSH 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`clush \- execute shell commands on a cluster`
`6`	`6`	`.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.\" Man page generated from reStructuredText.`
`2`	`2`	`.`
`3`		`-.TH NODESET 1 "2018-10-30" "1.8.1" "ClusterShell User Manual"`
	`3`	`+.TH NODESET 1 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`nodeset \- compute advanced nodeset operations`
`6`	`6`	`.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.\" Man page generated from reStructuredText.`
`2`	`2`	`.`
`3`		`-.TH CLUSH.CONF 5 "2018-10-30" "1.8.1" "ClusterShell User Manual"`
	`3`	`+.TH CLUSH.CONF 5 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`clush.conf \- Configuration file for clush`
`6`	`6`	`.`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`.\" Man page generated from reStructuredText.`
`2`	`2`	`.`
`3`		`-.TH GROUPS.CONF 5 "2018-10-30" "1.8.1" "ClusterShell User Manual"`
	`3`	`+.TH GROUPS.CONF 5 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`groups.conf \- Configuration file for ClusterShell node groups`
`6`	`6`	`.`