openstack/openstack-ansible
Code Issues Proposed changes

[doc] Reffer to mariadb instead of mysql as client

Browse Source 
With latest used MariaDB-client, it has dropped linking to `mysql`
leaving only `mariadb` as an option. So we need to reflect these
changes in our documentation

Closes-Bug: #2099771
Change-Id: Ibf8c65a40c7cc7421f322f5bbf559153b845ef78
This commit is contained in:
Dmitriy Rabotyagov
2025-02-24 11:49:39 +01:00
parent 0cca73263b
commit 443e946c6d
5 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/maintenance-tasks/ansible-modules.rst
View File

@@ -64,7 +64,7 @@ To check on the status of your Galera cluster:
.. code-block:: console .. code-block:: console
$ ansible galera_container -m shell -a "mysql \ $ ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
When a module is being used as an ad-hoc command, there are a few parameters When a module is being used as an ad-hoc command, there are a few parameters

28
doc/source/admin/maintenance-tasks/galera.rst
View File

@@ -17,7 +17,7 @@ It should give you information about the status of your cluster.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "mysql \ # ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
node3_galera_container-3ea2cbd3 | FAILED | rc=1 >> node3_galera_container-3ea2cbd3 | FAILED | rc=1 >>
ERROR 2002 (HY000): Can't connect to local MySQL server ERROR 2002 (HY000): Can't connect to local MySQL server
@@ -81,10 +81,10 @@ one of the nodes.
.. code-block:: shell-session .. code-block:: shell-session
## for init ## for init
# /etc/init.d/mysql start --wsrep-new-cluster # /etc/init.d/mariadb start --wsrep-new-cluster
## for systemd ## for systemd
# systemctl set-environment _WSREP_NEW_CLUSTER='--wsrep-new-cluster' # systemctl set-environment _WSREP_NEW_CLUSTER='--wsrep-new-cluster'
# systemctl start mysql # systemctl start mariadb
# systemctl set-environment _WSREP_NEW_CLUSTER='' # systemctl set-environment _WSREP_NEW_CLUSTER=''
Please also have a look at `upstream starting a cluster page <https://galeracluster.com/documentation-webpages/startingcluster.html>`_ Please also have a look at `upstream starting a cluster page <https://galeracluster.com/documentation-webpages/startingcluster.html>`_
@@ -94,7 +94,7 @@ one of the nodes.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "/etc/init.d/mysql start --wsrep-new-cluster" --limit galera_container[0] # ansible galera_container -m shell -a "/etc/init.d/mariadb start --wsrep-new-cluster" --limit galera_container[0]
This command results in a cluster containing a single node. The This command results in a cluster containing a single node. The
``wsrep_cluster_size`` value shows the number of nodes in the ``wsrep_cluster_size`` value shows the number of nodes in the
@@ -186,7 +186,7 @@ continue to process SQL requests.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "mysql \ # ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
node3_galera_container-3ea2cbd3 | FAILED | rc=1 >> node3_galera_container-3ea2cbd3 | FAILED | rc=1 >>
ERROR 2002 (HY000): Can't connect to local MySQL server through ERROR 2002 (HY000): Can't connect to local MySQL server through
@@ -212,7 +212,7 @@ continue to process SQL requests.
#. Restart MariaDB on the failed node and verify that it rejoins the #. Restart MariaDB on the failed node and verify that it rejoins the
cluster. cluster.
#. If MariaDB fails to start, run the ``mysqld`` command and perform #. If MariaDB fails to start, run the ``mariadbd`` command and perform
further analysis on the output. As a last resort, rebuild the container further analysis on the output. As a last resort, rebuild the container
for the node. for the node.
@@ -227,7 +227,7 @@ recover cannot join the cluster because it no longer exists.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "mysql \ # ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
node2_galera_container-49a47d25 | FAILED | rc=1 >> node2_galera_container-49a47d25 | FAILED | rc=1 >>
ERROR 2002 (HY000): Can't connect to local MySQL server ERROR 2002 (HY000): Can't connect to local MySQL server
@@ -253,7 +253,7 @@ recover cannot join the cluster because it no longer exists.
.. code-block:: shell-session .. code-block:: shell-session
# mysql -e "SET GLOBAL wsrep_provider_options='pc.bootstrap=yes';" # mariadb -e "SET GLOBAL wsrep_provider_options='pc.bootstrap=yes';"
node4_galera_container-76275635 | success | rc=0 >> node4_galera_container-76275635 | success | rc=0 >>
Variable_name Value Variable_name Value
wsrep_cluster_conf_id 15 wsrep_cluster_conf_id 15
@@ -277,7 +277,7 @@ recover cannot join the cluster because it no longer exists.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "mysql \ # ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
node3_galera_container-3ea2cbd3 | success | rc=0 >> node3_galera_container-3ea2cbd3 | success | rc=0 >>
Variable_name Value Variable_name Value
@@ -301,7 +301,7 @@ recover cannot join the cluster because it no longer exists.
wsrep_cluster_status Primary wsrep_cluster_status Primary
#. If MariaDB fails to start on any of the failed nodes, run the #. If MariaDB fails to start on any of the failed nodes, run the
``mysqld`` command and perform further analysis on the output. As a ``mariadbd`` command and perform further analysis on the output. As a
last resort, rebuild the container for the node. last resort, rebuild the container for the node.
Recover a complete environment failure Recover a complete environment failure
@@ -337,7 +337,7 @@ the cluster have failed:
cert_index: cert_index:
All the nodes have failed if ``mysqld`` is not running on any of the All the nodes have failed if ``mariadbd`` is not running on any of the
nodes and all of the nodes contain a ``seqno`` value of -1. nodes and all of the nodes contain a ``seqno`` value of -1.
If any single node has a positive ``seqno`` value, then that node can be If any single node has a positive ``seqno`` value, then that node can be
@@ -396,7 +396,7 @@ Recovering from certain failures require rebuilding one or more containers.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "mysql \ # ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
node3_galera_container-3ea2cbd3 | success | rc=0 >> node3_galera_container-3ea2cbd3 | success | rc=0 >>
Variable_name Value Variable_name Value
@@ -427,7 +427,7 @@ Recovering from certain failures require rebuilding one or more containers.
In larger deployments, it may take some time for the MariaDB daemon to In larger deployments, it may take some time for the MariaDB daemon to
start in the new container. It will be synchronizing data from the other start in the new container. It will be synchronizing data from the other
MariaDB servers during this time. You can monitor the status during this MariaDB servers during this time. You can monitor the status during this
process by tailing the ``/var/log/mysql_logs/galera_server_error.log`` process by tailing the ``journalctl -f -u mariadb``
log file. log file.
Lines starting with ``WSREP_SST`` will appear during the sync process Lines starting with ``WSREP_SST`` will appear during the sync process
@@ -436,7 +436,7 @@ Recovering from certain failures require rebuilding one or more containers.
.. code-block:: shell-session .. code-block:: shell-session
# ansible galera_container -m shell -a "mysql \ # ansible galera_container -m shell -a "mariadb \
-e 'show status like \"%wsrep_cluster_%\";'" -e 'show status like \"%wsrep_cluster_%\";'"
node2_galera_container-49a47d25 | success | rc=0 >> node2_galera_container-49a47d25 | success | rc=0 >>
Variable_name Value Variable_name Value

