Fixes #647 - Removed MySQL/MariaDB support for Zammad 7

Author: ralf401

appendix/backup-and-restore/migrate-hosts.rst

@@ -30,7 +30,6 @@ Step 2: Install Zammad on the destination host
    Have a look at the installation instructions:
 
       * :doc:`Package Installation </install/package>`
-      * :doc:`Source Installation </install/package>`
       * :doc:`Install with Docker </install/docker-compose>`
 
 Step 3: Activate maintenance mode

appendix/backup-and-restore/restore.rst

@@ -26,8 +26,7 @@ your data.
      independent directory. You're working out of script and
      documentation scope!
 
-* PostgreSQL based installations will drop and re-create the database!
-  MySQL / MariaDB based installations restore on the existing database.
+* It will drop and re-create the database!
 * You require at least twice the backed up Zammad instance size of free
   storage. If you have the dump only, factor 3 could be a good number.
 

appendix/configure-database-server.rst

@@ -3,7 +3,6 @@ Configure Database Server
 
 .. note::
 
-   Parts of this page also applies to both supported database servers.
    We can't provide a complete how to and will only enlighten the relevant parts for Zammad.
 
 Within ``database.yml`` (``config/`` directory) you can define the allowed pool size.
@@ -13,11 +12,6 @@ This should be fairly enough for *every* use case.
 If you experience database connection timeouts or similar pool errors, this usually
 indicates to other issues that are relevant to your PostgreSQL.
 
-.. note::
-
-   Below only affects PostgreSQL-Servers. All relevant steps for MySQL are mentioned on
-   :doc:`/prerequisites/software` because they're relevant *before* installation.
-
 Below you can the locations of the relevant PostgreSQL configuration files to adjust.
 Keep in mind that versions may differ from your setup - adapt where needed.
 

appendix/includes/mysql-deprication-note.rst

@@ -1,22 +1,18 @@
 Migrate to PostgreSQL Server
 ============================
 
-.. include:: /appendix/includes/mysql-deprication-note.rst
+The following guide will give you some hints for the migration from
+MySQL/MariaDB to PostgreSQL. Starting with Zammad 7, the only supported database
+server is PostgreSQL.
 
-The following guide will provide you with a rough direction through that
-migration process.
-
-.. note:: **🤓 Zammad version requirement ahead**
-
-   Below commands will only work with Zammad 5.3.0 or higher.
-   Please make sure to update the latest (MySQL supported) version first.
-
-.. warning:: **Proof of concept ahead**
-
-   As the technical details may differ from system to system, this guide
-   comes without any warranty. Please proceed at your own risk. In doubt
-   please refer to the documentation of the tools used.
+.. warning::
 
+   - The commands on this page will only work with Zammad 5.3 or higher.
+   - Make sure to migrate **before** upgrading to Zammad 7. An upgrade
+     to Zammad 7 is not possible on a MySQL installation.
+   - As the technical details may differ from system to system, this guide
+     comes without any warranty. Please proceed at your own risk. In doubt,
+     please refer to the documentation of the tools used.
 
 Preparation
 -----------
@@ -29,25 +25,13 @@ Preparation
 
 #. Create a backup of your instance.
 
-
 Install PostgreSQL
 ^^^^^^^^^^^^^^^^^^
 
 .. include:: /install/includes/postgres-installation.rst
 
 Please also have a look at :doc:`/appendix/configure-database-server`.
 
-.. tabs::
-
-   .. tab:: Package installation
-
-      Nothing to do, continue with the next step. 🎉
-
-   .. tab:: Source code installations
-
-      .. include:: /install/includes/postgres-dependencies.rst
-
-
 Install pgloader
 ^^^^^^^^^^^^^^^^
 
@@ -79,21 +63,9 @@ Create pgloader Command File
 
 Create a command file for pgloader with:
 
