charm-percona-cluster/config.yaml

options:
  source:
    type: string
    default:
    description: |
      Package install location for Percona XtraDB Cluster (defaults to distro
      for >= 14.04)      
  key:
    type: string
    default:
    description: |
      Key ID to import to the apt keyring to support use with arbitary source
      configuration from outside of Launchpad archives or PPA's.      
  innodb-file-per-table:
    type: boolean
    default: True
    description: |
      Turns on innodb_file_per_table option, which will make MySQL put each
      InnoDB table into separate .idb file. Existing InnoDB tables will remain
      in ibdata1 file - full dump/import is needed to get rid of large
      ibdata1 file      
  table-open-cache:
    type: int
    default: 2048
    description:
      Sets table_open_cache (formerly known as table_cache) to mysql.
  dataset-size:
    type: string
    default:
    description: |
      (DEPRECATED - use innodb-buffer-pool-size) How much data should be kept
      in memory in the DB. This will be used to tune settings in the database
      server appropriately. Supported suffixes include K/M/G/T. If suffixed
      with %, one will get that percentage of RAM allocated to the dataset.      
  innodb-buffer-pool-size:
    type: string
    default:
    description: |
      By default this value will be set according to 50% of system total
      memory or 512MB (whichever is lowest) but also can be set to any specific
      value for the system.  Supported suffixes include K/M/G/T. If suffixed
      with %, one will get that percentage of system total memory allocated.      
  max-connections:
    type: int
    default: 600
    description: |
      Maximum connections to allow. A value of -1 means use the server's
      compiled-in default.  This is not typically that useful so the
      charm will configure PXC with a default max-connections value of 600.
      Note: Connections take up memory resources. Either at startup time with
      performance-schema=True or during run time with performance-schema=False.
      This value is a balance between connection exhaustion and memory
      exhaustion.
      Consult a MySQL memory calculator like http://www.mysqlcalculator.com/ to
      understand memory resources consumed by connections.
      See also performance-schema.      
  wait-timeout:
    type: int
    default: -1
    description: |
      The number of seconds the server waits for activity on a noninteractive
      connection before closing it. -1 means use the server's compiled in
      default.      
  root-password:
    type: string
    default:
    description: |
      Root password for MySQL access; must be configured pre-deployment for
      Active-Active clusters.      
  sst-password:
    type: string
    default:
    description: |
      Re-sync account password for new cluster nodes; must be configured
      pre-deployment for Active-Active clusters.      
  sst-method:
    type: string
    default: xtrabackup-v2
    description: |
      Percona method for taking the State Snapshot Transfer (SST), can be:
      'rsync', 'xtrabackup', 'xtrabackup-v2', 'mysqldump', 'skip' - see
      https://www.percona.com/doc/percona-xtradb-cluster/5.5/wsrep-system-index.html#wsrep_sst_method      
  min-cluster-size:
    type: int
    default:
    description: |
      Minimum number of units expected to exist before charm will attempt to
      bootstrap percona cluster. If no value is provided this setting is
      ignored.      
  dns-ha:
    type: boolean
    default: False
    description: |
        Use DNS HA with MAAS 2.0. Note if this is set do not set vip
        settings below.        
  vip:
    type: string
    default:
    description: |
      Virtual IP to use to front Percona XtraDB Cluster in active/active HA
      configuration      
  vip_iface:
    type: string
    default: eth0
    description: Network interface on which to place the Virtual IP.
  vip_cidr:
    type: int
    default: 24
    description: Netmask that will be used for the Virtual IP.
  ha-bindiface:
    type: string
    default: eth0
    description: |
      Default network interface on which HA cluster will bind to communication
      with the other members of the HA Cluster.      
  ha-mcastport:
    type: int
    default: 5490
    description: |
      Default multicast port number that will be used to communicate between HA
      Cluster nodes.      
  # Network configuration options
  # by default all access is over 'private-address'
  access-network:
    type: string
    default:
    description: |
      The IP address and netmask of the 'access' network (e.g. 192.168.0.0/24)
      .
      This network will be used for access to database services.      
  os-access-hostname:
    type: string
    default:
    description: |
      The hostname or address of the access endpoint for percona-cluster.      
  cluster-network:
    type: string
    default:
    description: |
      The IP address and netmask of the cluster (replication) network (e.g.
      192.168.0.0/24)
      .
      This network will be used for wsrep_cluster replication.      
  prefer-ipv6:
    type: boolean
    default: False
    description: |
      If True enables IPv6 support. The charm will expect network interfaces
      to be configured with an IPv6 address. If set to False (default) IPv4
      is expected.
      .
      NOTE: these charms do not currently support IPv6 privacy extension. In
      order for this charm to function correctly, the privacy extension must be
      disabled and a non-temporary address must be configured/available on
      your network interface.      
  lp1366997-workaround:
    type: boolean
    default: False
    description: |
      Adds two config options (wsrep_drupal_282555_workaround and
      wsrep_retry_autocommit) as a workaround for Percona Primary Key bug (see
      LP 1366997).      
  # Nagios configuration options
  nagios_context:
    type: string
    default: 'juju'
    description: |
      Used by the nrpe-external-master subordinate charm. A string that will be
      prepended to instance name to set the host name in nagios. So for
      instance the hostname would be something like:
      .
        juju-myservice-0
      .
      If you're running multiple environments with the same services in them
      this allows you to differentiate between them.      
  nagios_servicegroups:
    type: string
    default: ''
    description: |
      A comma-separated list of nagios servicegroups. If left empty, the
      nagios_context will be used as the servicegroup.      
  harden:
    default:
    type: string
    description: |
      Apply system hardening. Supports a space-delimited list of modules
      to run. Supported modules currently include os, ssh, apache and mysql.      
  enable-binlogs:
    default: False
    type: boolean
    description: |
      Turns on MySQL binary logs. The placement of the logs is controlled with
      the binlogs_path config option.      
  binlogs-path:
    default: /var/log/mysql/mysql-bin.log
    type: string
    description: |
      Location on the filesystem where binlogs are going to be placed.
      Default mimics what mysql-common package would do for mysql.
      Make sure you do not put binlogs inside mysql datadir (/var/lib/mysql/)!      
  binlogs-max-size:
    default: 100M
    type: string
    description: |
      Sets the max_binlog_size mysql configuration option, which will limit the
      size of the binary log files. The server will automatically rotate binlgos
      after they grow to be bigger than this value.
      Keep in mind that transactions are never split between binary logs, so
      therefore binary logs might get larger than configured value.      
  binlogs-expire-days:
    default: 10
    type: int
    description: |
      Sets the expire_logs_days mysql configuration option, which will make
      mysql server automatically remove logs older than configured number of
      days.      
  performance-schema:
    default: False
    type: boolean
    description: |
      The performance schema attempts to automatically size the values of
      several of its parameters at server startup if they are not set
      explicitly. When set to on (True) memory is allocated at startup time.
      The implications of this is any memory related charm config options such
      as max-connections and innodb-buffer-pool-size must be explicitly set for
      the environment percona is running in or percona may fail to start.
      Default to off (False) at startup time giving 5.5 like behavior. The
      implication of this is one can set configuration values that could lead
      to memory exhaustion during run time as memory is not allocated at
      startup time.