Puppet Class: tripleo::profile::base::keystone

Defined in:
manifests/profile/base/keystone.pp

Overview

Copyright 2016 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::base::keystone

Keystone profile for tripleo

Parameters

admin_endpoint_network

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

bootstrap_node

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

certificates_specs

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

apache_certificates_specs:
  httpd-internal_api:
    hostname: <overcloud controller fqdn>
    service_certificate: <service certificate path>
    service_key: <service key path>
    principal: "haproxy/<overcloud controller fqdn>"

Defaults to lookup(‘apache_certificates_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)

ldap_backends_config

Configuration for keystone::ldap_backend. This takes a hash that will create each backend specified. Defaults to undef

ldap_backend_enable

Enables creating per-domain LDAP backends for keystone. Default to false

manage_db_purge

(Optional) Whether keystone token flushing should be enabled Defaults to lookup(‘keystone_enable_db_purge’, undef, undef, false)

public_endpoint_network

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

oslomsg_rpc_proto

Protocol driver for the oslo messaging rpc service Defaults to lookup(‘oslo_messaging_rpc_scheme’, undef, undef, ‘rabbit’)

oslomsg_rpc_hosts

list of the oslo messaging rpc host fqdns Defaults to any2array(lookup(‘oslo_messaging_rpc_node_names’, undef, undef, undef))

oslomsg_rpc_port

IP port for oslo messaging rpc service Defaults to lookup(‘oslo_messaging_rpc_port’, undef, undef, ‘5672’)

oslomsg_rpc_username

Username for oslo messaging rpc service Defaults to lookup(‘oslo_messaging_rpc_user_name’, undef, undef, ‘guest’)

oslomsg_rpc_password

Password for oslo messaging rpc service Defaults to lookup(‘oslo_messaging_rpc_password’)

oslomsg_rpc_use_ssl

Enable ssl oslo messaging services Defaults to lookup(‘oslo_messaging_rpc_use_ssl’, undef, undef, ‘0’)

oslomsg_notify_proto

Protocol driver for the oslo messaging notify service Defaults to lookup(‘oslo_messaging_notify_scheme’, undef, undef, ‘rabbit’)

oslomsg_notify_hosts

list of the oslo messaging notify host fqdns Defaults to any2array(lookup(‘oslo_messaging_notify_node_names’, undef, undef, undef))

oslomsg_notify_port

IP port for oslo messaging notify service Defaults to lookup(‘oslo_messaging_notify_port’, undef, undef, ‘5672’)

oslomsg_notify_username

Username for oslo messaging notify service Defaults to lookup(‘oslo_messaging_notify_user_name’, undef, undef, ‘guest’)

oslomsg_notify_password

Password for oslo messaging notify service Defaults to lookup(‘oslo_messaging_notify_password’)

oslomsg_notify_use_ssl

Enable ssl oslo messaging services Defaults to lookup(‘oslo_messaging_notify_use_ssl’, undef, undef, ‘0’)

ceilometer_notification_topics

Notification topics that keystone should use for ceilometer to consume. Defaults to []

barbican_notification_topics

Notification topics that keystone should use for barbican to consume. Defaults to []

extra_notification_topics

Extra notification topics that keystone should produce. Defaults to []

step

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

keystone_federation_enabled

(Optional) Enable federated identity support Defaults to lookup(‘keystone_federation_enabled’, undef, undef, false)

keystone_openidc_enabled

(Optional) Enable OpenIDC federation Defaults to lookup(‘keystone_openidc_enabled’, undef, undef, false)

memcached_hosts

(Optional) Array of hostnames, ipv4 or ipv6 addresses for memcache. Defaults to lookup(‘memcached_node_names’, undef, undef, [])

memcached_port

(Optional) Memcached port to use. Defaults to lookup(‘memcached_port’, undef, undef, 11211)

memcached_ipv6

(Optional) Whether Memcached uses IPv6 network instead of IPv4 network. Defaults to lookup(‘memcached_ipv6’, undef, undef, false)

cache_backend

(Optional) oslo.cache backend used for caching. Defaults to lookup(‘keystone::cache::backend’, undef, undef, false)

configure_apache

(Optional) Whether apache is configured via puppet or not. Defaults to lookup(‘configure_apache’, undef, undef, true)

DEPRECATED PARAMETERS

memcached_ips

(Optional) Array of ipv4 or ipv6 addresses for memcache. Defaults to undef

