Puppet Class: clickhouse_keeper

Defined in:
manifests/init.pp

Summary

Manages Clickouse Keeper

Overview

Examples:

include clickhouse_keeper

Parameters:

  • address (String) (defaults to: $facts['networking']['ip'])

    Exported address to raft config, used only when ‘export_raft` is true

  • id (Integer) (defaults to: fqdn_rand(255, $facts['networking']['ip']))

    Must be unique among servers

  • cluster (String) (defaults to: 'main')
  • manage_config (Boolean) (defaults to: true)
  • manage_repo (Boolean) (defaults to: true)

    Whether APT/RPM repository should be managed by Puppet

  • manage_package (Boolean) (defaults to: true)
  • manage_user (Boolean) (defaults to: true)
  • manage_service (Boolean) (defaults to: true)
  • export_raft (Boolean) (defaults to: true)
  • raft_config (Clickhouse_Keeper::Raft_config) (defaults to: {})
  • raft_port (Integer) (defaults to: 9234)
  • generate_certs (Boolean) (defaults to: false)
  • packages (Array[String[1]]) (defaults to: ['clickhouse-keeper'])

    OS packages to be installed

  • package_ensure (String) (defaults to: 'present')
  • package_install_options (Array[String]) (defaults to: [])
  • owner (String) (defaults to: 'clickhouse')

    System user account to own config files

  • group (String) (defaults to: 'clickhouse')

    System group to own config files

  • config_dir (Stdlib::AbsolutePath) (defaults to: '/etc/clickhouse-keeper')

    Path to config directory

  • config_file (String) (defaults to: 'keeper_config.xml')
  • log_level (Clickhouse_Keeper::LogLevel) (defaults to: 'information')
  • raft_log_level (Clickhouse_Keeper::LogLevel) (defaults to: 'information')
  • log_file (Stdlib::AbsolutePath) (defaults to: '/var/log/clickhouse-keeper/clickhouse-keeper.log')
  • error_file (Stdlib::AbsolutePath) (defaults to: '/var/log/clickhouse-keeper/clickhouse-keeper.err.log')
  • log_size (String) (defaults to: '1000M')
  • log_count (Integer) (defaults to: 10)
  • listen_host (String) (defaults to: '127.0.0.1')

    Bind address for client connections

  • enable_ipv6 (Boolean) (defaults to: true)
  • max_connections (Integer) (defaults to: 4096)
  • service_name (String) (defaults to: 'clickhouse-keeper')
  • service_enable (Boolean) (defaults to: true)
  • service_ensure (String) (defaults to: 'running')
  • tcp_port (Integer) (defaults to: 9181)

    Port for client connections

  • tcp_port_secure (Optional[Integer]) (defaults to: undef)
  • certificate (Stdlib::AbsolutePath) (defaults to: '/etc/clickhouse-keeper/server.crt')
  • private_key (Stdlib::AbsolutePath) (defaults to: '/etc/clickhouse-keeper/server.key')
  • dhparams (Stdlib::AbsolutePath) (defaults to: '/etc/clickhouse-keeper/dhparam.pem')
  • prometheus_port (Optional[Integer]) (defaults to: undef)

    If defined metrics will be exposed at given port and /metrics endpoint

  • log_storage_path (Stdlib::AbsolutePath) (defaults to: '/var/lib/clickhouse/coordination/logs')

    Keeper coordination logs (raft)

  • snapshot_storage_path (Stdlib::AbsolutePath) (defaults to: '/var/lib/clickhouse/coordination/snapshots')

    Snapshots path

  • keeper_dir (Stdlib::AbsolutePath) (defaults to: '/var/lib/clickhouse-keeper')
  • operation_timeout (Integer) (defaults to: 10000)
  • min_session_timeout (Integer) (defaults to: 10000)
  • session_timeout (Integer) (defaults to: 100000)


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
# File 'manifests/init.pp', line 60

class clickhouse_keeper (
  Integer $id = fqdn_rand(255, $facts['networking']['ip']),
  String  $listen_host = '127.0.0.1',
  Integer $tcp_port = 9181,
  String  $cluster = 'main',
  String  $address = $facts['networking']['ip'],
  Integer $max_connections = 4096,
  Boolean $enable_ipv6 = true,
  Boolean $manage_config = true,
  Boolean $manage_repo = true,
  Boolean $manage_user = true,
  Boolean $manage_package = true,
  Boolean $manage_service = true,
  Boolean $export_raft = true,
  Boolean $generate_certs = false,
  Clickhouse_Keeper::Raft_config $raft_config = {},
  Array[String[1]] $packages = ['clickhouse-keeper'],
  String $package_ensure = 'present',
  Array[String] $package_install_options = [],
  String $owner = 'clickhouse',
  String $group = 'clickhouse',
  Stdlib::AbsolutePath $config_dir = '/etc/clickhouse-keeper',
  String $config_file = 'keeper_config.xml',
  Clickhouse_Keeper::LogLevel $log_level = 'information',
  Clickhouse_Keeper::LogLevel $raft_log_level = 'information',
  Stdlib::AbsolutePath $log_file = '/var/log/clickhouse-keeper/clickhouse-keeper.log',
  Stdlib::AbsolutePath $error_file = '/var/log/clickhouse-keeper/clickhouse-keeper.err.log',
  String $log_size = '1000M',
  Integer $log_count = 10,
  String $service_name = 'clickhouse-keeper',
  String $service_ensure = 'running',
  Boolean $service_enable = true,
  Integer $raft_port = 9234,
  Optional[Integer] $tcp_port_secure = undef,
  Optional[Integer] $prometheus_port = undef,
  Stdlib::AbsolutePath $certificate = '/etc/clickhouse-keeper/server.crt',
  Stdlib::AbsolutePath $private_key = '/etc/clickhouse-keeper/server.key',
  Stdlib::AbsolutePath $dhparams = '/etc/clickhouse-keeper/dhparam.pem',
  Stdlib::AbsolutePath $log_storage_path = '/var/lib/clickhouse/coordination/logs',
  Stdlib::AbsolutePath $snapshot_storage_path = '/var/lib/clickhouse/coordination/snapshots',
  Stdlib::AbsolutePath $keeper_dir = '/var/lib/clickhouse-keeper',
  Integer $operation_timeout = 10000,
  Integer $min_session_timeout = 10000,
  Integer $session_timeout = 100000,
) {
  contain clickhouse_keeper::repo

  if $manage_user {
    ensure_resource('group', $group)

    ensure_resource('user', $owner,
      {
        'shell' => '/bin/false',
        'home'  => '/dev/null',
        'gid' => $group,
      }
    )
  }

  file { $keeper_dir:
    ensure => directory,
    mode   => '0644',
    owner  => $owner,
    group  => $group,
  }

  if $manage_config {
    $config_path = "${config_dir}/${config_file}"

    file { $config_dir:
      ensure  => directory,
      mode    => '0644',
      owner   => $owner,
      group   => $group,
      require => Class['Clickhouse_keeper::Repo'],
    }

    if $manage_package {
      File <| title == $config_dir |> {
        require => Package[$packages],
      }
    }

    if $manage_user {
      File <| title == $config_dir |> {
        require => User[$owner],
      }
    }

    class { 'clickhouse_keeper::config':
      config_path => $config_path,
      cluster     => $cluster,
      require     => File[$config_dir]
    }

    if $export_raft {
      clickhouse_keeper::raft { "clickhouse_keeper-${address}":
        id          => $id,
        address     => $address,
        port        => $raft_port,
        target      => $config_path,
        cluster     => $cluster,
        export_raft => true,
      }
    }

    if !empty($raft_config) {
      $raft_config.each |$server, $props| {
        clickhouse_keeper::raft { "clickhouse_keeper-${server}":
          id          => $props['id'],
          address     => $props['address'],
          port        => $props['port'],
          target      => $config_path,
          cluster     => $props['cluster'],
          export_raft => false,
        }
      }
    }
  }

  if $manage_package {
    stdlib::ensure_packages($packages, {
        ensure          => $package_ensure,
        install_options => $package_install_options,
        require         => Class['Clickhouse_keeper::Repo'],
    })
  }

  if $generate_certs {
    # This is going to take a long time
    exec { 'generate_dhparams':
      command => "openssl dhparam -out ${dhparams} 4096",
      path    => ['/bin', '/usr/bin'],
      onlyif  => 'which openssl',
      creates => $dhparams,
      timeout => 0, # disable timeout
    }
  }

  if $manage_service {
    service { $service_name:
      ensure  => $service_ensure,
      enable  => $service_enable,
      require => Class['Clickhouse_keeper::Config'],
    }

    if $manage_package {
      Service <| title == $service_name |> {
        require => Package[$packages],
      }
    }

    if $manage_config {
      Service <| title == $service_name |> {
        subscribe => Concat["${config_dir}/${config_file}"],
      }
    }
  }
}