2
doc/source/admin/scale-environment.rst
View File

@@ -347,7 +347,7 @@ If a LVM backed Block Storage host needs to be shut down:
.. code-block:: console .. code-block:: console
# mysql cinder -BNe 'select instance_uuid from volumes where deleted=0 '\ # mariadb cinder -BNe 'select instance_uuid from volumes where deleted=0 '\
'and host like "%<cinder host>%"' | tee /home/user/running_instances 'and host like "%<cinder host>%"' | tee /home/user/running_instances
#. Shut down the instances: #. Shut down the instances:

10
doc/source/admin/scaling-swift.rst
View File

@@ -23,7 +23,7 @@ backend.
.. code:: .. code::
# mysql -e "SELECT default_project_id from keystone.user WHERE \ # mariadb -e "SELECT default_project_id from keystone.user WHERE \
name='admin';" name='admin';"
+----------------------------------+ +----------------------------------+
@@ -39,7 +39,7 @@ backend.
.. code:: .. code::
# mysql -e "SELECT default_project_id from keystone.user WHERE \ # mariadb -e "SELECT default_project_id from keystone.user WHERE \
name='admin';" name='admin';"
+----------------------------------+ +----------------------------------+
@@ -56,15 +56,15 @@ backend.
# export PRIMARY_REGION_TENANT_ID="76ef6df109744a03b64ffaad2a7cf504" # export PRIMARY_REGION_TENANT_ID="76ef6df109744a03b64ffaad2a7cf504"
# export SECONDARY_REGION_TENANT_ID="69c46f8ad1cf4a058aa76640985c" # export SECONDARY_REGION_TENANT_ID="69c46f8ad1cf4a058aa76640985c"
# mysql -e "UPDATE keystone.assignment set \ # mariadb -e "UPDATE keystone.assignment set \
target_id='${PRIMARY_REGION_TENANT_ID}' \ target_id='${PRIMARY_REGION_TENANT_ID}' \
WHERE target_id='${SECONDARY_REGION_TENANT_ID}';" WHERE target_id='${SECONDARY_REGION_TENANT_ID}';"
# mysql -e "UPDATE keystone.user set \ # mariadb -e "UPDATE keystone.user set \
default_project_id='${PRIMARY_REGION_TENANT_ID}' WHERE \ default_project_id='${PRIMARY_REGION_TENANT_ID}' WHERE \
default_project_id='${SECONDARY_REGION_TENANT_ID}';" default_project_id='${SECONDARY_REGION_TENANT_ID}';"
# mysql -e "UPDATE keystone.project set \ # mariadb -e "UPDATE keystone.project set \
id='${PRIMARY_REGION_TENANT_ID}' WHERE \ id='${PRIMARY_REGION_TENANT_ID}' WHERE \
id='${SECONDARY_REGION_TENANT_ID}';" id='${SECONDARY_REGION_TENANT_ID}';"

8
doc/source/admin/upgrades/distribution-upgrades.rst
View File

@@ -263,7 +263,7 @@ Deploying Infrastructure Hosts
.. code:: console .. code:: console
mysql -e 'SHOW STATUS LIKE "wsrep_cluster_%";' mariadb -e 'SHOW STATUS LIKE "wsrep_cluster_%";'
In case node is not getting synced you might need to restart the In case node is not getting synced you might need to restart the
@@ -272,9 +272,9 @@ Deploying Infrastructure Hosts
.. code:: console .. code:: console
systemctl restart mariadb.service systemctl restart mariadb.service
mysql mariadb
mysql> SHOW STATUS LIKE "wsrep_cluster_%"; MariaDB> SHOW STATUS LIKE "wsrep_cluster_%";
mysql> SHOW DATABASES; MariaDB> SHOW DATABASES;
Once MariaDB cluster is healthy you can remove the file that disables Once MariaDB cluster is healthy you can remove the file that disables
backend from being used by HAProxy. backend from being used by HAProxy.