Puppet Class: tripleo::profile::pacemaker::database::redis_bundle

Defined in:
manifests/profile/pacemaker/database/redis_bundle.pp

Overview

Copyright 2017 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Class: tripleo::profile::pacemaker::database::redis_bundle

Containerized Redis Pacemaker HA profile for tripleo

Parameters

redis_docker_image

(Optional) The docker image to use for creating the pacemaker bundle Defaults to undef

redis_docker_control_port

(Optional) The bundle’s pacemaker_remote control port on the host Defaults to 3124

pcs_tries

(Optional) The number of times pcs commands should be retried. Defaults to lookup(‘pcs_tries’, undef, undef, 20)

bootstrap_node

(Optional) The hostname of the node responsible for bootstrapping tasks Defaults to lookup(‘redis_short_bootstrap_node_name’)

step

(Optional) The current step in deployment. See tripleo-heat-templates for more details. Defaults to Integer(lookup(‘step’))

certificate_specs

(Optional) The specifications to give to certmonger for the certificate(s) it will create. Example with hiera:

redis_certificate_specs:
  hostname: <overcloud controller fqdn>
  service_certificate: <service certificate path>
  service_key: <service key path>
  principal: "haproxy/<overcloud controller fqdn>"

Defaults to lookup(‘redis_certificate_specs’, undef, undef, {}).

enable_internal_tls

(Optional) Whether TLS in the internal network is enabled or not. Defaults to lookup(‘enable_internal_tls’, undef, undef, false)

redis_network

(Optional) The network name where the redis endpoint is listening on. This is set by t-h-t. Defaults to lookup(‘redis_network’, undef, undef, undef)

extra_config_file

(Optional) When TLS proxy is in use, name of a host-specific Redis config file that configures tunnel connection. This is set by t-h-t. Defaults to ‘/etc/redis-tls.conf’

tls_tunnel_local_name

(Optional) When TLS proxy is in use, name of the localhost to forward unencryption Redis traffic to. This is set by t-h-t. Defaults to ‘localhost’

tls_tunnel_base_port

(Optional) When TLS proxy is in use, a base integer value that is used to generate a unique port number for each peer in the Redis cluster. Defaults to ‘6660’

tls_proxy_bind_ip

IP on which the TLS proxy will listen on. Required only if enable_internal_tls is set. Defaults to undef

tls_proxy_fqdn

fqdn on which the tls proxy will listen on. required only used if enable_internal_tls is set. defaults to undef

tls_proxy_port

port on which the tls proxy will listen on. Only used if enable_internal_tls is set. defaults to 6379

container_backend

(optional) Container backend to use when creating the bundle Defaults to ‘podman’

log_driver

(optional) Container log driver to use. Defaults to ‘k8s-file’

log_file

(optional) Container log file to use. Only relevant when log_driver is set to ‘k8s-file’. Defaults to ‘/var/log/containers/stdouts/redis-bundle.log’

tls_priorities

(optional) Sets PCMK_tls_priorities in /etc/sysconfig/pacemaker when set Defaults to lookup(‘tripleo::pacemaker::tls_priorities’, undef, undef, undef)

bundle_user

(optional) Set the –user= switch to be passed to pcmk Defaults to ‘root’

force_ocf

(optional) Use –force when creating the ocf resource via pcs Defaults to false

Parameters:

  • certificate_specs (Any) (defaults to: lookup('redis_certificate_specs', undef, undef, {}))
  • enable_internal_tls (Any) (defaults to: lookup('enable_internal_tls', undef, undef, false))
  • bootstrap_node (Any) (defaults to: lookup('redis_short_bootstrap_node_name'))
  • redis_docker_image (Any) (defaults to: undef)
  • redis_docker_control_port (Any) (defaults to: 3124)
  • container_backend (Any) (defaults to: 'podman')
  • pcs_tries (Any) (defaults to: lookup('pcs_tries', undef, undef, 20))
  • log_driver (Any) (defaults to: 'k8s-file')
  • log_file (Any) (defaults to: '/var/log/containers/stdouts/redis-bundle.log')
  • step (Any) (defaults to: Integer(lookup('step')))
  • redis_network (Any) (defaults to: lookup('redis_network', undef, undef, undef))
  • extra_config_file (Any) (defaults to: '/etc/redis-tls.conf')
  • tls_tunnel_local_name (Any) (defaults to: 'localhost')
  • tls_tunnel_base_port (Any) (defaults to: 6660)
  • tls_proxy_bind_ip (Any) (defaults to: undef)
  • tls_proxy_fqdn (Any) (defaults to: undef)
  • tls_proxy_port (Any) (defaults to: 6379)
  • tls_priorities (Any) (defaults to: lookup('tripleo::pacemaker::tls_priorities', undef, undef, undef))
  • bundle_user (Any) (defaults to: 'root')
  • force_ocf (Any) (defaults to: false)


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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
# File 'manifests/profile/pacemaker/database/redis_bundle.pp', line 118