-.. tabs::
-
-   .. tab:: Package installation
-
-      .. code-block:: sh
-
-         $ zammad run rake zammad:db:pgloader > /tmp/pgloader-command
-
-   .. tab:: Source installation
-
-      .. code-block:: sh
-
-         $ su - zammad
-         $ rake zammad:db:pgloader > /tmp/pgloader-command
+.. code-block:: sh
 
+   $ zammad run rake zammad:db:pgloader > /tmp/pgloader-command
 
 Afterwards, you need to tweak the created file with the correct URL
 of the target PostgreSQL server.
@@ -110,7 +82,6 @@ example.
 Verify the rest of the MySQL credentials in the command file, they should reflect the
 configuration of your current environment.
 
-
 Database Credentials
 ^^^^^^^^^^^^^^^^^^^^
 
@@ -120,27 +91,14 @@ PostgreSQL server. Use ``postgresql`` as ``adapter``.
 
 .. include:: /install/includes/postgres-permissions.rst
 
-
 Create Empty Database
 ^^^^^^^^^^^^^^^^^^^^^
 
 Now you need to create an empty database in PostgreSQL.
 
-.. tabs::
-
-   .. tab:: Package installation
-
-      .. code-block:: sh
-
-         $ zammad run rake db:create
-
-   .. tab:: Source installation
-
-      .. code-block:: sh
-
-         $ su - zammad
-         $ rake db:create
+.. code-block:: sh
 
+   $ zammad run rake db:create
 
 Migrate
 -------
@@ -163,27 +121,12 @@ Migrate
 
          $ pgloader --verbose /tmp/pgloader-command
 
-
 Finishing
 ---------
 
-After the migration has completed, you'll better clear some cache files:
-
-.. tabs::
-
-   .. tab:: Package installation
-
-      .. code-block:: sh
-
-         $ zammad run rails r 'Rails.cache.clear'
-         $ systemctl start zammad
-
-   .. tab:: Source installation
-
-      .. code-block:: sh
+After the migration has completed, it is recommended to remove some cache files:
 
-         $ su - zammad
-         $ rails r 'Rails.cache.clear'
+.. code-block:: sh
 
-         # Run as root
-         $ systemctl start zammad
+   $ zammad run rails r 'Rails.cache.clear'
+   $ systemctl start zammad

appendix/migrate-to-postgresql.rst

@@ -129,36 +129,18 @@ automatically be installed with the Zammad-Package.
 2.3 Database Server
 ^^^^^^^^^^^^^^^^^^^
 
-Zammad will store all content in a database.
-You can choose between the following database servers:
+Zammad stores its content in a database. The supported database system is
+`PostgreSQL <https://www.postgresql.org/>`_ 10 or newer.
 
-* PostgreSQL 10+
-* MySQL 5.7+ / MariaDB 10.3+ (⚠️ deprecated with Zammad 7.0+)
-
-.. danger::
-
-   .. include:: /appendix/includes/mysql-deprication-note.rst
+If no PostgreSQL server could be detected, it will be installed automatically
+during the package installation.
 
 .. note::
    If you use database connection pooling software like PgBouncer, make sure
    to use a pooling mode that is fully compatible with PostgreSQL. Typically
    this is called "session connection pooling". Transaction-based connection
    pooling is not supported and may lead to errors during database migrations.
 
-For **MySQL/MariaDB**, the following configuration is required:
-
-* Use ``UTF-8`` encoding - ``utf8mb4`` for example will fail!
-* Set ``max_allowed_packet`` to a value larger than the default of 4 MB
-  (64 MB+ recommended).
-
-You may also want to consider the following settings for your **MySQL** server::
-
-   innodb_file_format = Barracuda
-   innodb_file_per_table = on
-   innodb_default_row_format = dynamic
-   innodb_large_prefix = 1
-   innodb_file_format_max = Barracuda
-
 2.4 Reverse Proxy
 ^^^^^^^^^^^^^^^^^