Merge pull request #67 from ovh/doc

enh: doc: simplify general upgrade procedure
This commit is contained in:
Stéphane Lesimple 2020-11-25 18:23:50 +01:00 committed by GitHub
commit 19d523c8c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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 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
=====================================