374 lines
13 KiB
Python
374 lines
13 KiB
Python
"""Helper for working with a MySQL database"""
|
|
import json
|
|
import socket
|
|
import re
|
|
import sys
|
|
import platform
|
|
import os
|
|
import glob
|
|
|
|
from string import upper
|
|
|
|
from charmhelpers.core.host import (
|
|
mkdir,
|
|
pwgen,
|
|
write_file
|
|
)
|
|
from charmhelpers.core.hookenv import (
|
|
relation_get,
|
|
related_units,
|
|
service_name,
|
|
unit_get,
|
|
log,
|
|
DEBUG,
|
|
INFO,
|
|
)
|
|
from charmhelpers.core.hookenv import config as config_get
|
|
from charmhelpers.fetch import (
|
|
apt_install,
|
|
apt_update,
|
|
filter_installed_packages,
|
|
)
|
|
from charmhelpers.contrib.peerstorage import (
|
|
peer_store,
|
|
peer_retrieve,
|
|
)
|
|
|
|
try:
|
|
import MySQLdb
|
|
except ImportError:
|
|
apt_update(fatal=True)
|
|
apt_install(filter_installed_packages(['python-mysqldb']), fatal=True)
|
|
import MySQLdb
|
|
|
|
|
|
class MySQLHelper(object):
|
|
|
|
def __init__(self, rpasswdf_template, upasswdf_template, host='localhost'):
|
|
self.host = host
|
|
# Password file path templates
|
|
self.root_passwd_file_template = rpasswdf_template
|
|
self.user_passwd_file_template = upasswdf_template
|
|
|
|
def connect(self, user='root', password=None):
|
|
self.connection = MySQLdb.connect(user=user, host=self.host,
|
|
passwd=password)
|
|
|
|
def database_exists(self, db_name):
|
|
cursor = self.connection.cursor()
|
|
try:
|
|
cursor.execute("SHOW DATABASES")
|
|
databases = [i[0] for i in cursor.fetchall()]
|
|
finally:
|
|
cursor.close()
|
|
|
|
return db_name in databases
|
|
|
|
def create_database(self, db_name):
|
|
cursor = self.connection.cursor()
|
|
try:
|
|
cursor.execute("CREATE DATABASE {} CHARACTER SET UTF8"
|
|
.format(db_name))
|
|
finally:
|
|
cursor.close()
|
|
|
|
def grant_exists(self, db_name, db_user, remote_ip):
|
|
cursor = self.connection.cursor()
|
|
priv_string = "GRANT ALL PRIVILEGES ON `{}`.* " \
|
|
"TO '{}'@'{}'".format(db_name, db_user, remote_ip)
|
|
try:
|
|
cursor.execute("SHOW GRANTS for '{}'@'{}'".format(db_user,
|
|
remote_ip))
|
|
grants = [i[0] for i in cursor.fetchall()]
|
|
except MySQLdb.OperationalError:
|
|
return False
|
|
finally:
|
|
cursor.close()
|
|
|
|
# TODO: review for different grants
|
|
return priv_string in grants
|
|
|
|
def create_grant(self, db_name, db_user, remote_ip, password):
|
|
cursor = self.connection.cursor()
|
|
try:
|
|
# TODO: review for different grants
|
|
cursor.execute("GRANT ALL PRIVILEGES ON {}.* TO '{}'@'{}' "
|
|
"IDENTIFIED BY '{}'".format(db_name,
|
|
db_user,
|
|
remote_ip,
|
|
password))
|
|
finally:
|
|
cursor.close()
|
|
|
|
def create_admin_grant(self, db_user, remote_ip, password):
|
|
cursor = self.connection.cursor()
|
|
try:
|
|
cursor.execute("GRANT ALL PRIVILEGES ON *.* TO '{}'@'{}' "
|
|
"IDENTIFIED BY '{}'".format(db_user,
|
|
remote_ip,
|
|
password))
|
|
finally:
|
|
cursor.close()
|
|
|
|
def cleanup_grant(self, db_user, remote_ip):
|
|
cursor = self.connection.cursor()
|
|
try:
|
|
cursor.execute("DROP FROM mysql.user WHERE user='{}' "
|
|
"AND HOST='{}'".format(db_user,
|
|
remote_ip))
|
|
finally:
|
|
cursor.close()
|
|
|
|
def execute(self, sql):
|
|
"""Execute arbitary SQL against the database."""
|
|
cursor = self.connection.cursor()
|
|
try:
|
|
cursor.execute(sql)
|
|
finally:
|
|
cursor.close()
|
|
|
|
def migrate_passwords_to_peer_relation(self):
|
|
"""Migrate any passwords storage on disk to cluster peer relation."""
|
|
template = self.user_passwd_file_template
|
|
for f in glob.glob(template.format(service_name(), '*')):
|
|
_key = os.path.basename(f)
|
|
with open(f, 'r') as passwd:
|
|
_value = passwd.read().strip()
|
|
|
|
try:
|
|
peer_store(_key, _value)
|
|
os.unlink(f)
|
|
except ValueError:
|
|
# NOTE cluster relation not yet ready - skip for now
|
|
pass
|
|
|
|
def get_mysql_password_on_disk(self, username=None, password=None):
|
|
"""Retrieve, generate or store a mysql password for the provided
|
|
username on disk."""
|
|
if username:
|
|
template = self.user_passwd_file_template
|
|
passwd_file = template.format(service_name(), username)
|
|
else:
|
|
template = self.root_passwd_file_template
|
|
passwd_file = template.format(service_name())
|
|
|
|
_password = None
|
|
if os.path.exists(passwd_file):
|
|
with open(passwd_file, 'r') as passwd:
|
|
_password = passwd.read().strip()
|
|
else:
|
|
mkdir(os.path.dirname(passwd_file), owner='root', group='root',
|
|
perms=0o770)
|
|
# Force permissions - for some reason the chmod in makedirs fails
|
|
os.chmod(os.path.dirname(passwd_file), 0o770)
|
|
_password = password or pwgen(length=32)
|
|
write_file(passwd_file, _password, owner='root', group='root',
|
|
perms=0o660)
|
|
|
|
return _password
|
|
|
|
def get_mysql_password(self, username=None, password=None):
|
|
"""Retrieve, generate or store a mysql password for the provided
|
|
username using peer relation cluster."""
|
|
self.migrate_passwords_to_peer_relation()
|
|
if username:
|
|
_key = '{}.passwd'.format(username)
|
|
else:
|
|
_key = 'mysql.passwd'
|
|
|
|
try:
|
|
_password = peer_retrieve(_key)
|
|
if _password is None:
|
|
_password = password or pwgen(length=32)
|
|
peer_store(_key, _password)
|
|
except ValueError:
|
|
# cluster relation is not yet started; use on-disk
|
|
_password = self.get_mysql_password_on_disk(username, password)
|
|
|
|
return _password
|
|
|
|
def get_mysql_root_password(self, password=None):
|
|
"""Retrieve or generate mysql root password for service units."""
|
|
return self.get_mysql_password(username=None, password=password)
|
|
|
|
def get_allowed_units(self, database, username, relation_id=None):
|
|
"""Get list of units with access grants for database with username.
|
|
|
|
This is typically used to provide shared-db relations with a list of
|
|
which units have been granted access to the given database.
|
|
"""
|
|
self.connect(password=self.get_mysql_root_password())
|
|
allowed_units = set()
|
|
for unit in related_units(relation_id):
|
|
settings = relation_get(rid=relation_id, unit=unit)
|
|
# First check for setting with prefix, then without
|
|
for attr in ["%s_hostname" % (database), 'hostname']:
|
|
hosts = settings.get(attr, None)
|
|
if hosts:
|
|
break
|
|
|
|
if hosts:
|
|
# hostname can be json-encoded list of hostnames
|
|
try:
|
|
hosts = json.loads(hosts)
|
|
except ValueError:
|
|
hosts = [hosts]
|
|
else:
|
|
hosts = [settings['private-address']]
|
|
|
|
if hosts:
|
|
for host in hosts:
|
|
if self.grant_exists(database, username, host):
|
|
log("Grant exists for host '%s' on db '%s'" %
|
|
(host, database), level=DEBUG)
|
|
if unit not in allowed_units:
|
|
allowed_units.add(unit)
|
|
else:
|
|
log("Grant does NOT exist for host '%s' on db '%s'" %
|
|
(host, database), level=DEBUG)
|
|
else:
|
|
log("No hosts found for grant check", level=INFO)
|
|
|
|
return allowed_units
|
|
|
|
def configure_db(self, hostname, database, username, admin=False):
|
|
"""Configure access to database for username from hostname."""
|
|
if config_get('prefer-ipv6'):
|
|
remote_ip = hostname
|
|
elif hostname != unit_get('private-address'):
|
|
try:
|
|
remote_ip = socket.gethostbyname(hostname)
|
|
except Exception:
|
|
# socket.gethostbyname doesn't support ipv6
|
|
remote_ip = hostname
|
|
else:
|
|
remote_ip = '127.0.0.1'
|
|
|
|
self.connect(password=self.get_mysql_root_password())
|
|
if not self.database_exists(database):
|
|
self.create_database(database)
|
|
|
|
password = self.get_mysql_password(username)
|
|
if not self.grant_exists(database, username, remote_ip):
|
|
if not admin:
|
|
self.create_grant(database, username, remote_ip, password)
|
|
else:
|
|
self.create_admin_grant(username, remote_ip, password)
|
|
|
|
return password
|
|
|
|
|
|
class PerconaClusterHelper(object):
|
|
|
|
# Going for the biggest page size to avoid wasted bytes. InnoDB page size is
|
|
# 16MB
|
|
DEFAULT_PAGE_SIZE = 16 * 1024 * 1024
|
|
|
|
def human_to_bytes(self, human):
|
|
"""Convert human readable configuration options to bytes."""
|
|
num_re = re.compile('^[0-9]+$')
|
|
if num_re.match(human):
|
|
return human
|
|
|
|
factors = {
|
|
'K': 1024,
|
|
'M': 1048576,
|
|
'G': 1073741824,
|
|
'T': 1099511627776
|
|
}
|
|
modifier = human[-1]
|
|
if modifier in factors:
|
|
return int(human[:-1]) * factors[modifier]
|
|
|
|
if modifier == '%':
|
|
total_ram = self.human_to_bytes(self.get_mem_total())
|
|
if self.is_32bit_system() and total_ram > self.sys_mem_limit():
|
|
total_ram = self.sys_mem_limit()
|
|
factor = int(human[:-1]) * 0.01
|
|
pctram = total_ram * factor
|
|
return int(pctram - (pctram % self.DEFAULT_PAGE_SIZE))
|
|
|
|
raise ValueError("Can only convert K,M,G, or T")
|
|
|
|
def is_32bit_system(self):
|
|
"""Determine whether system is 32 or 64 bit."""
|
|
try:
|
|
return sys.maxsize < 2 ** 32
|
|
except OverflowError:
|
|
return False
|
|
|
|
def sys_mem_limit(self):
|
|
"""Determine the default memory limit for the current service unit."""
|
|
if platform.machine() in ['armv7l']:
|
|
_mem_limit = self.human_to_bytes('2700M') # experimentally determined
|
|
else:
|
|
# Limit for x86 based 32bit systems
|
|
_mem_limit = self.human_to_bytes('4G')
|
|
|
|
return _mem_limit
|
|
|
|
def get_mem_total(self):
|
|
"""Calculate the total memory in the current service unit."""
|
|
with open('/proc/meminfo') as meminfo_file:
|
|
for line in meminfo_file:
|
|
key, mem = line.split(':', 2)
|
|
if key == 'MemTotal':
|
|
mtot, modifier = mem.strip().split(' ')
|
|
return '%s%s' % (mtot, upper(modifier[0]))
|
|
|
|
def parse_config(self):
|
|
"""Parse charm configuration and calculate values for config files."""
|
|
config = config_get()
|
|
mysql_config = {}
|
|
if 'max-connections' in config:
|
|
mysql_config['max_connections'] = config['max-connections']
|
|
|
|
# Total memory available for dataset
|
|
dataset_bytes = self.human_to_bytes(config['dataset-size'])
|
|
mysql_config['dataset_bytes'] = dataset_bytes
|
|
|
|
if 'query-cache-type' in config:
|
|
# Query Cache Configuration
|
|
mysql_config['query_cache_size'] = config['query-cache-size']
|
|
if (config['query-cache-size'] == -1 and
|
|
config['query-cache-type'] in ['ON', 'DEMAND']):
|
|
# Calculate the query cache size automatically
|
|
qcache_bytes = (dataset_bytes * 0.20)
|
|
qcache_bytes = int(qcache_bytes -
|
|
(qcache_bytes % self.DEFAULT_PAGE_SIZE))
|
|
mysql_config['query_cache_size'] = qcache_bytes
|
|
dataset_bytes -= qcache_bytes
|
|
|
|
# 5.5 allows the words, but not 5.1
|
|
if config['query-cache-type'] == 'ON':
|
|
mysql_config['query_cache_type'] = 1
|
|
elif config['query-cache-type'] == 'DEMAND':
|
|
mysql_config['query_cache_type'] = 2
|
|
else:
|
|
mysql_config['query_cache_type'] = 0
|
|
|
|
# Set a sane default key_buffer size
|
|
mysql_config['key_buffer'] = self.human_to_bytes('32M')
|
|
|
|
if 'preferred-storage-engine' in config:
|
|
# Storage engine configuration
|
|
preferred_engines = config['preferred-storage-engine'].split(',')
|
|
chunk_size = int(dataset_bytes / len(preferred_engines))
|
|
mysql_config['innodb_flush_log_at_trx_commit'] = 1
|
|
mysql_config['sync_binlog'] = 1
|
|
if 'InnoDB' in preferred_engines:
|
|
mysql_config['innodb_buffer_pool_size'] = chunk_size
|
|
if config['tuning-level'] == 'fast':
|
|
mysql_config['innodb_flush_log_at_trx_commit'] = 2
|
|
else:
|
|
mysql_config['innodb_buffer_pool_size'] = 0
|
|
|
|
mysql_config['default_storage_engine'] = preferred_engines[0]
|
|
if 'MyISAM' in preferred_engines:
|
|
mysql_config['key_buffer'] = chunk_size
|
|
|
|
if config['tuning-level'] == 'fast':
|
|
mysql_config['sync_binlog'] = 0
|
|
|
|
return mysql_config
|