Puppet Class: tripleo::profile::base::glance::api

Defined in:
manifests/profile/base/glance/api.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::glance::api

Glance API profile for tripleo

Parameters

bootstrap_node

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

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)

glance_backend

(Optional) Default glance backend type. Defaults to downcase(lookup(‘glance_backend’, undef, undef, ‘swift’))

glance_backend_id

(Optional) Default glance backend identifier. Defaults to ‘default_backend’

glance_network

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

bind_port

(optional) The port the server should bind to. Default: 9292

log_dir

(Optional) Directory where logs should be stored. If set to $::os_service_default, it will not log to any directory. Defaults to ‘/var/log/glance’.

log_file

(Optional) File where logs should be stored. If set to $::os_service_default, it will not log to any file. Defaults to ‘/var/log/glance/api.log’.

show_image_direct_url

(optional) Expose image location to trusted clients. Defaults to false

show_multiple_locations

(optional) Whether to include the backend image locations in image

properties.

Defaults to false

multistore_config

(Optional) Hash of settings for configuring additional glance-api backends. Defaults to {}

step

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

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’)

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 9292

glance_enable_db_purge

(optional) Whether to enable db purging defaults to true

glance_enable_cache

(optional) Whether to enable caching defaults to false

configure_apache

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

DEPRECATED PARAMETERS

glance_rbd_client_name

(optional) Deprecated. RBD client name Defaults to undef

Parameters:

  • bootstrap_node (Any) (defaults to: lookup('glance_api_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))
  • glance_backend (Any) (defaults to: downcase(lookup('glance_backend', undef, undef, 'swift')))
  • glance_backend_id (Any) (defaults to: 'default_backend')
  • glance_network (Any) (defaults to: lookup('glance_api_network', undef, undef, undef))
  • bind_port (Any) (defaults to: 9292)
  • log_dir (Any) (defaults to: '/var/log/glance')
  • log_file (Any) (defaults to: '/var/log/glance/api.log')
  • show_image_direct_url (Any) (defaults to: false)
  • show_multiple_locations (Any) (defaults to: false)
  • multistore_config (Any) (defaults to: {})
  • step (Any) (defaults to: Integer(lookup('step')))
  • 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'))
  • tls_proxy_bind_ip (Any) (defaults to: undef)
  • tls_proxy_fqdn (Any) (defaults to: undef)
  • tls_proxy_port (Any) (defaults to: 9292)
  • glance_enable_db_purge (Any) (defaults to: true)
  • glance_enable_cache (Any) (defaults to: false)
  • configure_apache (Any) (defaults to: lookup('configure_apache', undef, undef, true))
  • glance_rbd_client_name (Any) (defaults to: undef)


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
# File 'manifests/profile/base/glance/api.pp', line 167

class tripleo::profile::base::glance::api (
  $bootstrap_node          = lookup('glance_api_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),
  $glance_backend          = downcase(lookup('glance_backend', undef, undef, 'swift')),
  $glance_backend_id       = 'default_backend',
  $glance_network          = lookup('glance_api_network', undef, undef, undef),
  $bind_port               = 9292,
  $log_dir                 = '/var/log/glance',
  $log_file                = '/var/log/glance/api.log',
  $show_image_direct_url   = false,
  $show_multiple_locations = false,
  $multistore_config       = {},
  $step                    = Integer(lookup('step')),
  $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'),
  $tls_proxy_bind_ip       = undef,
  $tls_proxy_fqdn          = undef,
  $tls_proxy_port          = 9292,
  $glance_enable_db_purge  = true,
  $glance_enable_cache     = false,
  $configure_apache        = lookup('configure_apache', undef, undef, true),
  # DEPRECATED PARAMETERS
  $glance_rbd_client_name  = undef,
) {
  if $bootstrap_node and $::hostname == downcase($bootstrap_node) {
    $sync_db = true
  } else {
    $sync_db = false
  }

  include tripleo::profile::base::glance::authtoken

  if $step >= 4 or ($step >= 3 and $sync_db) {
    if $enable_internal_tls {
      if !$glance_network {
        fail('glance_api_network is not set in the hieradata.')
      }
      if !$tls_proxy_bind_ip {
        fail('glance_api_tls_proxy_bind_ip is not set in the hieradata.')
      }
      if !$tls_proxy_fqdn {
        fail('tls_proxy_fqdn is required if internal TLS is enabled.')
      }
      $tls_certfile = $certificates_specs["httpd-${glance_network}"]['service_certificate']
      $tls_keyfile = $certificates_specs["httpd-${glance_network}"]['service_key']

      if $configure_apache {
        tripleo::tls_proxy { 'glance-api':
          servername => $tls_proxy_fqdn,
          ip         => $tls_proxy_bind_ip,
          port       => $tls_proxy_port,
          tls_cert   => $tls_certfile,
          tls_key    => $tls_keyfile,
          notify     => Class['glance::api'],
        }
        include tripleo::profile::base::apache
      }
    }

    $multistore_backends = $multistore_config.map |$backend_config| {
      unless has_key($backend_config[1], 'GlanceBackend') {
        fail("multistore_config '${backend_config[0]}' does not specify a glance_backend.")
      }
      "${backend_config[0]}:${backend_config[1]['GlanceBackend']}"
    }

    $enabled_backends = ["${glance_backend_id}:${glance_backend}"] + $multistore_backends

    include glance
    include glance::config
    include glance::healthcheck
    include glance::api::db
    class { 'glance::api::logging':
      log_dir  => $log_dir,
      log_file => $log_file,
    }
    class { 'glance::api':
      bind_port               => $bind_port,
      enabled_backends        => $enabled_backends,
      default_backend         => $glance_backend_id,
      show_image_direct_url   => $show_image_direct_url,
      show_multiple_locations => $show_multiple_locations,
      sync_db                 => $sync_db,
    }
    include glance::key_manager
    include glance::key_manager::barbican

    ['cinder', 'file', 'rbd', 'swift'].each |String $backend_type| {

      # Generate a list of backend names for a given backend type
      $backend_names = $enabled_backends.reduce([]) |$accum, String $backend| {
        $backend_info = $backend.split(':')
        if $backend_info[1] == $backend_type {
          $accum << $backend_info[0]
        } else {
          $accum
        }
      }

      unless empty($backend_names) {
        class { "tripleo::profile::base::glance::backend::${backend_type}":
          backend_names     => $backend_names,
          multistore_config => $multistore_config,
        }
      }
    }

    $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)))
    class { 'glance::notify::rabbitmq' :
      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,
      }),
    }
  }

  if $step >= 5 {
    if $glance_enable_db_purge {
      include glance::cron::db_purge
    }
    if $glance_enable_cache {
      include glance::cache::cleaner
      include glance::cache::pruner
    }
  }

}