blob: d0fa1199a79ef1e166cdd122ef0a78016ef756c8 [file] [log] [blame]
Sean Daguee263c822014-12-05 14:25:28 -05001#!/bin/bash
2#
Dean Troyer6d04fd72012-12-21 11:03:37 -06003# lib/databases/mysql
4# Functions to control the configuration and operation of the **MySQL** database backend
Terry Wilson428af5a2012-11-01 16:12:39 -04005
6# Dependencies:
Adam Spiers6a5aa7c2013-10-24 11:27:02 +01007#
8# - DATABASE_{HOST,USER,PASSWORD} must be defined
Terry Wilson428af5a2012-11-01 16:12:39 -04009
10# Save trace setting
Ian Wienand523f4882015-10-13 11:03:03 +110011_XTRACE_DB_MYSQL=$(set +o | grep xtrace)
Terry Wilson428af5a2012-11-01 16:12:39 -040012set +o xtrace
13
armando-migliacciob3d88222015-06-12 07:54:03 -070014MYSQL_DRIVER=${MYSQL_DRIVER:-PyMySQL}
Dean Troyercc6b4432013-04-08 15:38:03 -050015
Terry Wilson428af5a2012-11-01 16:12:39 -040016register_database mysql
17
Slawek Kaplonskid54a1c62019-09-10 12:05:06 +020018if [[ -z "$MYSQL_SERVICE_NAME" ]]; then
19 MYSQL_SERVICE_NAME=mysql
20 if is_fedora && ! is_oraclelinux; then
21 MYSQL_SERVICE_NAME=mariadb
22 elif is_suse && systemctl list-unit-files | grep -q 'mariadb\.service'; then
23 # Older mariadb packages on SLES 12 provided mysql.service. The
24 # newer ones on SLES 12 and 15 use mariadb.service; they also
25 # provide a mysql.service symlink for backwards-compatibility, but
26 # let's not rely on that.
27 MYSQL_SERVICE_NAME=mariadb
Jens Harbott959a7c22021-05-02 09:29:15 +020028 elif [[ "$DISTRO" == "bullseye" ]]; then
29 MYSQL_SERVICE_NAME=mariadb
Slawek Kaplonskid54a1c62019-09-10 12:05:06 +020030 fi
Sean Dague53753292014-12-04 19:38:15 -050031fi
Dean Troyercc6b4432013-04-08 15:38:03 -050032
33# Functions
34# ---------
35
Julien Danjou0eec4f82015-09-08 10:45:06 +000036function get_database_type_mysql {
37 if [[ "$MYSQL_DRIVER" == "PyMySQL" ]]; then
38 echo mysql+pymysql
39 else
40 echo mysql
41 fi
42}
43
Dean Troyer995eb922013-03-07 16:11:40 -060044# Get rid of everything enough to cleanly change database backends
45function cleanup_database_mysql {
Dirk Mueller1d968d72017-09-23 14:45:42 +020046 stop_service $MYSQL_SERVICE_NAME
Dean Troyer995eb922013-03-07 16:11:40 -060047 if is_ubuntu; then
48 # Get ruthless with mysql
Sean Dague8f90f762015-01-14 10:36:48 -050049 apt_get purge -y mysql* mariadb*
Dean Troyer995eb922013-03-07 16:11:40 -060050 sudo rm -rf /var/lib/mysql
Tiago Mello4376ae02014-03-14 10:48:56 -030051 sudo rm -rf /etc/mysql
Dean Troyer995eb922013-03-07 16:11:40 -060052 return
Dirk Mueller1d968d72017-09-23 14:45:42 +020053 elif is_oraclelinux; then
Wiekus Beukesec47bc12015-03-19 08:20:38 -070054 uninstall_package mysql-community-server
55 sudo rm -rf /var/lib/mysql
Dirk Mueller1d968d72017-09-23 14:45:42 +020056 elif is_suse || is_fedora; then
Attila Fazekas1f316be2015-01-26 16:39:57 +010057 uninstall_package mariadb-server
58 sudo rm -rf /var/lib/mysql
Dean Troyer995eb922013-03-07 16:11:40 -060059 else
60 return
61 fi
Dean Troyer995eb922013-03-07 16:11:40 -060062}
63
Terry Wilson428af5a2012-11-01 16:12:39 -040064function recreate_database_mysql {
65 local db=$1
zhhuabj2832f282013-05-08 18:43:26 +080066 mysql -u$DATABASE_USER -p$DATABASE_PASSWORD -h$MYSQL_HOST -e "DROP DATABASE IF EXISTS $db;"
Ihar Hrachyshka157c84b2014-10-06 13:29:39 +020067 mysql -u$DATABASE_USER -p$DATABASE_PASSWORD -h$MYSQL_HOST -e "CREATE DATABASE $db CHARACTER SET utf8;"
Terry Wilson428af5a2012-11-01 16:12:39 -040068}
69
70function configure_database_mysql {
Dean Troyer3ef23bc2014-07-25 14:56:22 -050071 local my_conf mysql slow_log
Terry Wilson428af5a2012-11-01 16:12:39 -040072 echo_summary "Configuring and starting MySQL"
73
Vincent Untzc18b9652012-12-04 12:36:34 +010074 if is_ubuntu; then
Dean Troyer3ef23bc2014-07-25 14:56:22 -050075 my_conf=/etc/mysql/my.cnf
Wiekus Beukesec47bc12015-03-19 08:20:38 -070076 elif is_suse || is_oraclelinux; then
77 my_conf=/etc/my.cnf
Vincent Untz00011c02012-12-06 09:56:32 +010078 elif is_fedora; then
Dean Troyer3ef23bc2014-07-25 14:56:22 -050079 my_conf=/etc/my.cnf
Yuval Brik13e81ad2017-06-23 10:32:16 +030080 local cracklib_conf=/etc/my.cnf.d/cracklib_password_check.cnf
81 if [ -f "$cracklib_conf" ]; then
82 inicomment -sudo "$cracklib_conf" "mariadb" "plugin-load-add"
83 fi
Vincent Untz00011c02012-12-06 09:56:32 +010084 else
85 exit_distro_not_supported "mysql configuration"
Terry Wilson428af5a2012-11-01 16:12:39 -040086 fi
87
88 # Start mysql-server
Vincent Untz00011c02012-12-06 09:56:32 +010089 if is_fedora || is_suse; then
90 # service is not started by default
Dirk Mueller1d968d72017-09-23 14:45:42 +020091 start_service $MYSQL_SERVICE_NAME
Vincent Untz00011c02012-12-06 09:56:32 +010092 fi
93
94 # Set the root password - only works the first time. For Ubuntu, we already
Jens Rosenboom9abb26d2016-12-07 21:12:55 +010095 # did that with debconf before installing the package, but we still try,
96 # because the package might have been installed already.
97 sudo mysqladmin -u root password $DATABASE_PASSWORD || true
Vincent Untz00011c02012-12-06 09:56:32 +010098
Slawek Kaplonskid54a1c62019-09-10 12:05:06 +020099 # In case of Mariadb, giving hostname in arguments causes permission
100 # problems as it expects connection through socket
101 if is_ubuntu && [ "$MYSQL_SERVICE_NAME" == "mariadb" ]; then
102 local cmd_args="-uroot -p$DATABASE_PASSWORD "
103 else
104 local cmd_args="-uroot -p$DATABASE_PASSWORD -h127.0.0.1 "
105 fi
106
107 # In mariadb e.g. on Ubuntu socket plugin is used for authentication
108 # as root so it works only as sudo. To restore old "mysql like" behaviour,
109 # we need to change auth plugin for root user
Jens Harbott959a7c22021-05-02 09:29:15 +0200110 if is_ubuntu && [[ "$DISTRO" != "bullseye" ]] && [ "$MYSQL_SERVICE_NAME" == "mariadb" ]; then
Slawek Kaplonskid54a1c62019-09-10 12:05:06 +0200111 sudo mysql $cmd_args -e "UPDATE mysql.user SET plugin='' WHERE user='$DATABASE_USER' AND host='localhost';"
112 sudo mysql $cmd_args -e "FLUSH PRIVILEGES;"
113 fi
Dr. Jens Harbott08d84bc2020-02-12 10:07:36 +0000114 # Create DB user if it does not already exist
115 sudo mysql $cmd_args -e "CREATE USER IF NOT EXISTS '$DATABASE_USER'@'%' identified by '$DATABASE_PASSWORD';"
Marian Horbanea21eb42015-08-18 06:57:18 -0400116 # Update the DB to give user '$DATABASE_USER'@'%' full control of the all databases:
Dr. Jens Harbott08d84bc2020-02-12 10:07:36 +0000117 sudo mysql $cmd_args -e "GRANT ALL PRIVILEGES ON *.* TO '$DATABASE_USER'@'%';"
Terry Wilson428af5a2012-11-01 16:12:39 -0400118
119 # Now update ``my.cnf`` for some local needs and restart the mysql service
120
Marian Horbanea21eb42015-08-18 06:57:18 -0400121 # Change bind-address from localhost (127.0.0.1) to any (::) and
Ralf Haferkamp0526bb82014-04-03 08:27:33 +0200122 # set default db type to InnoDB
Jens Harbottdc7b4292017-09-19 10:52:32 +0000123 iniset -sudo $my_conf mysqld bind-address "$(ipv6_unquote $SERVICE_LISTEN_ADDRESS)"
Roman Podoliaka88b84092017-02-07 13:34:12 +0200124 iniset -sudo $my_conf mysqld sql_mode TRADITIONAL
Ian Wienand9c0b9f32015-07-22 06:08:09 +1000125 iniset -sudo $my_conf mysqld default-storage-engine InnoDB
Jens Rosenboom4b59fbb2017-03-15 21:58:48 +0000126 iniset -sudo $my_conf mysqld max_connections 1024
Terry Wilson428af5a2012-11-01 16:12:39 -0400127
Jeremy Stanleyc4f47342014-01-25 01:10:31 +0000128 if [[ "$DATABASE_QUERY_LOGGING" == "True" ]]; then
129 echo_summary "Enabling MySQL query logging"
Attila Fazekas1f316be2015-01-26 16:39:57 +0100130 if is_fedora; then
Attila Fazekas3b53aeb2014-04-30 11:57:22 +0200131 slow_log=/var/log/mariadb/mariadb-slow.log
132 else
133 slow_log=/var/log/mysql/mysql-slow.log
134 fi
Ralf Haferkamp0526bb82014-04-03 08:27:33 +0200135 sudo sed -e '/log.slow.queries/d' \
136 -e '/long.query.time/d' \
137 -e '/log.queries.not.using.indexes/d' \
Dean Troyer3ef23bc2014-07-25 14:56:22 -0500138 -i $my_conf
Monty Taylor7c73e8d2013-01-07 08:17:01 +0000139
Ralf Haferkamp0526bb82014-04-03 08:27:33 +0200140 # Turn on slow query log, log all queries (any query taking longer than
141 # 0 seconds) and log all non-indexed queries
Ian Wienand9c0b9f32015-07-22 06:08:09 +1000142 iniset -sudo $my_conf mysqld slow-query-log 1
143 iniset -sudo $my_conf mysqld slow-query-log-file $slow_log
144 iniset -sudo $my_conf mysqld long-query-time 0
145 iniset -sudo $my_conf mysqld log-queries-not-using-indexes 1
Jeremy Stanleyc4f47342014-01-25 01:10:31 +0000146 fi
Monty Taylor7c73e8d2013-01-07 08:17:01 +0000147
Dirk Mueller1d968d72017-09-23 14:45:42 +0200148 restart_service $MYSQL_SERVICE_NAME
Terry Wilson428af5a2012-11-01 16:12:39 -0400149}
150
151function install_database_mysql {
Vincent Untzc18b9652012-12-04 12:36:34 +0100152 if is_ubuntu; then
Terry Wilson428af5a2012-11-01 16:12:39 -0400153 # Seed configuration with mysql password so that apt-get install doesn't
154 # prompt us for a password upon install.
Bob Ball90333432015-01-19 10:56:42 +0000155 sudo debconf-set-selections <<MYSQL_PRESEED
156mysql-server mysql-server/root_password password $DATABASE_PASSWORD
157mysql-server mysql-server/root_password_again password $DATABASE_PASSWORD
158mysql-server mysql-server/start_on_boot boolean true
Terry Wilson428af5a2012-11-01 16:12:39 -0400159MYSQL_PRESEED
160 fi
161
162 # while ``.my.cnf`` is not needed for OpenStack to function, it is useful
163 # as it allows you to access the mysql databases via ``mysql nova`` instead
164 # of having to specify the username/password each time.
165 if [[ ! -e $HOME/.my.cnf ]]; then
166 cat <<EOF >$HOME/.my.cnf
167[client]
168user=$DATABASE_USER
169password=$DATABASE_PASSWORD
Terry Wilson428af5a2012-11-01 16:12:39 -0400170EOF
Slawek Kaplonskid54a1c62019-09-10 12:05:06 +0200171
172 if ! is_ubuntu || [ "$MYSQL_SERVICE_NAME" != "mariadb" ]; then
173 echo "host=$MYSQL_HOST" >> $HOME/.my.cnf
174 fi
Terry Wilson428af5a2012-11-01 16:12:39 -0400175 chmod 0600 $HOME/.my.cnf
176 fi
177 # Install mysql-server
Dirk Mueller1d968d72017-09-23 14:45:42 +0200178 if is_oraclelinux; then
179 install_package mysql-community-server
Ian Wienand812e7842020-04-17 09:25:22 +1000180 elif is_fedora; then
181 install_package mariadb-server mariadb-devel
182 sudo systemctl enable $MYSQL_SERVICE_NAME
183 elif is_suse; then
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700184 install_package mariadb-server
Dirk Mueller1d968d72017-09-23 14:45:42 +0200185 sudo systemctl enable $MYSQL_SERVICE_NAME
Wiekus Beukesec47bc12015-03-19 08:20:38 -0700186 elif is_ubuntu; then
Slawek Kaplonskid54a1c62019-09-10 12:05:06 +0200187 install_package $MYSQL_SERVICE_NAME-server
Vincent Untzca5c4712012-11-21 17:45:49 +0100188 else
Vincent Untz00011c02012-12-06 09:56:32 +0100189 exit_distro_not_supported "mysql installation"
Vincent Untzca5c4712012-11-21 17:45:49 +0100190 fi
Dean Troyer5686dbc2015-03-09 14:27:51 -0500191}
Dean Troyerb1d8e8e2015-02-16 13:58:35 -0600192
Dean Troyer5686dbc2015-03-09 14:27:51 -0500193function install_database_python_mysql {
Dean Troyerb1d8e8e2015-02-16 13:58:35 -0600194 # Install Python client module
Sean Dague37421992015-05-20 06:37:11 -0700195 pip_install_gr $MYSQL_DRIVER
196 if [[ "$MYSQL_DRIVER" == "MySQL-python" ]]; then
197 ADDITIONAL_VENV_PACKAGES+=",MySQL-python"
Julien Danjou0f63eb32015-06-12 09:05:12 +0200198 elif [[ "$MYSQL_DRIVER" == "PyMySQL" ]]; then
199 ADDITIONAL_VENV_PACKAGES+=",PyMySQL"
Sean Dague37421992015-05-20 06:37:11 -0700200 fi
Terry Wilson428af5a2012-11-01 16:12:39 -0400201}
202
203function database_connection_url_mysql {
Attila Fazekas7e79d912013-03-03 12:23:04 +0100204 local db=$1
205 echo "$BASE_SQL_CONN/$db?charset=utf8"
Terry Wilson428af5a2012-11-01 16:12:39 -0400206}
207
Dean Troyercc6b4432013-04-08 15:38:03 -0500208
Terry Wilson428af5a2012-11-01 16:12:39 -0400209# Restore xtrace
Ian Wienand523f4882015-10-13 11:03:03 +1100210$_XTRACE_DB_MYSQL
Sean Dague584d90e2013-03-29 14:34:53 -0400211
212# Local variables:
213# mode: shell-script
214# End: