From 9714b5940371f3c687a75366e51e3886e9496c8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Lesimple?= Date: Mon, 23 Nov 2020 11:04:25 +0000 Subject: [PATCH 1/2] enh: doc: simplify general upgrade procedure --- doc/sphinx/installation/upgrading.rst | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/doc/sphinx/installation/upgrading.rst b/doc/sphinx/installation/upgrading.rst index b771a65..0ed9376 100644 --- a/doc/sphinx/installation/upgrading.rst +++ b/doc/sphinx/installation/upgrading.rst @@ -5,7 +5,9 @@ Upgrading General upgrade instructions ============================ -- Update the code, if you're using ``git``, you can checkout the latest tag: +- First, check below if there are specific upgrade instructions for your version. + +- When you're ready, update the code, if you're using ``git``, you can checkout the latest tag: .. code-block:: shell @@ -17,27 +19,7 @@ General upgrade instructions /opt/bastion/bin/admin/install --upgrade -Note that if you're using a infrastructure automation tool such as Puppet, Ansible, Chef, and don't want the update script to touch some files that you manage yourself, you can use ``--upgrade-managed``. See the ``--help`` for a more fine-grained upgrade path if needed. - -- Install any missing newly needed system package: - -.. code-block:: shell - - /opt/bastion/bin/admin/packages-check.sh - -- Check the configuration for new parameters or options you may want to adjust - -.. code-block:: shell - - for f in /opt/bastion/etc/bastion/*.dist; do vimdiff $f /etc/bastion/$(basename $f .dist); done - -- If you have some power-users and you want them to have access to any new restricted plugin this new version might have, you can run for those accounts: - -.. code-block:: shell - - /opt/bastion/bin/admin/grant-all-restricted-commands-to.sh ACCOUNTNAME - -Note that this is done automatically for bastion admins. +Note that if you're using a infrastructure automation tool such as Puppet, Ansible, Chef, and don't want the update script to touch some files that you manage yourself, you can use ``--upgrade-managed`` instead of ``--upgrade``. See the ``--help`` for a more fine-grained upgrade path if needed. Version-specific upgrade instructions ===================================== From 2b74042fd9b8b06e040cf94b82fe868054287d3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Lesimple?= Date: Mon, 23 Nov 2020 12:32:52 +0100 Subject: [PATCH 2/2] doc: fix typo MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Thomas Soëte --- doc/sphinx/installation/upgrading.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/sphinx/installation/upgrading.rst b/doc/sphinx/installation/upgrading.rst index 0ed9376..5d98231 100644 --- a/doc/sphinx/installation/upgrading.rst +++ b/doc/sphinx/installation/upgrading.rst @@ -19,7 +19,7 @@ General upgrade instructions /opt/bastion/bin/admin/install --upgrade -Note that if you're using a infrastructure automation tool such as Puppet, Ansible, Chef, and don't want the update script to touch some files that you manage yourself, you can use ``--upgrade-managed`` instead of ``--upgrade``. See the ``--help`` for a more fine-grained upgrade path if needed. +Note that if you're using an infrastructure automation tool such as Puppet, Ansible, Chef, and don't want the update script to touch some files that you manage yourself, you can use ``--upgrade-managed`` instead of ``--upgrade``. See the ``--help`` for a more fine-grained upgrade path if needed. Version-specific upgrade instructions =====================================