[SC] Apply SC customizations and upstream PR voxpupuli#247

lroehrs · lroehrs · commit 4d81a321fe37 · 2026-04-02T15:13:50.000+02:00
SC-specific changes: - Use .my.proxysql.cnf instead of .my.cnf to avoid conflicts with MySQL on hosts running both MySQL and ProxySQL - Remove Sensitive[String] password types and .unwrap calls for compatibility with existing Hiera data and Puppet 7 setups Upstream PR voxpupuli#247 (not yet merged): - Add ProxySQL 3.0.x repository support for APT and YUM - Improve admin socket readiness check: use actual mysql SELECT 1 query instead of just testing socket file existence - Handle first-run (no .my.cnf) vs subsequent runs (with .my.cnf) Document all SC customizations in README.
diff --git a/README.markdown b/README.markdown
@@ -7,6 +7,29 @@
 [![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/proxysql.svg)](https://forge.puppet.com/puppet/proxysql)
 [![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/proxysql.svg)](https://forge.puppet.com/puppet/proxysql)
 
+## ScaleCommerce Fork
+
+This is a fork of [voxpupuli/puppet-proxysql](https://github.com/voxpupuli/puppet-proxysql) with the following customizations:
+
+### `.my.proxysql.cnf` instead of `.my.cnf`
+
+The default path for the ProxySQL admin credentials file is `/root/.my.proxysql.cnf` instead of `/root/.my.cnf`.
+This avoids conflicts with MySQL's own `.my.cnf` on hosts where both MySQL and ProxySQL are running.
+
+Affected files: `manifests/init.pp`, `lib/puppet/provider/proxysql.rb`, `lib/facter/proxysql_runtime.rb`, all `lib/puppet/type/*.rb` (autorequire), specs.
+
+### Plain String passwords instead of Sensitive
+
+Upstream uses `Sensitive[String]` for password parameters with `.unwrap` calls. This fork uses plain `String` types to maintain compatibility with existing Hiera data and Puppet 7 setups.
+
+Affected files: `manifests/init.pp`, `templates/my.cnf.erb`.
+
+### Upstream PR #247
+
+ProxySQL 3.0.x repository support and improved admin socket readiness check from [voxpupuli/puppet-proxysql#247](https://github.com/voxpupuli/puppet-proxysql/pull/247).
+
+---
+
 ## Table of Contents
 
 1. [Overview](#overview)
diff --git a/REFERENCE.md b/REFERENCE.md
@@ -340,7 +340,7 @@ Data type: `String`
 Path of the my.cnf file where the connections details for the admin interface is save. This is required for the providers to work.
 This will only be configured if `manage_mycnf_file` is set to `true`.
 
-Default value: `'/root/.my.cnf'`
+Default value: `'/root/.my.proxysql.cnf'`
 
 ##### <a name="-proxysql--manage_mycnf_file"></a>`manage_mycnf_file`
 
@@ -385,7 +385,7 @@ Default value: `true`
 
 ##### <a name="-proxysql--version"></a>`version`
 
-Data type: `Pattern[/^[1|2]\.\d+\.\d+/]`
+Data type: `Pattern[/^[1|2|3]\.\d+\.\d+/]`
 
 The version of proxysql being managed. This parameter affects the repository configured when `manage_repo == true` and how the service is managed.
 It does not affect the package version being installed. It is used as a hint to the puppet module on how to configure proxysql. To control the exact version
@@ -445,7 +445,7 @@ Default value:
 ```puppet
 $version ? {
     /^1/ => 'root',
-    /^2/ => 'proxysql'
+    /^2|3/ => 'proxysql'
 ```
 
 ##### <a name="-proxysql--sys_group"></a>`sys_group`
diff --git a/lib/facter/proxysql_runtime.rb b/lib/facter/proxysql_runtime.rb
@@ -15,7 +15,7 @@
     end
 
     begin
-      client = Mysql2::Client.new(default_file: '/root/.my.cnf')
+      client = Mysql2::Client.new(default_file: '/root/.my.proxysql.cnf')
     rescue Mysql2::Error::ConnectionError => e
       Facter.debug(e.inspect)
     end
diff --git a/lib/puppet/provider/proxysql.rb b/lib/puppet/provider/proxysql.rb
@@ -11,7 +11,7 @@ class Puppet::Provider::Proxysql < Puppet::Provider
 
   # Optional defaults file
   def self.defaults_file
-    "--defaults-extra-file=#{Facter.value(:root_home)}/.my.cnf" if File.file?("#{Facter.value(:root_home)}/.my.cnf")
+    "--defaults-extra-file=#{Facter.value(:root_home)}/.my.proxysql.cnf" if File.file?("#{Facter.value(:root_home)}/.my.proxysql.cnf")
   end
 
   def defaults_file
diff --git a/lib/puppet/type/proxy_cluster.rb b/lib/puppet/type/proxy_cluster.rb
@@ -6,7 +6,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_global_variable.rb b/lib/puppet/type/proxy_global_variable.rb
@@ -4,7 +4,7 @@
 Puppet::Type.newtype(:proxy_global_variable) do
   @doc = 'Manage a ProxySQL global variable.'
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_galera_hostgroup.rb b/lib/puppet/type/proxy_mysql_galera_hostgroup.rb
@@ -5,7 +5,7 @@
 Puppet::Type.newtype(:proxy_mysql_galera_hostgroup) do
   @doc = 'Manage a ProxySQL mysql_galera_hostgroup.'
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_group_replication_hostgroup.rb b/lib/puppet/type/proxy_mysql_group_replication_hostgroup.rb
@@ -6,7 +6,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_query_rule.rb b/lib/puppet/type/proxy_mysql_query_rule.rb
@@ -5,7 +5,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_replication_hostgroup.rb b/lib/puppet/type/proxy_mysql_replication_hostgroup.rb
@@ -6,7 +6,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_server.rb b/lib/puppet/type/proxy_mysql_server.rb
@@ -6,7 +6,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_server_no_hostgroup.rb b/lib/puppet/type/proxy_mysql_server_no_hostgroup.rb
@@ -6,7 +6,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_mysql_user.rb b/lib/puppet/type/proxy_mysql_user.rb
@@ -8,7 +8,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/lib/puppet/type/proxy_scheduler.rb b/lib/puppet/type/proxy_scheduler.rb
@@ -5,7 +5,7 @@
 
   ensurable
 
-  autorequire(:file) { '/root/.my.cnf' }
+  autorequire(:file) { '/root/.my.proxysql.cnf' }
   autorequire(:class) { 'mysql::client' }
   autorequire(:service) { 'proxysql' }
 
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -5,7 +5,7 @@
 # @param package_ensure
 #   The ensure of the ProxySQL package resource.
 # @param package_install_options
-#   An array of additional options to pass when installing a package. 
+#   An array of additional options to pass when installing a package.
 # @param service_name
 #   The name of the ProxySQL service resource.
 # @param service_ensure
@@ -23,7 +23,7 @@
 # @param errorlog_file_group
 #   Group of the `errorlog_file`. Available from ProxySQL v2.0.0
 # @param manage_selinux
-#   Whether to create the required selinux rules for logrotate to work. 
+#   Whether to create the required selinux rules for logrotate to work.
 #   This parameter also requires the `puppet/selinux` module to be installed.
 # @param manage_mysql_client
 #   Whether to include the mysql::client class.
@@ -151,16 +151,16 @@
   String $listen_socket = $proxysql::params::listen_socket,
 
   String $admin_username = 'admin',
-  Sensitive[String] $admin_password = Sensitive('admin'),
+  String $admin_password = 'admin',
   String $admin_listen_ip = '127.0.0.1',
   Integer $admin_listen_port = 6032,
   String $admin_listen_socket = $proxysql::params::admin_listen_socket,
 
   String $stats_username = 'stats',
-  Sensitive[String] $stats_password = Sensitive('stats'),
+  String $stats_password = 'stats',
 
   String $monitor_username = 'monitor',
-  Sensitive[String] $monitor_password = Sensitive('monitor'),
+  String $monitor_password = 'monitor',
 
   Boolean $split_config = false,
 
@@ -170,7 +170,7 @@
   String $config_file = '/etc/proxysql.cnf',
   Boolean $manage_config_file = true,
 
-  String $mycnf_file_name = '/root/.my.cnf',
+  String $mycnf_file_name = '/root/.my.proxysql.cnf',
   Boolean $manage_mycnf_file = true,
 
   Boolean $restart = false,
@@ -179,7 +179,7 @@
   Boolean $save_to_disk = true,
 
   Boolean $manage_repo = true,
-  Pattern[/^[1|2]\.\d+\.\d+/] $version = $proxysql::params::version,
+  Pattern[/^[1|2|3]\.\d+\.\d+/] $version = $proxysql::params::version,
 
   Optional[String[1]] $package_source         = undef,
   Optional[String[1]] $package_checksum_value = undef,
@@ -189,12 +189,12 @@
 
   String $sys_owner = $version ? {
     /^1/ => 'root',
-    /^2/ => 'proxysql',
+    /^2|3/ => 'proxysql',
   },
   String $sys_group = $sys_owner,
 
   String $cluster_username = 'cluster',
-  Sensitive[String] $cluster_password = Sensitive('cluster'),
+  String $cluster_password = 'cluster',
 
   Hash $override_config_settings = {},
 
@@ -212,14 +212,14 @@
     datadir => $datadir,
     errorlog => $errorlog_file,
     admin_variables => {
-      admin_credentials => "${admin_username}:${admin_password.unwrap}",
+      admin_credentials => "${admin_username}:${admin_password}",
       mysql_ifaces      => "${admin_listen_ip}:${admin_listen_port};${admin_listen_socket}",
-      stats_credentials => "${stats_username}:${stats_password.unwrap}",
+      stats_credentials => "${stats_username}:${stats_password}",
     },
     mysql_variables => {
       interfaces       => "${listen_ip}:${listen_port};${listen_socket}",
       monitor_username => $monitor_username,
-      monitor_password => $monitor_password.unwrap,
+      monitor_password => $monitor_password,
     },
     mysql_servers => {},
     mysql_users => {},
@@ -233,9 +233,9 @@
   $cluster_settings = $cluster_name ? {
     String  => {
       admin_variables => {
-        admin_credentials => "${admin_username}:${admin_password.unwrap};${cluster_username}:${cluster_password.unwrap}",
+        admin_credentials => "${admin_username}:${admin_password};${cluster_username}:${cluster_password}",
         cluster_username  => $cluster_username,
-        cluster_password  => "${cluster_password.unwrap}",
+        cluster_password  => "${cluster_password}",
       },
     },
     default => {},
diff --git a/manifests/params.pp b/manifests/params.pp
@@ -76,6 +76,16 @@
           'source' => 'https://repo.proxysql.com/ProxySQL/proxysql-2.7.x/repo_pub_key',
         },
       }
+      $repo30 = {
+        comment  => 'ProxySQL 3.0.x APT repository',
+        location => "http://repo.proxysql.com/ProxySQL/proxysql-3.0.x/${facts['os']['distro']['codename']}/",
+        release  => './',
+        repos    => ' ',
+        key      => {
+          'name'   => 'proxysql-3.0.x.asc',
+          'source' => 'https://repo.proxysql.com/ProxySQL/proxysql-3.0.x/repo_pub_key',
+        },
+      }
     }
     'RedHat': {
       $package_provider = 'rpm'
@@ -132,6 +142,14 @@
         gpgcheck => true,
         gpgkey   => 'http://repo.proxysql.com/ProxySQL/repo_pub_key',
       }
+      $repo30             = {
+        name     => 'proxysql_3_0',
+        descr    => 'ProxySQL 3.0.x YUM repository',
+        baseurl  => "http://repo.proxysql.com/ProxySQL/proxysql-3.0.x/centos/${repo_os_major_version}",
+        enabled  => true,
+        gpgcheck => true,
+        gpgkey   => 'http://repo.proxysql.com/ProxySQL/repo_pub_key',
+      }
     }
     default: {
       fail("osfamily ${facts['os']['family']} is not supported")
diff --git a/manifests/repo.pp b/manifests/repo.pp
@@ -6,6 +6,7 @@
 
   if $proxysql::manage_repo and !$proxysql::package_source {
     $repo = $proxysql::version ? {
+      /^3\.0\./ => $proxysql::params::repo30,
       /^2\.7\./ => $proxysql::params::repo27,
       /^2\.6\./ => $proxysql::params::repo26,
       /^2\.5\./ => $proxysql::params::repo25,
diff --git a/manifests/service.pp b/manifests/service.pp
@@ -6,7 +6,7 @@
 
   # systemd unit files replaced use of `init.d` in version 2.0.0 for some operating systems but only in 2.0.7 for CentOS/Redhat
   if (versioncmp($proxysql::version, '2.0.7') >= 0 and fact('os.family') == 'RedHat' and fact('os.name') != 'Amazon')
-  or (versioncmp($proxysql::version, '2')     >= 0 and fact('os.family') == 'Debian') {
+  or (versioncmp($proxysql::version, '2') >= 0 and fact('os.family') == 'Debian') {
     $drop_in_ensure = $proxysql::restart ? {
       true  => 'present',
       false => 'absent',
@@ -53,12 +53,32 @@
     }
   }
 
-  exec { 'wait_for_admin_socket_to_open':
-    command   => "test -S ${proxysql::admin_listen_socket}",
-    unless    => "test -S ${proxysql::admin_listen_socket}",
-    tries     => '3',
-    try_sleep => '10',
-    require   => Service[$proxysql::service_name],
-    path      => '/bin:/usr/bin',
+  $socket_wait_connection_method = $proxysql::admin_listen_socket ? {
+    ''      => "-h ${proxysql::admin_listen_ip} -P ${proxysql::admin_listen_port}",
+    default => "-S ${proxysql::admin_listen_socket}"
+  }
+
+  $wait_exec_params = {
+    tries       => '10',
+    try_sleep   => '2',
+    subscribe   => Service[$proxysql::service_name],
+    refreshonly => true,
+    path        => '/bin:/usr/bin',
+  }
+
+  # It happens that the admin socket is created but not ready (at least during acceptance tests)
+  # This first exec is used for the first run when no .my.cnf file is created yet
+  exec { 'wait_for_admin_socket_availability_no_my_cnf':
+    command     => "mysql -u ${proxysql::admin_username} ${socket_wait_connection_method} -e 'SELECT 1'",
+    environment => ["MYSQL_PWD=${proxysql::admin_password}"],
+    unless      => "test -f ${proxysql::mycnf_file_name}",
+    *           => $wait_exec_params,
+  }
+
+  # We prefer to use .my.cnf if available. In case of password change, we need the old credentials.
+  exec { 'wait_for_admin_socket_availability_with_my_cnf':
+    command => "mysql --defaults-extra-file=${proxysql::mycnf_file_name} -e 'SELECT 1'",
+    onlyif  => "test -f ${proxysql::mycnf_file_name}",
+    *       => $wait_exec_params,
   }
 }
diff --git a/spec/acceptance/class_spec.rb b/spec/acceptance/class_spec.rb
@@ -35,6 +35,44 @@ class { 'proxysql':
     end
   end
 
+  context 'Upgrading to version 3.0' do
+    it 'works idempotently with no errors' do
+      pp = <<-EOS
+      class { 'proxysql':
+        package_ensure => latest,
+        version        => '3.0.4',
+        admin_password => Sensitive('new-admin-password'),
+      }
+      EOS
+
+      # Run it twice and test for idempotency
+      apply_manifest(pp, catch_failures: true)
+      apply_manifest(pp, catch_changes: true)
+
+      # Run it again, this time relying on proxysql_version fact
+      pp = <<-EOS
+      class { 'proxysql':
+        admin_password => Sensitive('new-admin-password'),
+      }
+      EOS
+      apply_manifest(pp, catch_changes: true)
+    end
+
+    describe package('proxysql') do
+      it { is_expected.to be_installed }
+    end
+
+    describe service('proxysql') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+
+    describe command('proxysql --version') do
+      its(:exit_status) { is_expected.to eq 0 }
+      its(:stdout) { is_expected.to match %r{^ProxySQL version 3\.0\.} }
+    end
+  end
+
   context 'extended testing' do
     # Using puppet_apply as a helper
     it 'works idempotently with no errors' do
diff --git a/spec/classes/proxysql_spec.rb b/spec/classes/proxysql_spec.rb
diff --git a/spec/unit/puppet/type/proxy_mysql_galera_hostgroup_spec.rb b/spec/unit/puppet/type/proxy_mysql_galera_hostgroup_spec.rb
diff --git a/templates/my.cnf.erb b/templates/my.cnf.erb
