Resource Type: proxy_mysql_server

Defined in:

lib/puppet/type/proxy_mysql_server.rb

Providers:

proxysql

Overview

Manage a ProxySQL mysql_server.

Properties

• comment

  text field that can be used for any purposed defined by the user. Could be a description of what the host stores, a reminder of when the host was added or disabled, or a JSON processed by some checker script.

  Supported values:

  • %r{[\w+]}
• compression

  if the value is greater than 0, new connections to that server will use compression

  Supported values:

  • %r{\d+}
• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• hostgroup_id (defaults to: 0)

  The hostgroup of the server.

  Supported values:

  • %r{\d+}
• hostname (defaults to: localhost)

  The hostname of the server.

  Supported values:

  • %r{\w+}
• max_connections

  the maximum number of connections ProxySQL will open to this backend server. Even though this server will have the highest weight, no new connections will be opened to it once this limit is hit. Please ensure that the backend is configured with a correct value of max_connections to avoid that ProxySQL will try to go beyond that limit

  Supported values:

  • %r{\d+}
• max_latency_ms

  ping time is regularly monitored. If a host has a ping time greater than max_latency_ms it is excluded from the connection pool (although the server stays ONLINE)

  Supported values:

  • %r{[\d+]}
• max_replication_lag

  if greater and 0, ProxySQL will reguarly monitor replication lag and if it goes beyond such threshold it will temporary shun the host until replication catch ups

  Supported values:

  • %r{\d+}
• port (defaults to: 3306)

  The port of the server.

  Supported values:

  • %r{\d+}
• status

  Server status.

  Supported values:

  • ONLINE
  • SHUNNED
  • OFFLINE_SOFT
  • OFFLINE_HARD
• use_ssl

  if set to 1, connections to the backend will use SSL

  Supported values:

  • %r{[01]}
• weight

  the bigger the weight of a server relative to other weights, the higher the probability of the server to be chosen from a hostgroup

  Supported values:

  • %r{\d+}

Parameters

• load_to_runtime (defaults to: true)

  Load this entry to the active runtime.

  Supported values:

  • true
  • false
• name (namevar)

  name for server to manage.

• provider

  The specific backend to use for this ‘proxy_mysql_server` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• save_to_disk (defaults to: true)

  Perist this entry to the disk.

  Supported values:

  • true
  • false