Skip to content

Commit

Permalink
Add migration doc for the parsec-server
Browse files Browse the repository at this point in the history
  • Loading branch information
FirelightFlagboy committed Nov 6, 2023
1 parent 9fec4a6 commit 32aedcd
Show file tree
Hide file tree
Showing 3 changed files with 122 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/adminguide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,4 @@ Administrator Guide
stats_server
stats_organization
hosting/index
updating/index
49 changes: 49 additions & 0 deletions docs/adminguide/updating/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
.. Parsec Cloud (https://parsec.cloud) Copyright (c) BUSL-1.1 2016-present Scille SAS
.. _doc_adminguide_updating:

.. cspell:words linenos literalinclude
======================
Parsec Server updating
======================

This guide covers the updating procedure for the `Parsec`_ server (also called `parsec-backend`).

.. note::

We consider that you are using the same infrastructure configuration as in the :ref:`Parsec Server installation guide <doc_adminguide_hosting>`.
Adapt this guide to your own situation.

.. _Parsec: https://parsec.cloud

Updating to a newer version
***************************

.. warning::

Before updating to a newer version, we recommend that you backup the database,
In case you need to rollback the update.

In this guide, we will consider that you are using the parsec-backend at the version ``2023-10-11-v2.16.0-rc.5.dev-b33d909`` and you want to update-it to ``v2.16.0``.

1. Update the docker image's tag of the ``parsec-backend`` in docker-compose's file:

.. literalinclude:: ../hosting/parsec-server.docker.yaml
:language: yaml
:linenos:
:emphasize-lines: 43

You need to change the used tag (at line **43**) to ``v2.16.0``.

2. Apply the database migration:

.. code-block:: bash
docker-compose compose -f parsec-server.docker.yaml run parsec-backend migrate
3. Restart the ``parsec-backend`` container:

.. code-block:: bash
docker-compose compose -f parsec-server.docker.yaml restart parsec-backend
72 changes: 72 additions & 0 deletions docs/locale/fr/LC_MESSAGES/adminguide/updating/index.po
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# SOME DESCRIPTIVE TITLE.
# Copyright (C) 2016-present, Scille SAS
# This file is distributed under the same license as the Parsec package.
# FIRST AUTHOR <EMAIL@ADDRESS>, 2023.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: Parsec 2.16.0-a.0+dev\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-11-06 14:27+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: fr\n"
"Language-Team: fr <LL@li.org>\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=utf-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.13.0\n"

#: ../../adminguide/updating/index.rst:9
msgid "Parsec Server updating"
msgstr ""

#: ../../adminguide/updating/index.rst:11
msgid ""
"This guide covers the updating procedure for the `Parsec`_ server (also "
"called `parsec-backend`)."
msgstr ""

#: ../../adminguide/updating/index.rst:15
msgid ""
"We consider that you are using the same infrastructure configuration as in "
"the :ref:`Parsec Server installation guide <doc_adminguide_hosting>`. Adapt "
"this guide to your own situation."
msgstr ""

#: ../../adminguide/updating/index.rst:21
msgid "Updating to a newer version"
msgstr ""

#: ../../adminguide/updating/index.rst:25
msgid ""
"Before updating to a newer version, we recommend that you backup the "
"database, In case you need to rollback the update."
msgstr ""

#: ../../adminguide/updating/index.rst:28
msgid ""
"In this guide, we will consider that you are using the parsec-backend at the "
"version ``2023-10-11-v2.16.0-rc.5.dev-b33d909`` and you want to update-it to "
"``v2.16.0``."
msgstr ""

#: ../../adminguide/updating/index.rst:30
msgid ""
"Update the docker image's tag of the ``parsec-backend`` in docker-compose's "
"file:"
msgstr ""

#: ../../adminguide/updating/index.rst:37
msgid "You need to change the used tag (at line **43**) to ``v2.16.0``."
msgstr ""

#: ../../adminguide/updating/index.rst:39
msgid "Apply the database migration:"
msgstr ""

#: ../../adminguide/updating/index.rst:45
msgid "Restart the ``parsec-backend`` container:"
msgstr ""

0 comments on commit 32aedcd

Please sign in to comment.