Puppet Class: mysql::server

Inherits:
mysql::params
Defined in:
manifests/server.pp

Summary

Installs and configures the MySQL server.

Overview

Examples:

Install MySQL Server

class { '::mysql::server':
  package_name            => 'mysql-server',
  package_ensure          => '5.7.1+mysql~trusty',
  root_password           => 'strongpassword',
  remove_default_accounts => true,
}

Parameters:

  • config_file (Any) (defaults to: $mysql::params::config_file) —

    The location, as a path, of the MySQL configuration file.

  • config_file_mode (Any) (defaults to: $mysql::params::config_file_mode) —

    The MySQL configuration file’s permissions mode.

  • includedir (Any) (defaults to: $mysql::params::includedir) —

    The location, as a path, of !includedir for custom configuration overrides.

  • install_options (Any) (defaults to: undef) —

    Passes [install_options](docs.puppetlabs.com/references/latest/type.html#package-attribute-install_options) array to managed package resources. You must pass the appropriate options for the specified package manager

  • manage_config_file (Any) (defaults to: $mysql::params::manage_config_file) —

    Whether the MySQL configuration file should be managed. Valid values are ‘true`, `false`. Defaults to `true`.

  • options (Mysql::Options) (defaults to: {}) —

    A hash of options structured like the override_options, but not merged with the default options. Use this if you don’t want your options merged with the default options.

  • override_options (Any) (defaults to: {}) —

    Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file: See above for usage details.

  • package_ensure (Any) (defaults to: $mysql::params::server_package_ensure) —

    Whether the package exists or should be a specific version. Valid values are ‘present’, ‘absent’, or ‘x.y.z’. Defaults to ‘present’.

  • package_manage (Any) (defaults to: $mysql::params::server_package_manage) —

    Whether to manage the MySQL server package. Defaults to ‘true`.

  • package_name (Any) (defaults to: $mysql::params::server_package_name) —

    The name of the MySQL server package to install.

  • package_provider (Any) (defaults to: undef) —

    Define a specific provider for package install.

  • package_source (Any) (defaults to: undef) —

    The location of the package source (require for some package provider)

  • purge_conf_dir (Any) (defaults to: $mysql::params::purge_conf_dir) —

    Whether the ‘includedir` directory should be purged. Valid values are `true`, `false`. Defaults to `false`.

  • remove_default_accounts (Any) (defaults to: false) —

    Specifies whether to automatically include ‘mysql::server::account_security`. Valid values are `true`, `false`. Defaults to `false`.

  • restart (Any) (defaults to: $mysql::params::restart) —

    Whether the service should be restarted when things change. Valid values are ‘true`, `false`. Defaults to `false`.

  • root_group (Any) (defaults to: $mysql::params::root_group) —

    The name of the group used for root. Can be a group name or a group ID. See more about the [group](docs.puppetlabs.com/references/latest/type.html#file-attribute-group).

  • mysql_group (Any) (defaults to: $mysql::params::mysql_group) —

    The name of the group of the MySQL daemon user. Can be a group name or a group ID. See more about the [group](docs.puppetlabs.com/references/latest/type.html#file-attribute-group).

  • mycnf_owner (Any) (defaults to: $mysql::params::mycnf_owner) —

    Name or user-id who owns the mysql-config-file.

  • mycnf_group (Any) (defaults to: $mysql::params::mycnf_group) —

    Name or group-id which owns the mysql-config-file.

  • root_password (Variant[String, Sensitive[String]]) (defaults to: $mysql::params::root_password) —

    The MySQL root password. Puppet attempts to set the root password and update ‘/root/.my.cnf` with it. This is required if `create_root_user` or `create_root_my_cnf` are true. If `root_password` is ’UNSET’, then ‘create_root_user` and `create_root_my_cnf` are assumed to be false — that is, the MySQL root user and `/root/.my.cnf` are not created. Password changes are supported; however, the old password must be set in `/root/.my.cnf`. Effectively, Puppet uses the old password, configured in `/root/my.cnf`, to set the new password in MySQL, and then updates `/root/.my.cnf` with the new password.

  • service_enabled (Any) (defaults to: $mysql::params::server_service_enabled) —

    Specifies whether the service should be enabled. Valid values are ‘true`, `false`. Defaults to `true`.

  • service_manage (Any) (defaults to: $mysql::params::server_service_manage) —

    Specifies whether the service should be managed. Valid values are ‘true`, `false`. Defaults to `true`.

  • service_name (Any) (defaults to: $mysql::params::server_service_name) —

    The name of the MySQL server service. Defaults are OS dependent, defined in ‘params.pp’.

  • service_provider (Any) (defaults to: $mysql::params::server_service_provider) —

    The provider to use to manage the service. For Ubuntu, defaults to ‘upstart’; otherwise, default is undefined.

  • create_root_user (Any) (defaults to: $mysql::params::create_root_user) —

    Whether root user should be created. Valid values are ‘true`, `false`. Defaults to `true`. This is useful for a cluster setup with Galera. The root user has to be created only once. You can set this parameter true on one node and set it to false on the remaining nodes.

  • create_root_my_cnf (Any) (defaults to: $mysql::params::create_root_my_cnf) —

    Whether to create ‘/root/.my.cnf`. Valid values are `true`, `false`. Defaults to `true`. `create_root_my_cnf` allows creation of `/root/.my.cnf` independently of `create_root_user`. You can use this for a cluster setup with Galera where you want `/root/.my.cnf` to exist on all nodes.

  • users (Any) (defaults to: {}) —

    Optional hash of users to create, which are passed to [mysql_user](#mysql_user).

  • grants (Any) (defaults to: {}) —

    Optional hash of grants, which are passed to [mysql_grant](#mysql_grant).

  • databases (Any) (defaults to: {}) —

    Optional hash of databases to create, which are passed to [mysql_database](#mysql_database).

  • enabled (Any) (defaults to: undef) —

    Deprecated

  • manage_service (Any) (defaults to: undef) —

    Deprecated

  • old_root_password (Any) (defaults to: undef) —

    This parameter no longer does anything. It exists only for backwards compatibility. See the ‘root_password` parameter above for details on changing the root password.

  • managed_dirs (Any) (defaults to: $mysql::params::managed_dirs)
  • create_root_login_file (Any) (defaults to: $mysql::params::create_root_login_file)
  • login_file (Any) (defaults to: $mysql::params::login_file) 


77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'manifests/server.pp', line 77

class mysql::server (
  $config_file             = $mysql::params::config_file,
  $config_file_mode        = $mysql::params::config_file_mode,
  $includedir              = $mysql::params::includedir,
  $install_options         = undef,
  $manage_config_file      = $mysql::params::manage_config_file,
  Mysql::Options  $options                 = {},
  $override_options        = {},
  $package_ensure          = $mysql::params::server_package_ensure,
  $package_manage          = $mysql::params::server_package_manage,
  $package_name            = $mysql::params::server_package_name,
  $package_provider        = undef,
  $package_source          = undef,
  $purge_conf_dir          = $mysql::params::purge_conf_dir,
  $remove_default_accounts = false,
  $restart                 = $mysql::params::restart,
  $root_group              = $mysql::params::root_group,
  $managed_dirs            = $mysql::params::managed_dirs,
  $mysql_group             = $mysql::params::mysql_group,
  $mycnf_owner             = $mysql::params::mycnf_owner,
  $mycnf_group             = $mysql::params::mycnf_group,
  Variant[String, Sensitive[String]] $root_password = $mysql::params::root_password,
  $service_enabled         = $mysql::params::server_service_enabled,
  $service_manage          = $mysql::params::server_service_manage,
  $service_name            = $mysql::params::server_service_name,
  $service_provider        = $mysql::params::server_service_provider,
  $create_root_user        = $mysql::params::create_root_user,
  $create_root_my_cnf      = $mysql::params::create_root_my_cnf,
  $create_root_login_file  = $mysql::params::create_root_login_file,
  $login_file              = $mysql::params::login_file,
  $users                   = {},
  $grants                  = {},
  $databases               = {},
  # Deprecated parameters
  $enabled                 = undef,
  $manage_service          = undef,
  $old_root_password       = undef
) inherits mysql::params {
  # Deprecated parameters.
  if $enabled {
    crit('This parameter has been renamed to service_enabled.')
    $real_service_enabled = $enabled
  } else {
    $real_service_enabled = $service_enabled
  }
  if $manage_service {
    crit('This parameter has been renamed to service_manage.')
    $real_service_manage = $manage_service
  } else {
    $real_service_manage = $service_manage
  }
  if $old_root_password {
    warning('The `old_root_password` attribute is no longer used and will be removed in a future release.')
  }

  if ! empty($options) and ! empty($override_options) {
    fail('You can\'t specify $options and $override_options simultaneously, see the README section \'Customize server options\'!')
  }

  # If override_options are set, create a merged together set of options. Rightmost hashes win over left.
  # If options are set, just use them.
  $_options = empty($options) ? {
    true  => mysql::normalise_and_deepmerge($mysql::params::default_options, $override_options),
    false => $options,
  }

  Class['mysql::server::root_password'] -> Mysql::Db <| |>

  include 'mysql::server::config'
  include 'mysql::server::install'
  include 'mysql::server::managed_dirs'
  include 'mysql::server::installdb'
  include 'mysql::server::service'
  include 'mysql::server::root_password'
  include 'mysql::server::providers'

  if $remove_default_accounts {
    class { 'mysql::server::account_security':
      require => Anchor['mysql::server::end'],
    }
  }

  anchor { 'mysql::server::start': }
  anchor { 'mysql::server::end': }

  if $restart {
    Class['mysql::server::config']
    ~> Class['mysql::server::service']
  }

  if $_options['mysqld']['ssl-disable'] {
    notify { 'ssl-disable':
      message => 'Disabling SSL is evil! You should never ever do this except
                if you are forced to use a mysql version compiled without SSL support',
    }
  }

  Anchor['mysql::server::start']
  -> Class['mysql::server::config']
  -> Class['mysql::server::install']
  -> Class['mysql::server::managed_dirs']
  -> Class['mysql::server::installdb']
  -> Class['mysql::server::service']
  -> Class['mysql::server::root_password']
  -> Class['mysql::server::providers']
  -> Anchor['mysql::server::end']
}