Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FreeBSD improvements to the docs #200

Open
wants to merge 4 commits into
base: draft
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion galeracluster/source/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,9 @@ The way to protect your node from such crashing is to ensure that you have suffi
/swap/swap1 file 524284 0 -2
/swap/swap2 file 524284 0 -3

If your system does not have swap space available or if the allotted space is insufficient for your needs, you can fix this by creating swap files.
On FreeBSD run ``swapinfo`` and consult the `documentation <https://www.freebsd.org/doc/handbook/adding-swap-space.html>`_ for how to add more swap if you need it.

On Linux, if your system does not have swap space available or if the allotted space is insufficient for your needs, you can fix this by creating swap files.

#. Create an empty file on your disk, set the file size to whatever size you require.

Expand Down
14 changes: 11 additions & 3 deletions galeracluster/source/installmariadb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ MariaDB Galera Cluster - Binary Installation
============================================
.. _`galera-mariadb-binary-install`:

MariaDB Galera Cluster is the MariaDB implementation of Galera Cluster for MySQL. Binary installation packages are available for Debian- and RPM-based distributions of Linux through the MariaDB repository.
MariaDB Galera Cluster is the MariaDB implementation of Galera Cluster for MySQL. Binary installation packages are available for Debian- and RPM-based distributions of Linux through the MariaDB repository and for FreeBSD through its packaging system.

---------------------------------
Enabling the MariaDB Repository
---------------------------------
.. _`mariadb-repo`:

In order to install MariaDB Galera Cluster through your package manager, you need to first enable the MariaDB repository on your system. There are two different ways to accomplish this, depending on which Linux distribution you use.
In order to install MariaDB Galera Cluster through your package manager, you need to first enable the MariaDB repository on your system. There are two different ways to accomplish this, depending on which Linux distribution you use. Skip this step for FreeBSD.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Enabling the ``apt`` Repository
Expand Down Expand Up @@ -105,7 +105,7 @@ Installing MariaDB Galera Cluster
---------------------------------
.. _`mariadb-install`:

There are three packages involved in the installation of MariaDB Galera Cluster: the MariaDB database client, a command line tool for accessing the database; the MariaDB database server, built to include the :term:`wsrep API` patch; and the :term:`Galera Replication Plugin`.
There are three packages involved in the installation of MariaDB Galera Cluster: the MariaDB database client (a command line tool for accessing the database); the MariaDB database server, built to include the :term:`wsrep API` patch; and the :term:`Galera Replication Plugin`.

For Debian-based distributions, in the terminal run the following command:

Expand All @@ -123,6 +123,14 @@ For RPM-based distributions, instead run this command:
MariaDB-Galera-server \
galera

For FreeBSD run this command:

.. code-block:: console

# pkg install databases/mariadb101-client \
databases/mariadb101-server \
databases/galera

MariaDB Galera Cluster is now installed on your server. You will need to repeat this process for each node in your cluster.

.. note:: **See Also**: In the event that you installed MariaDB Galera Cluster over an existing standalone instance of MariaDB, there are some additional steps that you need to take in order to update your system to the new database server. For more information, see :doc:`migration`.
6 changes: 6 additions & 0 deletions galeracluster/source/startingcluster.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,12 @@ For systems that use ``systemd``, instead use this command:

# systemctl start mysql --wsrep-new-cluster

For FreeBSD use this command:

.. code-block:: console

# mysql_args="--wsrep-new-cluster" /usr/local/etc/rc.d/mysql-server start

This starts ``mysqld`` on the node.

.. note:: **Warning**: Only use the ``--wsrep-new-cluster`` argument when initializing the Primary Component. Do not use it when you want the node to connect to an existing cluster.
Expand Down