class tripleo::profile::pacemaker::database::redis_bundle (
  $certificate_specs         = lookup('redis_certificate_specs', undef, undef, {}),
  $enable_internal_tls       = lookup('enable_internal_tls', undef, undef, false),
  $bootstrap_node            = lookup('redis_short_bootstrap_node_name'),
  $redis_docker_image        = undef,
  $redis_docker_control_port = 3124,
  $container_backend         = 'podman',
  $pcs_tries                 = lookup('pcs_tries', undef, undef, 20),
  $log_driver                = 'k8s-file',
  $log_file                  = '/var/log/containers/stdouts/redis-bundle.log',
  $step                      = Integer(lookup('step')),
  $redis_network             = lookup('redis_network', undef, undef, undef),
  $extra_config_file         = '/etc/redis-tls.conf',
  $tls_tunnel_local_name     = 'localhost',
  $tls_tunnel_base_port      = 6660,
  $tls_proxy_bind_ip         = undef,
  $tls_proxy_fqdn            = undef,
  $tls_proxy_port            = 6379,
  $tls_priorities            = lookup('tripleo::pacemaker::tls_priorities', undef, undef, undef),
  $bundle_user               = 'root',
  $force_ocf                 = false,
) {
  if $bootstrap_node and $::hostname == downcase($bootstrap_node) {
    $pacemaker_master = true
  } else {
    $pacemaker_master = false
  }

  if $log_driver == 'k8s-file' {
    $log_file_real = " --log-opt path=${log_file}"
  } else {
    $log_file_real = ''
  }

  class { 'tripleo::profile::base::database::redis':
    pacemaker_managed     => true,
    tls_tunnel_local_name => $tls_tunnel_local_name,
    tls_proxy_bind_ip     => $tls_proxy_bind_ip,
    tls_proxy_fqdn        => $tls_proxy_fqdn,
    tls_proxy_port        => $tls_proxy_port,
  }

  if $step >= 1 {
    if $enable_internal_tls {
      # certificate_specs is validated by the base redis class
      $tls_certfile = $certificate_specs['service_certificate']
      $tls_keyfile = $certificate_specs['service_key']

      $redis_node_names = lookup('redis_short_node_names', undef, undef, [$::hostname])
      $redis_node_ips   = lookup('redis_node_ips', undef, undef, [$tls_proxy_bind_ip])

      # keep a mapping of [node name, node ip, replication port]
      $replication_tuples = zip($redis_node_names, $redis_node_ips).map |$index, $pair| {
        $pair.concat($tls_tunnel_base_port+$index)
      }

      # encrypted endpoints for outgoing redis replication traffic
      $redis_peers = $replication_tuples.filter |$tuple| {$tuple[1] != $tls_proxy_bind_ip}
      $redis_peers.each |$tuple| {
        tripleo::stunnel::service_proxy { "redis_peer_${tuple[2]}":
          client       => 'yes',
          accept_host  => $tls_tunnel_local_name,
          accept_port  => $tuple[2],
          connect_host => $tuple[1],
          connect_port => $tls_proxy_port,
          certificate  => $tls_certfile,
          key          => $tls_keyfile,
          notify       => Class['redis'],
        }
      }

      # redis slave advertise itself as running on a specific
      # <localhost:port> that uniquely identifies it. This value is
      # used by the master as is, and points the outgoing stunnel
      # endpoint to target this slave.

      $local_tuple = $replication_tuples.filter |$tuple| {
        $tuple[1] == $tls_proxy_bind_ip
      }
      if length($local_tuple)!=1 {
        fail("could not determine local TLS replication port (local ip: '${tls_proxy_bind_ip}', assigned ports: '${replication_tuples}')")
      }

      # NOTE: config parameters slave-announce-* are not exposed by
      # puppet-redis, so for now we configure them via an additional
      # host-specific config file
      File {"${extra_config_file}":
        ensure  => present,
        # owner  => $::redis::config_owner,
        # group  => $::redis::config_group,
        # mode   => $::redis::config_file_mode,
        content => "# Host-specific configuration for TLS
slave-announce-ip ${tls_tunnel_local_name}
slave-announce-port ${local_tuple[0][2]}
",
      }
    } else {
      $replication_tuples = []
    }
  }

  if $step >= 2 {
    if $pacemaker_master {
      if (lookup('redis_short_node_names_override', undef, undef, undef)) {
        $redis_short_node_names = lookup('redis_short_node_names_override')
      } else {
        $redis_short_node_names = lookup('redis_short_node_names')
      }

      $redis_nodes_count = count($redis_short_node_names)
      $redis_short_node_names.each |String $node_name| {
        pacemaker::property { "redis-role-${node_name}":
          property => 'redis-role',
          value    => true,
          tries    => $pcs_tries,
          node     => downcase($node_name),
          before   => Pacemaker::Resource::Bundle['redis-bundle'],
        }
      }

      $storage_maps = {
        'redis-cfg-files'               => {
          'source-dir' => '/var/lib/kolla/config_files/redis.json',
          'target-dir' => '/var/lib/kolla/config_files/config.json',
          'options'    => 'ro',
        },
        'redis-cfg-data-redis'          => {
          'source-dir' => '/var/lib/config-data/puppet-generated/redis/',
          'target-dir' => '/var/lib/kolla/config_files/src',
          'options'    => 'ro',
        },
        'redis-hosts'                   => {
          'source-dir' => '/etc/hosts',
          'target-dir' => '/etc/hosts',
          'options'    => 'ro',
        },
        'redis-localtime'               => {
          'source-dir' => '/etc/localtime',
          'target-dir' => '/etc/localtime',
          'options'    => 'ro',
        },
        'redis-lib'                     => {
          'source-dir' => '/var/lib/redis',
          'target-dir' => '/var/lib/redis',
          'options'    => 'rw,z',
        },
        'redis-log'                     => {
          'source-dir' => '/var/log/containers/redis',
          'target-dir' => '/var/log/redis',
          'options'    => 'rw,z',
        },
        'redis-run'                     => {
          'source-dir' => '/var/run/redis',
          'target-dir' => '/var/run/redis',
          'options'    => 'rw,z',
        },
        # TODO check whether those tls mappings are necessary
        'redis-pki-extracted'           => {
          'source-dir' => '/etc/pki/ca-trust/extracted',
          'target-dir' => '/etc/pki/ca-trust/extracted',
          'options'    => 'ro',
        },
        'redis-pki-ca-bundle-crt'       => {
          'source-dir' => '/etc/pki/tls/certs/ca-bundle.crt',
          'target-dir' => '/etc/pki/tls/certs/ca-bundle.crt',
          'options'    => 'ro',
        },
        'redis-pki-ca-bundle-trust-crt' => {
          'source-dir' => '/etc/pki/tls/certs/ca-bundle.trust.crt',
          'target-dir' => '/etc/pki/tls/certs/ca-bundle.trust.crt',
          'options'    => 'ro',
        },
        'redis-pki-cert'                => {
          'source-dir' => '/etc/pki/tls/cert.pem',
          'target-dir' => '/etc/pki/tls/cert.pem',
          'options'    => 'ro',
        },
        'redis-dev-log'                 => {
          'source-dir' => '/dev/log',
          'target-dir' => '/dev/log',
          'options'    => 'rw',
        },
      }

      if $enable_internal_tls {
        $redis_storage_maps_tls = {
          'redis-pki-gcomm-key'  => {
            'source-dir' => '/etc/pki/tls/private/redis.key',
            'target-dir' => '/var/lib/kolla/config_files/src-tls/etc/pki/tls/private/redis.key',
            'options'    => 'ro',
          },
          'redis-pki-gcomm-cert' => {
            'source-dir' => '/etc/pki/tls/certs/redis.crt',
            'target-dir' => '/var/lib/kolla/config_files/src-tls/etc/pki/tls/certs/redis.crt',
            'options'    => 'ro',
          },
        }
        $storage_maps_tls = $redis_storage_maps_tls
      } else {
        $storage_maps_tls = {}
      }
      if $tls_priorities != undef {
        $tls_priorities_real = " -e PCMK_tls_priorities=${tls_priorities}"
      } else {
        $tls_priorities_real = ''
      }

      pacemaker::resource::bundle { 'redis-bundle':
        image             => $redis_docker_image,
        replicas          => $redis_nodes_count,
        masters           => 1,
        location_rule     => {
          resource_discovery => 'exclusive',
          score              => 0,
          expression         => ['redis-role eq true'],
        },
        container_options => 'network=host',
        # lint:ignore:140chars
        options           => "--user=${bundle_user} --log-driver=${log_driver}${log_file_real} -e KOLLA_CONFIG_STRATEGY=COPY_ALWAYS${tls_priorities_real}",
        # lint:endignore
        run_command       => '/bin/bash /usr/local/bin/kolla_start',
        network           => "control-port=${redis_docker_control_port}",
        storage_maps      => merge($storage_maps, $storage_maps_tls),
        container_backend => $container_backend,
        tries             => $pcs_tries,
      }

      if length($replication_tuples)>1 {
        $tunnel_map = $replication_tuples.map |$tuple| {"${tuple[0]}:${tuple[2]}"}
        $tunnel_opt = " tunnel_port_map='${tunnel_map.join(';')}' tunnel_host='${tls_tunnel_local_name}'"
      } else {
        $tunnel_opt=''
      }
      pacemaker::resource::ocf { 'redis':
        ocf_agent_name  => 'heartbeat:redis',
        resource_params => "wait_last_known_master=true${tunnel_opt}",
        master_params   => '',
        meta_params     => 'notify=true ordered=true interleave=true container-attribute-target=host',
        op_params       => 'start timeout=200s stop timeout=200s',
        tries           => $pcs_tries,
        location_rule   => {
          resource_discovery => 'exclusive',
          score              => 0,
          expression         => ['redis-role eq true'],
        },
        bundle          => 'redis-bundle',
        require         => [Pacemaker::Resource::Bundle['redis-bundle']],
        force           => $force_ocf,
      }

    }
  }
}