From ae1bcbf223a49d1900de0c17161b5b109d60d26c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Lesimple?= Date: Fri, 6 Nov 2020 15:11:00 +0000 Subject: [PATCH] release v3.00.01 --- AUTHORS | 2 +- CONTRIBUTORS | 2 +- doc/CHANGELOG.md | 9 +++++++++ doc/HIERARCHY.md | 6 +++--- doc/INSTALL.md | 5 +++++ doc/UPGRADE.md | 11 +++++++++++ doc/UPGRADE_SPECIFIC.md | 3 --- doc/sphinx/installation/upgrading.rst | 12 +++++++++++- lib/perl/OVH/Bastion.pm | 2 +- 9 files changed, 42 insertions(+), 10 deletions(-) create mode 100644 doc/INSTALL.md create mode 100644 doc/UPGRADE.md delete mode 100644 doc/UPGRADE_SPECIFIC.md diff --git a/AUTHORS b/AUTHORS index 396185c..a65402d 100644 --- a/AUTHORS +++ b/AUTHORS @@ -1,4 +1,4 @@ -# This is the official list of OVH::Bastion authors for copyright purposes. +# This is the official list of The Bastion authors for copyright purposes. # This file is distinct from the CONTRIBUTORS files # and it lists the copyright holders only. diff --git a/CONTRIBUTORS b/CONTRIBUTORS index e27376e..c55499e 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -1,5 +1,5 @@ # This is the official list of people who can contribute -# (and typically have contributed) code to the OVH::Bastion repository. +# (and typically have contributed) code to The Bastion repository. # # Names should be added to this file only after verifying that # the individual or the individual's organization has agreed to diff --git a/doc/CHANGELOG.md b/doc/CHANGELOG.md index 121e83a..084860b 100644 --- a/doc/CHANGELOG.md +++ b/doc/CHANGELOG.md @@ -1,2 +1,11 @@ +## v3.00.01 - 2020/11/06 +- feat: add OpenSUSE 15.2 to the officially supported distros +- enh: install-ttyrec.sh: replaces build-and-install-ttyrec.sh, no longer builds in-place but prefers .deb and .rpm packages & falls back to precompiled static binaries otherwise +- enh: packages-check.sh: add qrencode-libs for RHEL/CentOS +- enh: provide a separated Dockerfile for the sandbox, squashing useless layers +- doc: a lot of fixes here and there +- chore: remove spurious config files +- chore: a few GitHub actions workflow fixes + ## v3.00.00 - 2020/10/30 - First public release \o/ diff --git a/doc/HIERARCHY.md b/doc/HIERARCHY.md index 47fb463..73ae096 100644 --- a/doc/HIERARCHY.md +++ b/doc/HIERARCHY.md @@ -1,7 +1,7 @@ man 7 hier ========== -The OVH::Bastion directory hierarchy is organized as follows: +The Bastion directory hierarchy is organized as follows: - bin - bin/admin: scripts that are supposed to be launched manually by an admin where needed @@ -19,9 +19,9 @@ The OVH::Bastion directory hierarchy is organized as follows: - bin/shell: where resides the main script that is declared as the shell of the bastion users, with some of its helpers - bin/sudogen: where resides the helper script that generate group and account sudoers files - bin/other: other helper scripts for various tasks -- contrib: placeholder directory with a readme file that references other repositories of interest when integrating the bastion in your company +- contrib: third-party files that might be of interest integrating The Bastion in your company - doc: sysadmin-proof documentation folder, the main Markdown files you need are there, just one `view` apart - - doc/sphinx: more complete documentation using the `sphinx` documentation system, the built version is viewable on https://ovh.github.io/the-bastion/ + - doc/sphinx: more complete documentation using the `sphinx` documentation system, the built version is viewable on https://ovh.github.io/the-bastion/, otherwise the `.rst` files can be read with any text editor - docker: where the Dockerfiles reside - etc: contains all the template configuration files that will be installed on your system (depending on your `install` options) - install: where optional modules can push their install script to be called by the main install script diff --git a/doc/INSTALL.md b/doc/INSTALL.md new file mode 100644 index 0000000..e1784a3 --- /dev/null +++ b/doc/INSTALL.md @@ -0,0 +1,5 @@ +# Install instructions + +Please refer to proper section of the [documentation](https://ovh.github.io/the-bastion/installation/basic.html). + +It can also be found offline, in the ``doc/sphinx/installation/basic.rst`` text file. diff --git a/doc/UPGRADE.md b/doc/UPGRADE.md new file mode 100644 index 0000000..8b67396 --- /dev/null +++ b/doc/UPGRADE.md @@ -0,0 +1,11 @@ +# General upgrade instructions + +Please refer to proper section of the [documentation](https://ovh.github.io/the-bastion/installation/upgrading.html). + +It can also be found offline, in the ``doc/sphinx/installation/upgrading.rst`` text file. + +# Specific upgrade instructions + +Each version might have specific upgrade instructions, please refer to the proper section of the [documentation](https://ovh.github.io/the-bastion/installation/upgrading.html#version-specific-upgrade-instructions). + +It can also be found offline, in the ``doc/sphinx/installation/upgrading.rst`` text file. diff --git a/doc/UPGRADE_SPECIFIC.md b/doc/UPGRADE_SPECIFIC.md deleted file mode 100644 index 676112f..0000000 --- a/doc/UPGRADE_SPECIFIC.md +++ /dev/null @@ -1,3 +0,0 @@ -# Specific upgrade instructions - -(none) diff --git a/doc/sphinx/installation/upgrading.rst b/doc/sphinx/installation/upgrading.rst index 6fd6779..527c061 100644 --- a/doc/sphinx/installation/upgrading.rst +++ b/doc/sphinx/installation/upgrading.rst @@ -42,7 +42,17 @@ Note that this is done automatically for bastion admins. Version-specific upgrade instructions ===================================== +v3.00.01 +******** + +If you previously installed ``ttyrec`` using the now deprecated ``build-and-install-ttyrec.sh`` script, you might want to know that since this version, the script has been replaced by ``install-ttyrec.sh``, which no longer builds in-place, but prefers downloading and installing prebuild ``rpm`` or ``deb`` packages. + +If you previously built and installed ``ttyrec`` manually, and want to use the new packages instead, you might want to manually uninstall your previously built ttyrec program (remove the binaries that were installed in ``/usr/local/bin``), and call ``install-ttyrec.sh -a`` to download and install the proper package instead. + +This is not mandatory and doesn't change anything from the software point of view. + + v3.00.00 ******** -Initial public version, no specific upgrade instructions +Initial public version, no specific upgrade instructions. diff --git a/lib/perl/OVH/Bastion.pm b/lib/perl/OVH/Bastion.pm index fd7eb6d..410868c 100644 --- a/lib/perl/OVH/Bastion.pm +++ b/lib/perl/OVH/Bastion.pm @@ -5,7 +5,7 @@ use common::sense; use Fcntl; use POSIX qw(strftime); -our $VERSION = '3.00.00'; +our $VERSION = '3.00.01'; BEGIN { # only used by the handler below