From 0c7788ea810d0bb018a31b272eb2276f0c31825a Mon Sep 17 00:00:00 2001 From: Felip Moll <felip.moll@schedmd.com> Date: Wed, 4 Oct 2017 16:42:38 +0200 Subject: [PATCH] documentation: remove of minor concept from docs The combination of the first and second digits in the version designate the major release. The third digit in the version designates the micro release. minor release word is removed as being confusing and useless. --- doc/html/quickstart_admin.shtml | 27 ++++++++++++++------------- doc/html/rpc.shtml | 25 +++++++++++++------------ doc/html/troubleshoot.shtml | 15 ++++++++------- 3 files changed, 35 insertions(+), 32 deletions(-) diff --git a/doc/html/quickstart_admin.shtml b/doc/html/quickstart_admin.shtml index 7860521614e..158572b0440 100644 --- a/doc/html/quickstart_admin.shtml +++ b/doc/html/quickstart_admin.shtml @@ -643,35 +643,36 @@ adev0: scontrol shutdown <h2><a name="upgrade"></a>Upgrades</h2> -<p>Background: The Slurm version numbers contain three digits, which represent -the major, minor and micro release numbers in that order (e.g. 16.05.3 is -major=16, minor=05, micro=3). +<p>Background: The Slurm version numbers contain three digits which represent +the major and micro release numbers. The combination of the first and second +digits in the version designate the major release. The third digit in the +version designates the micro release (e.g. 16.05.3 is major=16.05, micro=3). The major release number indicates the last two digits in the year of release -and the minor release number indicates the month of release. +followed by the month of release. Thus version 16.05.x was initially released in May 2016. Changes in the RPCs (remote procedure calls) and state files will only be made -if the major and/or minor release number changes, which typically happens +if the major release number changes, which typically happens about once every nine months or so. -A list of recent major/minor Slurm releases is shown below.</p> +A list of recent major Slurm releases is shown below.</p> <ul> <li>15.08.x (Released August 2015)</li> <li>16.05.x (Released May 2016)</li> <li>17.02.x (Released February 2017)</li> </ul> -<p>Slurm's MPI libraries may also change if the major and/or minor release number -change, requiring applications be re-linked (behavior may vary depending upon +<p>Slurm's MPI libraries may also change if the major release number change, +requiring applications be re-linked (behavior may vary depending upon the MPI implementation used and the specific Slurm changes between releases). Locally developed Slurm plugins may also require modification. -Slurm daemons will support RPCs and state files from the two previous minor -releases (e.g. a version 16.05.x SlurmDBD will support slurmctld daemons and -commands with a version of 16.05.x, 15.08.x or 14.11.x). +Slurm daemons will support RPCs and state files from the two previous major +releases (e.g. a version 17.02.x SlurmDBD will support slurmctld daemons and +commands with a version of 17.02.x, 16.05.x or 15.08.x). This means that upgrading at least once each year is recommended. Otherwise, intermediate upgrades will be required to preserve state information. Changes in the micro release number generally represent only bug fixes, but may also include very minor enhancements.</p> -<p>If the SlurmDBD daemon is used, it must be at the same or higher minor +<p>If the SlurmDBD daemon is used, it must be at the same or higher major release number as the Slurmctld daemons. In other words, when changing the version to a higher release number (e.g from 16.05.x to 17.02.x) <b>always upgrade the SlurmDBD daemon first</b>. @@ -768,6 +769,6 @@ cd /usr/ports/sysutils/slurm-wlm && make install typical compute nodes. Installing from source allows the user to enable options such as mysql and gui tools via a configuration menu.</p> -<p style="text-align:center;">Last modified 1 March 2017</p> +<p style="text-align:center;">Last modified 04 October 2017</p> <!--#include virtual="footer.txt"--> diff --git a/doc/html/rpc.shtml b/doc/html/rpc.shtml index e96d0c86830..4bea7f4ec2d 100644 --- a/doc/html/rpc.shtml +++ b/doc/html/rpc.shtml @@ -6,25 +6,26 @@ <p>Slurm uses RPCs (Remote Procedure Calls) to communicate between daemons and commands. -The format of many RPCs change between major and/or minor Slurm releases -(the release numbers are major.minor.micro and changes in the micro number +The format of many RPCs change between major Slurm releases +(the first two release digits designates the major and the last one the micro, +17.02.7 is major=17.02, micro=7, and changes in the micro number indicate bug fixes since the previous release, while changes in the -major or minor numbers indicate fundamental changes in logic). +major number indicate fundamental changes in logic). The reason for format changes is typically new fields being added for new Slurm capabilities. Slurm communications support the most current release plus the two previous -release major and/or minor releases. -For example, Slurm version 15.08.x daemons can communicate with Slurm commands -from version 14.03.x, 14.11.x and 15.08.x. +major releases. +For example, Slurm version 17.02.x daemons can communicate with Slurm commands +from version 17.02.x, 16.05.x and 15.08.x. The same is true for state save files. -Slurm can be upgraded through two major or minor releases without loss of data +Slurm can be upgraded through two major releases without loss of data since the older state files are still recognized. Slurm commands initiated under one version of Slurm can also continue to -execute and communicate with the Slurm daemons through two release upgrades -of the daemons. -Upgrades beyond two releases will result in unrecognized state information, -but intermediate upgrades can be performed to reformat the state information -and prevent its loss. +execute and communicate with the Slurm daemons through two major release +upgrades of the daemons. +Upgrades beyond two major releases will result in unrecognized state +information, but intermediate upgrades can be performed to reformat the state +information and prevent its loss. As new versions of Slurm are released, support for the oldest communication protocols is removed from the code.</p> diff --git a/doc/html/troubleshoot.shtml b/doc/html/troubleshoot.shtml index 65190504d9f..24583a368ff 100644 --- a/doc/html/troubleshoot.shtml +++ b/doc/html/troubleshoot.shtml @@ -205,14 +205,15 @@ must exist.</li> <li>Check that compatible versions of Slurm exists on all of the nodes (execute "<i>sinfo -V</i>" or "<i>rpm -qa | grep slurm</i>"). -The Slurm version numbers contain three digits, which represent -the major, minor and micro release numbers in that order (e.g. 14.11.3 is -major=14, minor=11, micro=3). +The Slurm version numbers contain three digits which represent the major +and micro release numbers. The combination of the first and second digits in +the version designate the major release. The third digit in the +version designates the micro release (e.g. 16.05.3 is major=16.05, micro=3). Changes in the RPCs (remote procedure calls) and state files will only be made -if the major and/or minor release number changes. -Slurm daemons will support RPCs and state files from the two previous minor or -releases (e.g. a version 15.08.x SlurmDBD will support slurmctld daemons and -commands with a version of 14.03.x or 14.11.x).</li> +if the major release number changes. +Slurm daemons will support RPCs and state files from the two previous major +releases (e.g. a version 17.02.x SlurmDBD will support slurmctld daemons and +commands with a version of 16.05.x or 15.08.x).</li> </ol> <p class="footer"><a href="#top">top</a></p> -- GitLab