Release 1.8.3

thiell · thiell · commit 20b479576759 · 2019-12-01T11:19:45.000-08:00
https://clustershell.readthedocs.io/en/v1.8.3/release.html Docs: - add RHEL/CentOS 8 - add Linux distribution's Python support matrix Change-Id: If0cd293dbb8aca06b0f6809466276f973740e8d9
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,15 @@
+2019-12-01 S. Thiell <sthiell@stanford.edu>
+
+	* Version 1.8.3 released. The main changes are listed below.
+
+	* NodeUtils: use yaml.safe_load() instead of default loader (#417)
+
+	* Tree-mode doesn't work with multi-hop gateways (#419)
+
+	* Silent error on Python version mismatch with gateway (#388)
+
+	* clush: support --worker/-R when topology.conf is present (#386)
+
 2019-08-12 S. Thiell <sthiell@stanford.edu>
 
 	* Version 1.8.2 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
+* Sun Dec  1 2019 Stephane Thiell <sthiell@stanford.edu> 1.8.3-1
+- update to 1.8.3
+
 * Mon Aug 12 2019 Stephane Thiell <sthiell@stanford.edu> 1.8.2-1
 - update to 1.8.2
 
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 "2019-08-12" "1.8.2" "ClusterShell User Manual"
+.TH CLUBAK 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"
+.TH CLUSET 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"
+.TH CLUSH 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"
+.TH NODESET 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"
+.TH CLUSH.CONF 5 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"
+.TH GROUPS.CONF 5 "2019-12-01" "1.8.3" "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
@@ -41,16 +41,16 @@
 
 # General information about the project.
 project = u'clustershell'
-copyright = u'2017, Stephane Thiell'
+copyright = u'2019, Stephane Thiell'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.8.2'
+version = '1.8.3'
 # The full version, including alpha/beta/rc tags.
-release = '1.8.2'
+release = '1.8.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/doc/sphinx/install.rst b/doc/sphinx/install.rst
@@ -6,11 +6,12 @@ Installation
 ClusterShell is distributed in several packages. On RedHat-like OS, we
 recommend to use the RPM package (.rpm) distribution.
 
-As a system software for cluster, ClusterShell is primarily made for
+As system software for cluster, ClusterShell is primarily made for
 system-wide installation to be used by system administrators. However,
-changes have been made so that it's now easy to install it without
+changes have been made so that it's now possible to install it without
 root access (see :ref:`install-pip-user`).
 
+.. _install-requirements:
 
 Requirements
 ------------
@@ -26,9 +27,10 @@ For instance, ClusterShell is known to work on the following operating systems:
 
 * GNU/Linux RHEL or CentOS 6 (Python 2.6)
 * GNU/Linux RHEL or CentOS 7 (Python 2.7)
-* GNU/Linux Fedora 22 to 26 (Python 2.6 or 2.7)
-* GNU/Linux Debian wheezy and above (Python 2.7)
-* Mac OS X 10.8+ (Python 2.6 or 2.7)
+* GNU/Linux RHEL or CentOS 8 (Python 3.6)
+* GNU/Linux Fedora 22 and above (Python 2.6+)
+* GNU/Linux Debian wheezy and above (Python 2.7+)
+* Mac OS X 10.8+ (Python 2.6+)
 
 Distribution
 ------------
@@ -40,10 +42,85 @@ ClusterShell should remain easily available to everyone. Hopefully, packages are
 currently available for Fedora Linux, RHEL (through EPEL repositories), Debian
 and Arch Linux.
 
+.. _install-python-support-overview:
+
+Python support overview
+^^^^^^^^^^^^^^^^^^^^^^^
+
+As seen in :ref:`install-requirements`, ClusterShell supports Python 2.6 and
+onwards, at least up to Python 3.8 at the time of writing.
+
+The table below provides examples of versions of Python supported by
+ClusterShell packages as found in some common Linux distributions:
+
++------------------+----------------------------+-----------------------------------+
+| Operating        | System Python version used | Alternate Python support          |
+| System           | by the clustershell tools  | packaged (version-suffixed tools) |
++==================+============================+===================================+
+| RHEL/CentOS 6    | Python 2.6                 | Python 3.4                        |
++------------------+----------------------------+-----------------------------------+
+| RHEL/CentOS 7    | Python 2.7                 | Python 3.4/3.6                    |
++------------------+----------------------------+-----------------------------------+
+| RHEL/CentOS 8    | **Python 3.6**             |                                   |
++------------------+----------------------------+-----------------------------------+
+| Fedora 30        | Python 2.7                 | Python 3.7                        |
++------------------+----------------------------+-----------------------------------+
+| Fedora 31        | **Python 3.8**             |                                   |
++------------------+----------------------------+-----------------------------------+
+| openSUSE Leap 15 | Python 2.7                 | Python 3.6                        |
++------------------+----------------------------+-----------------------------------+
+| SUSE SLES 12     | Python 2.7                 | Python 3.4                        |
++------------------+----------------------------+-----------------------------------+
+| SUSE SLES 15     | Python 2.7                 | Python 3.6                        |
++------------------+----------------------------+-----------------------------------+
+| Ubuntu 18.04 LTS | **Python 3.6**             |                                   |
++------------------+----------------------------+-----------------------------------+
+
+Red Hat Enterprise Linux (and CentOS)
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ClusterShell packages are maintained on Extra Packages for Enterprise Linux
+`EPEL`_ for Red Hat Enterprise Linux (RHEL) and its compatible spinoffs such
+as CentOS. At the time of writing, ClusterShell |version| is available on
+EPEL 6, 7 and 8.
+
+
+Install ClusterShell from EPEL
+""""""""""""""""""""""""""""""
+
+First you have to enable the ``yum`` EPEL repository. We recommend to download
+and install the `EPEL`_ repository RPM package. On CentOS, this can be easily
+done using the following command::
+
+    $ yum --enablerepo=extras install epel-release
+
+Then, the ClusterShell installation procedure is quite the same as for
+*Fedora Updates*, for instance::
+
+    $ yum install clustershell
+
+With EPEL 6 and 7, the Python 2 modules and tools are installed by default. If
+interested in Python 3 support, simply install the additional ClusterShell's
+Python 3 subpackage using the following command::
+
+    $ yum install python34-clustershell
+
+.. note:: The Python 3 subpackage is named ``python34-clustershell`` or
+          ``python36-clustershell`` on EPEL 6 and 7, instead of
+          ``python3-clustershell``.
+
+With EPEL 6 and 7, Python 3 versions of the tools are installed as
+*tool-pythonversion*, like ``clush-3.4``, ``cluset-3.4`` or ``nodeset-3.4`` on
+EPEL 6 and 7.
+
+With EPEL 8, however, Python 3 is the system default, and Python 2 has been
+deprecated. Thus only Python 3 is supported by the EPEL clustershell packages,
+the tools are using Python 3 by default and are not suffixed anymore.
+
 Fedora
 ^^^^^^
 
-At the time of writing, ClusterShell |version| is available on Fedora 26
+At the time of writing, ClusterShell |version| is available on Fedora 31
 (releases being maintained by the Fedora Project).
 
 Install ClusterShell from *Fedora Updates*
@@ -65,14 +142,16 @@ command::
 
     $ dnf install clustershell
 
-Python 2 module and tools are installed by default. If interested in Python 3
-development, simply install the additional ClusterShell's Python 3 subpackage
-using the following command::
+Prior to Fedora 31, Python 2 modules and tools are installed by default. If
+interested in Python 3 support, simply install the additional ClusterShell's
+Python 3 subpackage using the following command::
 
     $ dnf install python3-clustershell
 
-Python 3 versions of the tools are installed as *tool-pythonversion*, like
-``clush-3.6``, ``cluset-3.6`` or ``nodeset-3.6`` on Fedora 26.
+Prior to Fedora 31, Python 3 versions of the tools are installed as
+*tool-pythonversion*, like ``clush-3.6``, ``cluset-3.6`` or ``nodeset-3.6``.
+
+On Fedora 31 and onwards, only Python 3 is supported.
 
 Install ClusterShell from Fedora Updates Testing
 """"""""""""""""""""""""""""""""""""""""""""""""
@@ -89,41 +168,6 @@ instance::
 
     $ dnf install clustershell --enablerepo=updates-testing
 
-Red Hat Enterprise Linux (and CentOS)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-ClusterShell packages are maintained on Extra Packages for Enterprise Linux
-`EPEL`_ for Red Hat Enterprise Linux (RHEL) and its compatible spinoffs such
-as CentOS. At the time of writing, ClusterShell |version| is available on
-EPEL 6 and 7.
-
-
-Install ClusterShell from EPEL
-""""""""""""""""""""""""""""""
-
-First you have to enable the ``yum`` EPEL repository. We recommend to download
-and install the `EPEL`_ repository RPM package. On CentOS, this can be easily
-done using the following command::
-
-    $ yum --enablerepo=extras install epel-release
-
-Then, the ClusterShell installation procedure is quite the same as for
-*Fedora Updates*, for instance::
-
-    $ yum install clustershell
-
-Python 2 module and tools are installed by default. If interested in Python 3
-development, simply install the additional ClusterShell's Python 3 subpackage
-using the following command::
-
-    $ yum install python34-clustershell
-
-.. note:: The Python 3 subpackage is named ``python34-clustershell`` on
-          EPEL 6 and 7, instead of ``python3-clustershell``.
-
-Python 3 versions of the tools are installed as *tool-pythonversion*, like
-``clush-3.4``, ``cluset-3.4`` or ``nodeset-3.4`` on EPEL 6 and 7.
-
 openSUSE
 ^^^^^^^^
 
@@ -144,8 +188,8 @@ To install ClusterShell on openSUSE, use::
 
     $ zypper install clustershell
 
-Python 2 module and tools are installed by default. If interested in Python 3
-development, simply install the additional ClusterShell's Python 3 subpackage
+Python 2 module and tools are installed by default. If interested in Python 3 support,
+simply install the additional ClusterShell's Python 3 subpackage
 using the following command::
 
     $ zypper install python3-clustershell
diff --git a/doc/sphinx/intro.rst b/doc/sphinx/intro.rst
@@ -1,15 +1,15 @@
 Introduction
 ============
 
-ClusterShell provides a light, unified and robust command execution Python
-framework, well-suited to ease daily administrative tasks of nowadays Linux
-clusters. Some of the most important benefits of using ClusterShell are:
+ClusterShell provides a light and unified command execution Python framework
+to help administer GNU/Linux or BSD clusters. Some of the most important
+benefits of using ClusterShell are to:
 
-* to provide an efficient, parallel and highly scalable command execution
-  engine in Python,
-* to provide an unified node groups syntax and external group access (see the
-  NodeSet class),
-* to significantly speed up initial cluster setup and daily administrative tasks
+* provide an efficient, parallel and highly scalable command execution engine
+  in Python,
+* support an unified node groups syntax and external group access (see the
+  :class:`.NodeSet` class),
+* significantly speed up initial cluster setup and daily administrative tasks
   when using tools like :ref:`clush-tool` and :ref:`nodeset-tool`.
 
 Originally created by the HPC Linux system development team at CEA [#]_ HPC
@@ -21,11 +21,11 @@ axes:
   center: compute clusters, but also storage clusters and server farms (so
   they can use the same efficient framework for their administrative
   applications),
-* sharing administration techniques across multiple generations of
-  super-computing clusters (first of all, to avoid that every cluster
+* sharing cluster administration techniques across multiple generations of
+  super-computing clusters (first of all, to avoid that each cluster
   administration application has to implement its own command execution layer,
   but also to encourage the adoption of event-based coding model in
-  administration scripts).
+  cluster management scripts).
 
 Two available coding models make the library well-suited for simple scripts or
 for complex applications as well. Also, the library is fully cluster-aware and
diff --git a/doc/sphinx/release.rst b/doc/sphinx/release.rst
@@ -6,13 +6,39 @@ Release Notes
 Version 1.8
 -----------
 
-This adaptive release is now compatible with both Python 2 and Python 3.
+This adaptive major release is now compatible with both Python 2 and Python 3.
 
 We hope this release will help you manage your clusters, server farms or cloud
 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.3
+^^^^^^^^^^^^^
+
+This version contains a few bug fixes and improvements, mostly affecting the
+:ref:`tree mode <clush-tree>`:
+
+* propagate ``CLUSTERSHELL_GW_PYTHON_EXECUTABLE`` environment variable to
+  remote gateways (see :ref:`clush-tree-python`)
+
+* fix defect to properly close gateway channel when worker has aborted
+
+* improve error reporting from gateways
+
+* :ref:`clush-tool`: now properly handles ``--worker=ssh`` when
+  :ref:`topology.conf <clush-tree-enabling>` is present to explicitly disable
+  :ref:`tree mode <clush-tree>`
+
+* use safe yaml load variant to avoid warning from :class:`.YAMLGroupLoader`
+
+
+For more details, please have a look at `GitHub Issues for 1.8.3 milestone`_.
+
+We also added a :ref:`Python support matrix <install-python-support-overview>`
+for the main Linux distributions.
+
+
 Version 1.8.2
 ^^^^^^^^^^^^^
 
@@ -537,6 +563,7 @@ Please see :ref:`install-pip-user`.
 .. _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
+.. _GitHub Issues for 1.8.3 milestone: https://github.com/cea-hpc/clustershell/issues?utf8=%E2%9C%93&q=is%3Aissue+milestone%3A1.8.3
 .. _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/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:   2019-08-12
+:Date:   2019-12-01
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.2
+:Version: 1.8.3
 :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:   2019-08-12
+:Date:   2019-12-01
 :Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
-:Version: 1.8.2
+:Version: 1.8.3
 :Manual section: 1
 :Manual group: ClusterShell User Manual
 
diff --git a/doc/txt/clush.conf.txt b/doc/txt/clush.conf.txt
diff --git a/doc/txt/clush.txt b/doc/txt/clush.txt
diff --git a/doc/txt/groups.conf.txt b/doc/txt/groups.conf.txt
diff --git a/doc/txt/nodeset.txt b/doc/txt/nodeset.txt
diff --git a/lib/ClusterShell/__init__.py b/lib/ClusterShell/__init__.py
diff --git a/setup.py b/setup.py

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 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
	`3`	`+.TH CLUBAK 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
	`3`	`+.TH CLUSET 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
	`3`	`+.TH CLUSH 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
	`3`	`+.TH NODESET 1 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
	`3`	`+.TH CLUSH.CONF 5 "2019-12-01" "1.8.3" "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 "2019-08-12" "1.8.2" "ClusterShell User Manual"`
	`3`	`+.TH GROUPS.CONF 5 "2019-12-01" "1.8.3" "ClusterShell User Manual"`
`4`	`4`	`.SH NAME`
`5`	`5`	`groups.conf \- Configuration file for ClusterShell node groups`
`6`	`6`	`.`