Parameters:

  • admin_endpoint_network (Any) (defaults to: lookup('keystone_admin_api_network', undef, undef, undef))
  • bootstrap_node (Any) (defaults to: lookup('keystone_short_bootstrap_node_name', undef, undef, undef))
  • certificates_specs (Any) (defaults to: lookup('apache_certificates_specs', undef, undef, {}))
  • enable_internal_tls (Any) (defaults to: lookup('enable_internal_tls', undef, undef, false))
  • ldap_backends_config (Any) (defaults to: undef)
  • ldap_backend_enable (Any) (defaults to: false)
  • manage_db_purge (Any) (defaults to: lookup('keystone_enable_db_purge', undef, undef, false))
  • public_endpoint_network (Any) (defaults to: lookup('keystone_public_api_network', undef, undef, undef))
  • oslomsg_rpc_proto (Any) (defaults to: lookup('oslo_messaging_rpc_scheme', undef, undef, 'rabbit'))
  • oslomsg_rpc_hosts (Any) (defaults to: any2array(lookup('oslo_messaging_rpc_node_names', undef, undef, undef)))
  • oslomsg_rpc_password (Any) (defaults to: lookup('oslo_messaging_rpc_password'))
  • oslomsg_rpc_port (Any) (defaults to: lookup('oslo_messaging_rpc_port', undef, undef, '5672'))
  • oslomsg_rpc_username (Any) (defaults to: lookup('oslo_messaging_rpc_user_name', undef, undef, 'guest'))
  • oslomsg_rpc_use_ssl (Any) (defaults to: lookup('oslo_messaging_rpc_use_ssl', undef, undef, '0'))
  • oslomsg_notify_proto (Any) (defaults to: lookup('oslo_messaging_notify_scheme', undef, undef, 'rabbit'))
  • oslomsg_notify_hosts (Any) (defaults to: any2array(lookup('oslo_messaging_notify_node_names', undef, undef, undef)))
  • oslomsg_notify_password (Any) (defaults to: lookup('oslo_messaging_notify_password'))
  • oslomsg_notify_port (Any) (defaults to: lookup('oslo_messaging_notify_port', undef, undef, '5672'))
  • oslomsg_notify_username (Any) (defaults to: lookup('oslo_messaging_notify_user_name', undef, undef, 'guest'))
  • oslomsg_notify_use_ssl (Any) (defaults to: lookup('oslo_messaging_notify_use_ssl', undef, undef, '0'))
  • ceilometer_notification_topics (Any) (defaults to: [])
  • barbican_notification_topics (Any) (defaults to: [])
  • extra_notification_topics (Any) (defaults to: [])
  • step (Any) (defaults to: Integer(lookup('step')))
  • keystone_federation_enabled (Any) (defaults to: lookup('keystone_federation_enabled', undef, undef, false))
  • keystone_openidc_enabled (Any) (defaults to: lookup('keystone_openidc_enabled', undef, undef, false))
  • memcached_hosts (Any) (defaults to: lookup('memcached_node_names', undef, undef, []))
  • memcached_port (Any) (defaults to: lookup('memcached_port', undef, undef, 11211))
  • memcached_ipv6 (Any) (defaults to: lookup('memcached_ipv6', undef, undef, false))
  • cache_backend (Any) (defaults to: lookup('keystone::cache::backend', undef, undef, false))
  • configure_apache (Any) (defaults to: lookup('configure_apache', undef, undef, true))
  • memcached_ips (Any) (defaults to: undef)


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
# File 'manifests/profile/base/keystone.pp', line 163

