92180ae9a1
In order to be able to take an action after all the packages of the module have been installed/updated or all the services have been started/restarted, we set a 'glance-package' and 'glance-service' tag for each package and service of this module. At the moment, there is a generic openstack tag that is not specific enough if one wants to take action upon a single module change. Use case : If an action needs to be taken after all the packages have been installed or updated : Package <| tag == 'glance-package' |> -> X Change-Id: If43e27e80500deebf6b758b11541d3d6f50cb129
515 lines
15 KiB
Puppet
515 lines
15 KiB
Puppet
# == Class glance::api
|
|
#
|
|
# Configure API service in glance
|
|
#
|
|
# == Parameters
|
|
#
|
|
# [*keystone_password*]
|
|
# (required) Password used to authentication.
|
|
#
|
|
# [*package_ensure*]
|
|
# (optional) Ensure state for package. On RedHat platforms this
|
|
# setting is ignored and the setting from the glance class is used
|
|
# because there is only one glance package. Defaults to 'present'.
|
|
#
|
|
# [*verbose*]
|
|
# (optional) Rather to log the glance api service at verbose level.
|
|
# Default: false
|
|
#
|
|
# [*debug*]
|
|
# (optional) Rather to log the glance api service at debug level.
|
|
# Default: false
|
|
#
|
|
# [*bind_host*]
|
|
# (optional) The address of the host to bind to.
|
|
# Default: 0.0.0.0
|
|
#
|
|
# [*bind_port*]
|
|
# (optional) The port the server should bind to.
|
|
# Default: 9292
|
|
#
|
|
# [*backlog*]
|
|
# (optional) Backlog requests when creating socket
|
|
# Default: 4096
|
|
#
|
|
# [*workers*]
|
|
# (optional) Number of Glance API worker processes to start
|
|
# Default: $::processorcount
|
|
#
|
|
# [*log_file*]
|
|
# (optional) The path of file used for logging
|
|
# If set to boolean false, it will not log to any file.
|
|
# Default: /var/log/glance/api.log
|
|
#
|
|
# [*log_dir*]
|
|
# (optional) directory to which glance logs are sent.
|
|
# If set to boolean false, it will not log to any directory.
|
|
# Defaults to '/var/log/glance'
|
|
#
|
|
# [*registry_host*]
|
|
# (optional) The address used to connect to the registry service.
|
|
# Default: 0.0.0.0
|
|
#
|
|
# [*registry_port*]
|
|
# (optional) The port of the Glance registry service.
|
|
# Default: 9191
|
|
#
|
|
# [*registry_client_protocol*]
|
|
# (optional) The protocol of the Glance registry service.
|
|
# Default: http
|
|
#
|
|
# [*auth_type*]
|
|
# (optional) Type is authorization being used.
|
|
# Defaults to 'keystone'
|
|
#
|
|
# [*auth_host*]
|
|
# (optional) DEPRECATED Host running auth service.
|
|
# Defaults to '127.0.0.1'.
|
|
#
|
|
# [*auth_url*]
|
|
# (optional) DEPRECATED Authentication URL.
|
|
# Defaults to 'http://localhost:5000/v2.0'.
|
|
#
|
|
# [*auth_port*]
|
|
# (optional) DEPRECATED Port to use for auth service on auth_host.
|
|
# Defaults to '35357'.
|
|
#
|
|
# [*auth_uri*]
|
|
# (optional) Complete public Identity API endpoint.
|
|
# Defaults to false.
|
|
#
|
|
# [*auth_admin_prefix*]
|
|
# (optional) DEPRECATED Path part of the auth url.
|
|
# This allow admin auth URIs like http://auth_host:35357/keystone/admin.
|
|
# (where '/keystone/admin' is auth_admin_prefix)
|
|
# Defaults to false for empty. If defined, should be a string with a leading '/' and no trailing '/'.
|
|
#
|
|
# [*auth_protocol*]
|
|
# (optional) DEPRECATED Protocol to use for auth.
|
|
# Defaults to 'http'.
|
|
#
|
|
# [*identity_uri*]
|
|
# (optional) Complete admin Identity API endpoint.
|
|
# Defaults to: false
|
|
#
|
|
# [*pipeline*]
|
|
# (optional) Partial name of a pipeline in your paste configuration file with the
|
|
# service name removed.
|
|
# Defaults to 'keystone'.
|
|
#
|
|
# [*keystone_tenant*]
|
|
# (optional) Tenant to authenticate to.
|
|
# Defaults to services.
|
|
#
|
|
# [*keystone_user*]
|
|
# (optional) User to authenticate as with keystone.
|
|
# Defaults to 'glance'.
|
|
#
|
|
# [*manage_service*]
|
|
# (optional) If Puppet should manage service startup / shutdown.
|
|
# Defaults to true.
|
|
#
|
|
# [*enabled*]
|
|
# (optional) Whether to enable services.
|
|
# Defaults to true.
|
|
#
|
|
# [*database_connection*]
|
|
# (optional) Connection url to connect to nova database.
|
|
# Defaults to 'sqlite:///var/lib/glance/glance.sqlite'
|
|
#
|
|
# [*database_idle_timeout*]
|
|
# (optional) Timeout before idle db connections are reaped.
|
|
# Defaults to 3600
|
|
#
|
|
# [*use_syslog*]
|
|
# (optional) Use syslog for logging.
|
|
# Defaults to false.
|
|
#
|
|
# [*log_facility*]
|
|
# (optional) Syslog facility to receive log lines.
|
|
# Defaults to 'LOG_USER'.
|
|
#
|
|
# [*show_image_direct_url*]
|
|
# (optional) Expose image location to trusted clients.
|
|
# Defaults to false.
|
|
#
|
|
# [*purge_config*]
|
|
# (optional) Whether to set only the specified config options
|
|
# in the api config.
|
|
# Defaults to false.
|
|
#
|
|
# [*cert_file*]
|
|
# (optinal) Certificate file to use when starting API server securely
|
|
# Defaults to false, not set
|
|
#
|
|
# [*key_file*]
|
|
# (optional) Private key file to use when starting API server securely
|
|
# Defaults to false, not set
|
|
#
|
|
# [*ca_file*]
|
|
# (optional) CA certificate file to use to verify connecting clients
|
|
# Defaults to false, not set
|
|
#
|
|
# [*mysql_module*]
|
|
# (optional) Deprecated. Does nothing.
|
|
#
|
|
# [*known_stores*]
|
|
# (optional)List of which store classes and store class locations are
|
|
# currently known to glance at startup.
|
|
# Defaults to false.
|
|
# Example: ['glance.store.filesystem.Store','glance.store.http.Store']
|
|
#
|
|
# [*image_cache_dir*]
|
|
# (optional) Base directory that the Image Cache uses.
|
|
# Defaults to '/var/lib/glance/image-cache'.
|
|
#
|
|
# [*os_region_name*]
|
|
# (optional) Sets the keystone region to use.
|
|
# Defaults to 'RegionOne'.
|
|
#
|
|
# [*validate*]
|
|
# (optional) Whether to validate the service is working after any service refreshes
|
|
# Defaults to false
|
|
#
|
|
# [*validation_options*]
|
|
# (optional) Service validation options
|
|
# Should be a hash of options defined in openstacklib::service_validation
|
|
# If empty, defaults values are taken from openstacklib function.
|
|
# Default command list images.
|
|
# Require validate set at True.
|
|
# Example:
|
|
# glance::api::validation_options:
|
|
# glance-api:
|
|
# command: check_glance-api.py
|
|
# path: /usr/bin:/bin:/usr/sbin:/sbin
|
|
# provider: shell
|
|
# tries: 5
|
|
# try_sleep: 10
|
|
# Defaults to {}
|
|
#
|
|
class glance::api(
|
|
$keystone_password,
|
|
$package_ensure = 'present',
|
|
$verbose = false,
|
|
$debug = false,
|
|
$bind_host = '0.0.0.0',
|
|
$bind_port = '9292',
|
|
$backlog = '4096',
|
|
$workers = $::processorcount,
|
|
$log_file = '/var/log/glance/api.log',
|
|
$log_dir = '/var/log/glance',
|
|
$registry_host = '0.0.0.0',
|
|
$registry_port = '9191',
|
|
$registry_client_protocol = 'http',
|
|
$auth_type = 'keystone',
|
|
$auth_uri = false,
|
|
$identity_uri = false,
|
|
$pipeline = 'keystone',
|
|
$keystone_tenant = 'services',
|
|
$keystone_user = 'glance',
|
|
$manage_service = true,
|
|
$enabled = true,
|
|
$use_syslog = false,
|
|
$log_facility = 'LOG_USER',
|
|
$show_image_direct_url = false,
|
|
$purge_config = false,
|
|
$cert_file = false,
|
|
$key_file = false,
|
|
$ca_file = false,
|
|
$known_stores = false,
|
|
$database_connection = 'sqlite:///var/lib/glance/glance.sqlite',
|
|
$database_idle_timeout = 3600,
|
|
$image_cache_dir = '/var/lib/glance/image-cache',
|
|
$os_region_name = 'RegionOne',
|
|
$validate = false,
|
|
$validation_options = {},
|
|
# DEPRECATED PARAMETERS
|
|
$mysql_module = undef,
|
|
$auth_host = '127.0.0.1',
|
|
$auth_url = 'http://localhost:5000/v2.0',
|
|
$auth_port = '35357',
|
|
$auth_admin_prefix = false,
|
|
$auth_protocol = 'http',
|
|
) inherits glance {
|
|
|
|
include ::glance::policy
|
|
require keystone::python
|
|
|
|
if $mysql_module {
|
|
warning('The mysql_module parameter is deprecated. The latest 2.x mysql module will be used.')
|
|
}
|
|
|
|
if ( $glance::params::api_package_name != $glance::params::registry_package_name ) {
|
|
ensure_packages([$glance::params::api_package_name],
|
|
{
|
|
ensure => $package_ensure,
|
|
tag => ['openstack', 'glance-package'],
|
|
}
|
|
)
|
|
}
|
|
|
|
Package[$glance::params::api_package_name] -> File['/etc/glance/']
|
|
Package[$glance::params::api_package_name] -> Class['glance::policy']
|
|
Package[$glance::params::api_package_name] -> Glance_api_config<||>
|
|
Package[$glance::params::api_package_name] -> Glance_cache_config<||>
|
|
|
|
# adding all of this stuff b/c it devstack says glance-api uses the
|
|
# db now
|
|
Glance_api_config<||> ~> Exec<| title == 'glance-manage db_sync' |>
|
|
Glance_cache_config<||> ~> Exec<| title == 'glance-manage db_sync' |>
|
|
Exec<| title == 'glance-manage db_sync' |> ~> Service['glance-api']
|
|
Glance_api_config<||> ~> Service['glance-api']
|
|
Glance_cache_config<||> ~> Service['glance-api']
|
|
Class['glance::policy'] ~> Service['glance-api']
|
|
Service['glance-api'] ~> Glance_image<||>
|
|
|
|
File {
|
|
ensure => present,
|
|
owner => 'glance',
|
|
group => 'glance',
|
|
mode => '0640',
|
|
notify => Service['glance-api'],
|
|
require => Class['glance']
|
|
}
|
|
|
|
if $database_connection {
|
|
if($database_connection =~ /mysql:\/\/\S+:\S+@\S+\/\S+/) {
|
|
require 'mysql::bindings'
|
|
require 'mysql::bindings::python'
|
|
} elsif($database_connection =~ /postgresql:\/\/\S+:\S+@\S+\/\S+/) {
|
|
|
|
} elsif($database_connection =~ /sqlite:\/\//) {
|
|
|
|
} else {
|
|
fail("Invalid db connection ${database_connection}")
|
|
}
|
|
glance_api_config {
|
|
'database/connection': value => $database_connection, secret => true;
|
|
'database/idle_timeout': value => $database_idle_timeout;
|
|
}
|
|
}
|
|
|
|
# basic service config
|
|
glance_api_config {
|
|
'DEFAULT/verbose': value => $verbose;
|
|
'DEFAULT/debug': value => $debug;
|
|
'DEFAULT/bind_host': value => $bind_host;
|
|
'DEFAULT/bind_port': value => $bind_port;
|
|
'DEFAULT/backlog': value => $backlog;
|
|
'DEFAULT/workers': value => $workers;
|
|
'DEFAULT/show_image_direct_url': value => $show_image_direct_url;
|
|
'DEFAULT/image_cache_dir': value => $image_cache_dir;
|
|
'glance_store/os_region_name': value => $os_region_name;
|
|
}
|
|
|
|
# known_stores config
|
|
if $known_stores {
|
|
glance_api_config {
|
|
'glance_store/stores': value => join($known_stores, ',');
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'glance_store/stores': ensure => absent;
|
|
}
|
|
}
|
|
|
|
glance_cache_config {
|
|
'DEFAULT/verbose': value => $verbose;
|
|
'DEFAULT/debug': value => $debug;
|
|
'glance_store/os_region_name': value => $os_region_name;
|
|
}
|
|
|
|
# configure api service to connect registry service
|
|
glance_api_config {
|
|
'DEFAULT/registry_host': value => $registry_host;
|
|
'DEFAULT/registry_port': value => $registry_port;
|
|
'DEFAULT/registry_client_protocol': value => $registry_client_protocol;
|
|
}
|
|
|
|
glance_cache_config {
|
|
'DEFAULT/registry_host': value => $registry_host;
|
|
'DEFAULT/registry_port': value => $registry_port;
|
|
}
|
|
|
|
if $identity_uri {
|
|
glance_api_config { 'keystone_authtoken/identity_uri': value => $identity_uri; }
|
|
} else {
|
|
glance_api_config { 'keystone_authtoken/identity_uri': ensure => absent; }
|
|
}
|
|
|
|
if $auth_uri {
|
|
glance_api_config { 'keystone_authtoken/auth_uri': value => $auth_uri; }
|
|
} else {
|
|
glance_api_config { 'keystone_authtoken/auth_uri': value => "${auth_protocol}://${auth_host}:5000/"; }
|
|
}
|
|
|
|
# if both auth_uri and identity_uri are set we skip these deprecated settings entirely
|
|
if !$auth_uri or !$identity_uri {
|
|
|
|
if $auth_host {
|
|
warning('The auth_host parameter is deprecated. Please use auth_uri and identity_uri instead.')
|
|
glance_api_config { 'keystone_authtoken/auth_host': value => $auth_host; }
|
|
} else {
|
|
glance_api_config { 'keystone_authtoken/auth_host': ensure => absent; }
|
|
}
|
|
|
|
if $auth_port {
|
|
warning('The auth_port parameter is deprecated. Please use auth_uri and identity_uri instead.')
|
|
glance_api_config { 'keystone_authtoken/auth_port': value => $auth_port; }
|
|
} else {
|
|
glance_api_config { 'keystone_authtoken/auth_port': ensure => absent; }
|
|
}
|
|
|
|
if $auth_protocol {
|
|
warning('The auth_protocol parameter is deprecated. Please use auth_uri and identity_uri instead.')
|
|
glance_api_config { 'keystone_authtoken/auth_protocol': value => $auth_protocol; }
|
|
} else {
|
|
glance_api_config { 'keystone_authtoken/auth_protocol': ensure => absent; }
|
|
}
|
|
|
|
if $auth_admin_prefix {
|
|
warning('The auth_admin_prefix parameter is deprecated. Please use auth_uri and identity_uri instead.')
|
|
validate_re($auth_admin_prefix, '^(/.+[^/])?$')
|
|
glance_api_config {
|
|
'keystone_authtoken/auth_admin_prefix': value => $auth_admin_prefix;
|
|
}
|
|
} else {
|
|
glance_api_config { 'keystone_authtoken/auth_admin_prefix': ensure => absent; }
|
|
}
|
|
|
|
} else {
|
|
glance_api_config {
|
|
'keystone_authtoken/auth_host': ensure => absent;
|
|
'keystone_authtoken/auth_port': ensure => absent;
|
|
'keystone_authtoken/auth_protocol': ensure => absent;
|
|
'keystone_authtoken/auth_admin_prefix': ensure => absent;
|
|
}
|
|
}
|
|
|
|
# Set the pipeline, it is allowed to be blank
|
|
if $pipeline != '' {
|
|
validate_re($pipeline, '^(\w+([+]\w+)*)*$')
|
|
glance_api_config {
|
|
'paste_deploy/flavor':
|
|
ensure => present,
|
|
value => $pipeline,
|
|
}
|
|
} else {
|
|
glance_api_config { 'paste_deploy/flavor': ensure => absent }
|
|
}
|
|
|
|
# keystone config
|
|
if $auth_type == 'keystone' {
|
|
glance_api_config {
|
|
'keystone_authtoken/admin_tenant_name': value => $keystone_tenant;
|
|
'keystone_authtoken/admin_user' : value => $keystone_user;
|
|
'keystone_authtoken/admin_password' : value => $keystone_password, secret => true;
|
|
}
|
|
glance_cache_config {
|
|
'DEFAULT/auth_url' : value => $auth_url;
|
|
'DEFAULT/admin_tenant_name': value => $keystone_tenant;
|
|
'DEFAULT/admin_user' : value => $keystone_user;
|
|
'DEFAULT/admin_password' : value => $keystone_password, secret => true;
|
|
}
|
|
}
|
|
|
|
# SSL Options
|
|
if $cert_file {
|
|
glance_api_config {
|
|
'DEFAULT/cert_file' : value => $cert_file;
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'DEFAULT/cert_file': ensure => absent;
|
|
}
|
|
}
|
|
if $key_file {
|
|
glance_api_config {
|
|
'DEFAULT/key_file' : value => $key_file;
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'DEFAULT/key_file': ensure => absent;
|
|
}
|
|
}
|
|
if $ca_file {
|
|
glance_api_config {
|
|
'DEFAULT/ca_file' : value => $ca_file;
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'DEFAULT/ca_file': ensure => absent;
|
|
}
|
|
}
|
|
|
|
# Logging
|
|
if $log_file {
|
|
glance_api_config {
|
|
'DEFAULT/log_file': value => $log_file;
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'DEFAULT/log_file': ensure => absent;
|
|
}
|
|
}
|
|
|
|
if $log_dir {
|
|
glance_api_config {
|
|
'DEFAULT/log_dir': value => $log_dir;
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'DEFAULT/log_dir': ensure => absent;
|
|
}
|
|
}
|
|
|
|
# Syslog
|
|
if $use_syslog {
|
|
glance_api_config {
|
|
'DEFAULT/use_syslog' : value => true;
|
|
'DEFAULT/syslog_log_facility' : value => $log_facility;
|
|
}
|
|
} else {
|
|
glance_api_config {
|
|
'DEFAULT/use_syslog': value => false;
|
|
}
|
|
}
|
|
|
|
resources { 'glance_api_config':
|
|
purge => $purge_config,
|
|
}
|
|
|
|
file { ['/etc/glance/glance-api.conf',
|
|
'/etc/glance/glance-api-paste.ini',
|
|
'/etc/glance/glance-cache.conf']:
|
|
}
|
|
|
|
if $manage_service {
|
|
if $enabled {
|
|
$service_ensure = 'running'
|
|
} else {
|
|
$service_ensure = 'stopped'
|
|
}
|
|
}
|
|
|
|
service { 'glance-api':
|
|
ensure => $service_ensure,
|
|
name => $::glance::params::api_service_name,
|
|
enable => $enabled,
|
|
hasstatus => true,
|
|
hasrestart => true,
|
|
tag => 'glance-service',
|
|
}
|
|
|
|
if $validate {
|
|
$defaults = {
|
|
'glance-api' => {
|
|
'command' => "glance --os-auth-url ${auth_url} --os-tenant-name ${keystone_tenant} --os-username ${keystone_user} --os-password ${keystone_password} image-list",
|
|
}
|
|
}
|
|
$validation_options_hash = merge ($defaults, $validation_options)
|
|
create_resources('openstacklib::service_validation', $validation_options_hash, {'subscribe' => 'Service[glance-api]'})
|
|
}
|
|
|
|
}
|