README.md

puppet-proxysql_binlog

Table of Contents

• puppet-proxysql_binlog - Table of Contents
  • Description
  • Setup
    • Setup Requirements
    • Beginning with proxysql_binlog
• Reference
  • Table of Contents
  • Classes
    • proxysql_binlog
      • Examples
        • Install proxysql-binlog.
      • Parameters
        • package_name
        • version
        • manage_service
        • user
        • group
        • package_install_options
        • override_config
        • enable_logrotate
  • Functions
    • proxysql_binlog_config
      • proxysql_binlog_config(Hash $Settings)
  • Limitations
  • Development

Description

The proxysql_binlog module installs, configures and manages the proxysql-binlog service.

Setup

Setup Requirements

This module requires toml gem, which is used to translate Hash configuration to proxysql-binlog toml format configuration files. To install it you need to execute following command on your puppetmaster server:

sudo puppetserver gem install toml

Beginning with proxysql_binlog

To install a proxysql-binlog with the default options:

include 'proxysql_binlog'

To customize proxysql-binlog configuration, you must also pass in an override hash:

class { 'proxysql_binlog':
  user            => 'myawesomeuser',
  override_config => {
    'mysql' => {
      'user'     => 'myslaveuser',
      'password' => 'myslavepassword'
    }
  }
}

Reference

Table of Contents

Classes

Public Classes

• proxysql_binlog: Installs and configures proxysql-binlog.

Private Classes

• proxysql_binlog::config: Private class for managing proxysql-binlog config.
• proxysql_binlog::install: Private class for installing proxysql-binlog.
• proxysql_binlog::params: Private class for setting default proxysql-binlog parameters.
• proxysql_binlog::service: Private class for managing proxysql-binlog service.

Functions

• proxysql_binlog_config: Convert hash to proxysql-binlog TOML config.

Classes

proxysql_binlog

Installs and configures proxysql-binlog.

Examples

Install proxysql-binlog.

class { 'proxysql-binlog':
  override_config  => {
    general => {
      listen_address => '127.0.0.1:3008',
    }
  }
}

Parameters

The following parameters are available in the proxysql_binlog class.

package_name

Data type: String

Package containing proxysql-binlog. Defaults to 'proxysql-binlog'.

Default value: $proxysql_binlog::params::package_name

version

Data type: String

Version of proxysql-binlog. Defaults to 'latest'.

Default value: $proxysql_binlog::params::version

manage_service

Data type: Boolean

Specifies whether proxysql-binlog service should be managed. Defaults to 'true'.

Default value: $proxysql_binlog::params::manage_service

user

Data type: String

User for proxysql-binlog. Defaults to 'proxysql_binlog'.

Default value: $proxysql_binlog::params::user

group

Data type: String

User for proxysql-binlog. Defaults to 'proxysql_binlog'.

Default value: $proxysql_binlog::params::group

package_install_options

Data type: Array[String]

Array of install options for managed package resources. Appropriate options are passed to package manager.

Default value: $proxysql_binlog::params::package_install_options

override_config

Data type: Hash

Hash of override configuration options for proxysql-binlog

Default value: {}

enable_logrotate

Data type: Boolean

Default value: $proxysql_binlog::params::enable_logrotate

Functions

proxysql_binlog_config

Type: Ruby 3.x API

Convert hash to proxysql-binlog TOML config.

proxysql_binlog_config(Hash $Settings)

The proxysql_binlog_config function.

Returns: Toml proxysql-binlog configuration content.

Limitations

For a list of supported operating systems, see metadata.json

Development

Please feel free to fork, modify, create issues, bug reports and pull requests.