class tripleo::profile::base::keystone (
  $admin_endpoint_network         = lookup('keystone_admin_api_network', undef, undef, undef),
  $bootstrap_node                 = lookup('keystone_short_bootstrap_node_name', undef, undef, undef),
  $certificates_specs             = lookup('apache_certificates_specs', undef, undef, {}),
  $enable_internal_tls            = lookup('enable_internal_tls', undef, undef, false),
  $ldap_backends_config           = undef,
  $ldap_backend_enable            = false,
  $manage_db_purge                = lookup('keystone_enable_db_purge', undef, undef, false),
  $public_endpoint_network        = lookup('keystone_public_api_network', undef, undef, undef),
  $oslomsg_rpc_proto              = lookup('oslo_messaging_rpc_scheme', undef, undef, 'rabbit'),
  $oslomsg_rpc_hosts              = any2array(lookup('oslo_messaging_rpc_node_names', undef, undef, undef)),
  $oslomsg_rpc_password           = lookup('oslo_messaging_rpc_password'),
  $oslomsg_rpc_port               = lookup('oslo_messaging_rpc_port', undef, undef, '5672'),
  $oslomsg_rpc_username           = lookup('oslo_messaging_rpc_user_name', undef, undef, 'guest'),
  $oslomsg_rpc_use_ssl            = lookup('oslo_messaging_rpc_use_ssl', undef, undef, '0'),
  $oslomsg_notify_proto           = lookup('oslo_messaging_notify_scheme', undef, undef, 'rabbit'),
  $oslomsg_notify_hosts           = any2array(lookup('oslo_messaging_notify_node_names', undef, undef, undef)),
  $oslomsg_notify_password        = lookup('oslo_messaging_notify_password'),
  $oslomsg_notify_port            = lookup('oslo_messaging_notify_port', undef, undef, '5672'),
  $oslomsg_notify_username        = lookup('oslo_messaging_notify_user_name', undef, undef, 'guest'),
  $oslomsg_notify_use_ssl         = lookup('oslo_messaging_notify_use_ssl', undef, undef, '0'),
  $ceilometer_notification_topics = [],
  $barbican_notification_topics   = [],
  $extra_notification_topics      = [],
  $step                           = Integer(lookup('step')),
  $keystone_federation_enabled    = lookup('keystone_federation_enabled', undef, undef, false),
  $keystone_openidc_enabled       = lookup('keystone_openidc_enabled', undef, undef, false),
  $memcached_hosts                = lookup('memcached_node_names', undef, undef, []),
  $memcached_port                 = lookup('memcached_port', undef, undef, 11211),
  $memcached_ipv6                 = lookup('memcached_ipv6', undef, undef, false),
  $cache_backend                  = lookup('keystone::cache::backend', undef, undef, false),
  $configure_apache               = lookup('configure_apache', undef, undef, true),
  # DEPRECATED PARAMETERS
  $memcached_ips                  = undef
) {
  $memcached_hosts_real = any2array(pick($memcached_ips, $memcached_hosts))

  if $bootstrap_node and $::hostname == downcase($bootstrap_node) {
    $sync_db = true
  } else {
    $sync_db = false
  }

  if $enable_internal_tls {
    if !$public_endpoint_network {
      fail('keystone_public_api_network is not set in the hieradata.')
    }
    $tls_certfile = $certificates_specs["httpd-${public_endpoint_network}"]['service_certificate']
    $tls_keyfile = $certificates_specs["httpd-${public_endpoint_network}"]['service_key']

    if !$admin_endpoint_network {
      fail('keystone_admin_api_network is not set in the hieradata.')
    }
  } else {
    $tls_certfile = undef
    $tls_keyfile = undef
  }

  if $step >= 4 or ( $step >= 3 and $sync_db ) {
    $oslomsg_rpc_use_ssl_real = sprintf('%s', bool2num(str2bool($oslomsg_rpc_use_ssl)))
    $oslomsg_notify_use_ssl_real = sprintf('%s', bool2num(str2bool($oslomsg_notify_use_ssl)))

    if $memcached_ipv6 or $memcached_hosts_real[0] =~ Stdlib::Compat::Ipv6 {
      if $cache_backend in ['oslo_cache.memcache_pool', 'dogpile.cache.memcached'] {
        # NOTE(tkajinm): The inet6 prefix is required for backends using
        #                python-memcached
        $cache_memcache_servers = $memcached_hosts_real.map |$server| { "inet6:[${server}]:${memcached_port}" }
      } else {
        # NOTE(tkajinam): The other backends like pymemcache don't require
        #                 the inet6 prefix
        $cache_memcache_servers = suffix(any2array(normalize_ip_for_uri($memcached_hosts_real)), ":${memcached_port}")
      }
    } else {
      $cache_memcache_servers = suffix(any2array(normalize_ip_for_uri($memcached_hosts_real)), ":${memcached_port}")
    }

    class { 'keystone::cache':
      memcache_servers => $cache_memcache_servers
    }

    class { 'keystone':
      sync_db                    => $sync_db,
      default_transport_url      => os_transport_url({
        'transport' => $oslomsg_rpc_proto,
        'hosts'     => $oslomsg_rpc_hosts,
        'port'      => $oslomsg_rpc_port,
        'username'  => $oslomsg_rpc_username,
        'password'  => $oslomsg_rpc_password,
        'ssl'       => $oslomsg_rpc_use_ssl_real,
      }),
      notification_transport_url => os_transport_url({
        'transport' => $oslomsg_notify_proto,
        'hosts'     => $oslomsg_notify_hosts,
        'port'      => $oslomsg_notify_port,
        'username'  => $oslomsg_notify_username,
        'password'  => $oslomsg_notify_password,
        'ssl'       => $oslomsg_notify_use_ssl_real,
      }),
      notification_topics        => union($ceilometer_notification_topics,
                                          $barbican_notification_topics,
                                          $extra_notification_topics),
    }
    include keystone::healthcheck

    if 'amqp' in [$oslomsg_rpc_proto, $oslomsg_notify_proto]{
      include keystone::messaging::amqp
    }

    include keystone::config
    include keystone::db
    include keystone::logging
    if $configure_apache {
      include tripleo::profile::base::apache
      class { 'keystone::wsgi::apache':
        ssl_cert => $tls_certfile,
        ssl_key  => $tls_keyfile,
      }
    }
    include keystone::cors
    include keystone::security_compliance

    if $ldap_backend_enable {
      validate_legacy(Hash, 'validate_hash', $ldap_backends_config)
      if !str2bool($::selinux) {
        selboolean { 'authlogin_nsswitch_use_ldap':
            value      => on,
            persistent => true,
        }
      }
      create_resources('keystone::ldap_backend', $ldap_backends_config, { 'create_domain_entry' => false })
    }

    if $keystone_federation_enabled {
      include keystone::federation
    }

    if $keystone_openidc_enabled {
      $memcached_servers = suffix(any2array(normalize_ip_for_uri($memcached_hosts_real)), ":${memcached_port}")
      class { 'keystone::federation::openidc':
        memcached_servers  => $memcached_servers,
      }
    }
  }

  if $step >= 4 and $manage_db_purge {
    include keystone::cron::trust_flush
  }

}