Skip to content

Commit 20b4795

Browse files
thiellthiell
committed
Release 1.8.3
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
1 parent 1f128f6 commit 20b4795

20 files changed

+170
-84
lines changed

‎ChangeLog

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
2019-12-01 S. Thiell <[email protected]>
2+
3+
* Version 1.8.3 released. The main changes are listed below.
4+
5+
* NodeUtils: use yaml.safe_load() instead of default loader (#417)
6+
7+
* Tree-mode doesn't work with multi-hop gateways (#419)
8+
9+
* Silent error on Python version mismatch with gateway (#388)
10+
11+
* clush: support --worker/-R when topology.conf is present (#386)
12+
113
2019-08-12 S. Thiell <[email protected]>
214

315
* Version 1.8.2 released. The main changes are listed below.

‎clustershell.spec.in

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,9 @@ rm -rf %{buildroot}
218218
%{vimdatadir}/syntax/groupsconf.vim
219219

220220
%changelog
221+
* Sun Dec 1 2019 Stephane Thiell <[email protected]> 1.8.3-1
222+
- update to 1.8.3
223+
221224
* Mon Aug 12 2019 Stephane Thiell <[email protected]> 1.8.2-1
222225
- update to 1.8.2
223226

‎doc/man/man1/clubak.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
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"
44
.SH NAME
55
clubak \- format output from clush/pdsh-like output and more
66
.

‎doc/man/man1/cluset.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
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"
44
.SH NAME
55
cluset \- compute advanced cluster node set operations
66
.

‎doc/man/man1/clush.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
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"
44
.SH NAME
55
clush \- execute shell commands on a cluster
66
.

‎doc/man/man1/nodeset.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
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"
44
.SH NAME
55
nodeset \- compute advanced nodeset operations
66
.

‎doc/man/man5/clush.conf.5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
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"
44
.SH NAME
55
clush.conf \- Configuration file for clush
66
.

‎doc/man/man5/groups.conf.5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.\" Man page generated from reStructuredText.
22
.
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"
44
.SH NAME
55
groups.conf \- Configuration file for ClusterShell node groups
66
.

‎doc/sphinx/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@
4141

4242
# General information about the project.
4343
project = u'clustershell'
44-
copyright = u'2017, Stephane Thiell'
44+
copyright = u'2019, Stephane Thiell'
4545

4646
# The version info for the project you're documenting, acts as replacement for
4747
# |version| and |release|, also used in various other places throughout the
4848
# built documents.
4949
#
5050
# The short X.Y version.
51-
version = '1.8.2'
51+
version = '1.8.3'
5252
# The full version, including alpha/beta/rc tags.
53-
release = '1.8.2'
53+
release = '1.8.3'
5454

5555
# The language for content autogenerated by Sphinx. Refer to documentation
5656
# for a list of supported languages.

‎doc/sphinx/install.rst

Lines changed: 92 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ Installation
66
ClusterShell is distributed in several packages. On RedHat-like OS, we
77
recommend to use the RPM package (.rpm) distribution.
88

9-
As a system software for cluster, ClusterShell is primarily made for
9+
As system software for cluster, ClusterShell is primarily made for
1010
system-wide installation to be used by system administrators. However,
11-
changes have been made so that it's now easy to install it without
11+
changes have been made so that it's now possible to install it without
1212
root access (see :ref:`install-pip-user`).
1313

14+
.. _install-requirements:
1415

1516
Requirements
1617
------------
@@ -26,9 +27,10 @@ For instance, ClusterShell is known to work on the following operating systems:
2627

2728
* GNU/Linux RHEL or CentOS 6 (Python 2.6)
2829
* GNU/Linux RHEL or CentOS 7 (Python 2.7)
29-
* GNU/Linux Fedora 22 to 26 (Python 2.6 or 2.7)
30-
* GNU/Linux Debian wheezy and above (Python 2.7)
31-
* Mac OS X 10.8+ (Python 2.6 or 2.7)
30+
* GNU/Linux RHEL or CentOS 8 (Python 3.6)
31+
* GNU/Linux Fedora 22 and above (Python 2.6+)
32+
* GNU/Linux Debian wheezy and above (Python 2.7+)
33+
* Mac OS X 10.8+ (Python 2.6+)
3234

3335
Distribution
3436
------------
@@ -40,10 +42,85 @@ ClusterShell should remain easily available to everyone. Hopefully, packages are
4042
currently available for Fedora Linux, RHEL (through EPEL repositories), Debian
4143
and Arch Linux.
4244

45+
.. _install-python-support-overview:
46+
47+
Python support overview
48+
^^^^^^^^^^^^^^^^^^^^^^^
49+
50+
As seen in :ref:`install-requirements`, ClusterShell supports Python 2.6 and
51+
onwards, at least up to Python 3.8 at the time of writing.
52+
53+
The table below provides examples of versions of Python supported by
54+
ClusterShell packages as found in some common Linux distributions:
55+
56+
+------------------+----------------------------+-----------------------------------+
57+
| Operating | System Python version used | Alternate Python support |
58+
| System | by the clustershell tools | packaged (version-suffixed tools) |
59+
+==================+============================+===================================+
60+
| RHEL/CentOS 6 | Python 2.6 | Python 3.4 |
61+
+------------------+----------------------------+-----------------------------------+
62+
| RHEL/CentOS 7 | Python 2.7 | Python 3.4/3.6 |
63+
+------------------+----------------------------+-----------------------------------+
64+
| RHEL/CentOS 8 | **Python 3.6** | |
65+
+------------------+----------------------------+-----------------------------------+
66+
| Fedora 30 | Python 2.7 | Python 3.7 |
67+
+------------------+----------------------------+-----------------------------------+
68+
| Fedora 31 | **Python 3.8** | |
69+
+------------------+----------------------------+-----------------------------------+
70+
| openSUSE Leap 15 | Python 2.7 | Python 3.6 |
71+
+------------------+----------------------------+-----------------------------------+
72+
| SUSE SLES 12 | Python 2.7 | Python 3.4 |
73+
+------------------+----------------------------+-----------------------------------+
74+
| SUSE SLES 15 | Python 2.7 | Python 3.6 |
75+
+------------------+----------------------------+-----------------------------------+
76+
| Ubuntu 18.04 LTS | **Python 3.6** | |
77+
+------------------+----------------------------+-----------------------------------+
78+
79+
Red Hat Enterprise Linux (and CentOS)
80+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
81+
82+
ClusterShell packages are maintained on Extra Packages for Enterprise Linux
83+
`EPEL`_ for Red Hat Enterprise Linux (RHEL) and its compatible spinoffs such
84+
as CentOS. At the time of writing, ClusterShell |version| is available on
85+
EPEL 6, 7 and 8.
86+
87+
88+
Install ClusterShell from EPEL
89+
""""""""""""""""""""""""""""""
90+
91+
First you have to enable the ``yum`` EPEL repository. We recommend to download
92+
and install the `EPEL`_ repository RPM package. On CentOS, this can be easily
93+
done using the following command::
94+
95+
$ yum --enablerepo=extras install epel-release
96+
97+
Then, the ClusterShell installation procedure is quite the same as for
98+
*Fedora Updates*, for instance::
99+
100+
$ yum install clustershell
101+
102+
With EPEL 6 and 7, the Python 2 modules and tools are installed by default. If
103+
interested in Python 3 support, simply install the additional ClusterShell's
104+
Python 3 subpackage using the following command::
105+
106+
$ yum install python34-clustershell
107+
108+
.. note:: The Python 3 subpackage is named ``python34-clustershell`` or
109+
``python36-clustershell`` on EPEL 6 and 7, instead of
110+
``python3-clustershell``.
111+
112+
With EPEL 6 and 7, Python 3 versions of the tools are installed as
113+
*tool-pythonversion*, like ``clush-3.4``, ``cluset-3.4`` or ``nodeset-3.4`` on
114+
EPEL 6 and 7.
115+
116+
With EPEL 8, however, Python 3 is the system default, and Python 2 has been
117+
deprecated. Thus only Python 3 is supported by the EPEL clustershell packages,
118+
the tools are using Python 3 by default and are not suffixed anymore.
119+
43120
Fedora
44121
^^^^^^
45122

46-
At the time of writing, ClusterShell |version| is available on Fedora 26
123+
At the time of writing, ClusterShell |version| is available on Fedora 31
47124
(releases being maintained by the Fedora Project).
48125

49126
Install ClusterShell from *Fedora Updates*
@@ -65,14 +142,16 @@ command::
65142

66143
$ dnf install clustershell
67144

68-
Python 2 module and tools are installed by default. If interested in Python 3
69-
development, simply install the additional ClusterShell's Python 3 subpackage
70-
using the following command::
145+
Prior to Fedora 31, Python 2 modules and tools are installed by default. If
146+
interested in Python 3 support, simply install the additional ClusterShell's
147+
Python 3 subpackage using the following command::
71148

72149
$ dnf install python3-clustershell
73150

74-
Python 3 versions of the tools are installed as *tool-pythonversion*, like
75-
``clush-3.6``, ``cluset-3.6`` or ``nodeset-3.6`` on Fedora 26.
151+
Prior to Fedora 31, Python 3 versions of the tools are installed as
152+
*tool-pythonversion*, like ``clush-3.6``, ``cluset-3.6`` or ``nodeset-3.6``.
153+
154+
On Fedora 31 and onwards, only Python 3 is supported.
76155

77156
Install ClusterShell from Fedora Updates Testing
78157
""""""""""""""""""""""""""""""""""""""""""""""""
@@ -89,41 +168,6 @@ instance::
89168

90169
$ dnf install clustershell --enablerepo=updates-testing
91170

92-
Red Hat Enterprise Linux (and CentOS)
93-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94-
95-
ClusterShell packages are maintained on Extra Packages for Enterprise Linux
96-
`EPEL`_ for Red Hat Enterprise Linux (RHEL) and its compatible spinoffs such
97-
as CentOS. At the time of writing, ClusterShell |version| is available on
98-
EPEL 6 and 7.
99-
100-
101-
Install ClusterShell from EPEL
102-
""""""""""""""""""""""""""""""
103-
104-
First you have to enable the ``yum`` EPEL repository. We recommend to download
105-
and install the `EPEL`_ repository RPM package. On CentOS, this can be easily
106-
done using the following command::
107-
108-
$ yum --enablerepo=extras install epel-release
109-
110-
Then, the ClusterShell installation procedure is quite the same as for
111-
*Fedora Updates*, for instance::
112-
113-
$ yum install clustershell
114-
115-
Python 2 module and tools are installed by default. If interested in Python 3
116-
development, simply install the additional ClusterShell's Python 3 subpackage
117-
using the following command::
118-
119-
$ yum install python34-clustershell
120-
121-
.. note:: The Python 3 subpackage is named ``python34-clustershell`` on
122-
EPEL 6 and 7, instead of ``python3-clustershell``.
123-
124-
Python 3 versions of the tools are installed as *tool-pythonversion*, like
125-
``clush-3.4``, ``cluset-3.4`` or ``nodeset-3.4`` on EPEL 6 and 7.
126-
127171
openSUSE
128172
^^^^^^^^
129173

@@ -144,8 +188,8 @@ To install ClusterShell on openSUSE, use::
144188

145189
$ zypper install clustershell
146190

147-
Python 2 module and tools are installed by default. If interested in Python 3
148-
development, simply install the additional ClusterShell's Python 3 subpackage
191+
Python 2 module and tools are installed by default. If interested in Python 3 support,
192+
simply install the additional ClusterShell's Python 3 subpackage
149193
using the following command::
150194

151195
$ zypper install python3-clustershell

‎doc/sphinx/intro.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
Introduction
22
============
33

4-
ClusterShell provides a light, unified and robust command execution Python
5-
framework, well-suited to ease daily administrative tasks of nowadays Linux
6-
clusters. Some of the most important benefits of using ClusterShell are:
4+
ClusterShell provides a light and unified command execution Python framework
5+
to help administer GNU/Linux or BSD clusters. Some of the most important
6+
benefits of using ClusterShell are to:
77

8-
* to provide an efficient, parallel and highly scalable command execution
9-
engine in Python,
10-
* to provide an unified node groups syntax and external group access (see the
11-
NodeSet class),
12-
* to significantly speed up initial cluster setup and daily administrative tasks
8+
* provide an efficient, parallel and highly scalable command execution engine
9+
in Python,
10+
* support an unified node groups syntax and external group access (see the
11+
:class:`.NodeSet` class),
12+
* significantly speed up initial cluster setup and daily administrative tasks
1313
when using tools like :ref:`clush-tool` and :ref:`nodeset-tool`.
1414

1515
Originally created by the HPC Linux system development team at CEA [#]_ HPC
@@ -21,11 +21,11 @@ axes:
2121
center: compute clusters, but also storage clusters and server farms (so
2222
they can use the same efficient framework for their administrative
2323
applications),
24-
* sharing administration techniques across multiple generations of
25-
super-computing clusters (first of all, to avoid that every cluster
24+
* sharing cluster administration techniques across multiple generations of
25+
super-computing clusters (first of all, to avoid that each cluster
2626
administration application has to implement its own command execution layer,
2727
but also to encourage the adoption of event-based coding model in
28-
administration scripts).
28+
cluster management scripts).
2929

3030
Two available coding models make the library well-suited for simple scripts or
3131
for complex applications as well. Also, the library is fully cluster-aware and

‎doc/sphinx/release.rst

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,39 @@ Release Notes
66
Version 1.8
77
-----------
88

9-
This adaptive release is now compatible with both Python 2 and Python 3.
9+
This adaptive major release is now compatible with both Python 2 and Python 3.
1010

1111
We hope this release will help you manage your clusters, server farms or cloud
1212
farms! Special thanks to the many of you that have sent us feedback on GitHub!
1313

1414
.. warning:: Support for Python 2.5 and below has been dropped in this version.
1515

16+
Version 1.8.3
17+
^^^^^^^^^^^^^
18+
19+
This version contains a few bug fixes and improvements, mostly affecting the
20+
:ref:`tree mode <clush-tree>`:
21+
22+
* propagate ``CLUSTERSHELL_GW_PYTHON_EXECUTABLE`` environment variable to
23+
remote gateways (see :ref:`clush-tree-python`)
24+
25+
* fix defect to properly close gateway channel when worker has aborted
26+
27+
* improve error reporting from gateways
28+
29+
* :ref:`clush-tool`: now properly handles ``--worker=ssh`` when
30+
:ref:`topology.conf <clush-tree-enabling>` is present to explicitly disable
31+
:ref:`tree mode <clush-tree>`
32+
33+
* use safe yaml load variant to avoid warning from :class:`.YAMLGroupLoader`
34+
35+
36+
For more details, please have a look at `GitHub Issues for 1.8.3 milestone`_.
37+
38+
We also added a :ref:`Python support matrix <install-python-support-overview>`
39+
for the main Linux distributions.
40+
41+
1642
Version 1.8.2
1743
^^^^^^^^^^^^^
1844

@@ -537,6 +563,7 @@ Please see :ref:`install-pip-user`.
537563
.. _GitHub Issues for 1.8 milestone: https://github.com/cea-hpc/clustershell/issues?utf8=%E2%9C%93&q=is%3Aissue+milestone%3A1.8
538564
.. _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
539565
.. _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
566+
.. _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
540567
.. _LGPL v2.1+: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html
541568
.. _CeCILL-C V1: http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html
542569
.. _xCAT: https://xcat.org/

‎doc/txt/clubak.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ format output from clush/pdsh-like output and more
77
--------------------------------------------------
88

99
:Author: Stephane Thiell <[email protected]>
10-
:Date: 2019-08-12
10+
:Date: 2019-12-01
1111
:Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
12-
:Version: 1.8.2
12+
:Version: 1.8.3
1313
:Manual section: 1
1414
:Manual group: ClusterShell User Manual
1515

‎doc/txt/cluset.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ compute advanced cluster node set operations
77
--------------------------------------------
88

99
:Author: Stephane Thiell <[email protected]>
10-
:Date: 2019-08-12
10+
:Date: 2019-12-01
1111
:Copyright: GNU Lesser General Public License version 2.1 or later (LGPLv2.1+)
12-
:Version: 1.8.2
12+
:Version: 1.8.3
1313
:Manual section: 1
1414
:Manual group: ClusterShell User Manual
1515

0 commit comments

Comments
 (0)