Files
puppet-glance/manifests/api.pp
Takashi Kajinami b9b2448b03 Refactor api service management
Drop validation of service name which is not implemented for
the other daemons, to simplify handling of the provided service name.

This allows us to more easily offload the service name definition to
hiera data in the near future.

Change-Id: I90a78929510ca3917d3ba32576fa123d512388b9
Signed-off-by: Takashi Kajinami <kajinamit@oss.nttdata.com>
2025-09-26 15:33:53 +00:00

611 lines
24 KiB
Puppet

# == Class glance::api
#
# Configure API service in glance
#
# == Parameters
#
# [*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'.
#
# [*bind_host*]
# (optional) The address of the host to bind to.
# Default: $facts['os_service_default'].
#
# [*bind_port*]
# (optional) The port the server should bind to.
# Default: $facts['os_service_default'].
#
# [*backlog*]
# (optional) Backlog requests when creating socket
# Default: $facts['os_service_default'].
#
# [*workers*]
# (optional) Number of Glance API worker processes to start
# Default: $facts['os_workers'].
#
# [*auth_strategy*]
# (optional) Type is authorization being used.
# Defaults to 'keystone'
#
# [*paste_deploy_flavor*]
# (optional) Deployment flavor to use in the server application pipeline.
# Defaults to 'keystone'.
#
# [*paste_deploy_config_file*]
# (optional) Name of the paste configuration file.
# Defaults to $facts['os_service_default'].
#
# [*manage_service*]
# (optional) If Puppet should manage service startup / shutdown.
# Defaults to true.
#
# [*enabled*]
# (optional) Whether to enable services.
# Defaults to true.
#
# [*service_name*]
# (optional) Name of the service that will be providing the
# server functionality of glance-api.
# If the value is 'httpd', this means glance-api will be a web
# service, and you must use another class to configure that
# web service. For example, use class { 'glance::wsgi::apache'...}
# to make glance-api be a web app using apache mod_wsgi.
# Defaults to '$glance::params::api_service_name'
#
# [*container_formats*]
# (optional) List of allowed values for an image container_format attributes
# Defaults to $facts['os_service_default'].
#
# [*disk_formats*]
# (optional) List of allowed values for an image disk_format attribute.
# Defaults to $facts['os_service_default'].
#
# [*require_image_format_match*]
# (optional) Inspect the content of uploads and require that they match
# the disk format set on the image.
# Defaults to $facts['os_service_default'].
#
# [*image_cache_driver*]
# (optional) The driver to use for image cache management.
# Defaults to $facts['os_service_default'].
#
# [*image_cache_dir*]
# (optional) Base directory that the Image Cache uses.
# Defaults to '/var/lib/glance/image-cache'.
#
# [*image_cache_max_size*]
# (optional) The upper limit (the maximum size of accumulated cache in bytes)
# beyond which pruner, if running, starts cleaning the images cache.
# Defaults to $facts['os_service_default'].
#
# [*image_cache_stall_time*]
# (optional) The amount of time to let an image remain in the cache without
# being accessed.
# Defaults to $facts['os_service_default'].
#
# [*image_import_plugins*]
# (optional) (Array) List of enabled Image Import Plugins.
# Defaults to $facts['os_service_default'].
#
# [*image_conversion_output_format*]
# (optional) Desired output format for image conversion plugin.
# Defaults to $facts['os_service_default'].
#
# [*inject_metadata_properties*]
# (optional) Dictionary contains metadata properties to be injected in image.
# Defaults to $facts['os_service_default'].
#
# [*ignore_user_roles*]
# (optional) List containing user roles. For example: [admin,member]
# Defaults to $facts['os_service_default'].
#
# [*show_image_direct_url*]
# (optional) Expose image location to trusted clients.
# Defaults to $facts['os_service_default'].
#
# [*purge_config*]
# (optional) Whether to set only the specified config options
# in the api config.
# Defaults to false.
#
# [*enforce_secure_rbac*]
# (optional) Enabled enforcing authorization based on common RBAC personas.
# Defaults to $facts['os_service_default']
#
# [*use_keystone_limits*]
# (optional) Allow Glance to retrieve limits set in keystone for resource
# consumption and enforce them against API users
# Defaults to $facts['os_service_default']
#
# [*enabled_backends*]
# (optional) List of Key:Value pairs of store identifier and store type.
# Example: ['swift:swift', 'ceph1:ceph', 'ceph2:ceph']
# Defaults to undef
#
# [*default_backend*]
# (optional) The store identifier for the default backend in which data will
# be stored. The value must be defined as one of the keys in the dict
# defined by the enabled_backends.
# Defaults to undef
#
# [*enabled_import_methods*]
# (optional) The list of enabled Image Import Methods.
# Defaults to $facts['os_service_default'].
#
# [*node_staging_uri*]
# (optional) The URL provides location where the temporary data will be
# stored when image import method is set to 'glance-direct'
# Defaults to $facts['os_service_default'].
#
# [*worker_self_reference_url*]
# (optional) The self-reference URL by which other workers will get to know
# how to contact the worker which has staged the image.
# Defaults to $facts['os_service_default'].
#
# [*image_member_quota*]
# (optional) The maximum number of image members allowed per image.
# Defaults to $facts['os_service_default']
#
# [*image_property_quota*]
# (optional) The maximum number of image properties allowed on an image.
# Defaults to $facts['os_service_default']
#
# [*image_tag_quota*]
# (optional) The maximum number of tags allowed on an image.
# Defaults to $facts['os_service_default']
#
# [*image_location_quota*]
# (optional) The maximum number of locations allowed on an image.
# Defaults to $facts['os_service_default']
#
# [*image_size_cap*]
# (optional) The maximum size of image a user can upload in bytes
# Defaults to $facts['os_service_default']
#
# [*user_storage_quota*]
# (optional) The maximum amount of image storage per tenant.
# Defaults to $facts['os_service_default']
#
# [*task_time_to_live*]
# (optional) Time in hours for which a task lives after.
# Defaults to $facts['os_service_default']
#
# [*task_executor*]
# (optional) Task executor to be used to run task scripts.
# Defaults to $facts['os_service_default']
#
# [*task_work_dir*]
# (optional) Absolute path to the work directory to use for asynchronous
# task operations.
# Defaults to $facts['os_service_default']
#
# [*taskflow_engine_mode*]
# (optional) Set the taskflow engine mode.
# Allowed values: 'parallel', 'serial'.
# Defaults to $facts['os_service_default']
#
# [*taskflow_max_workers*]
# (optional) Integer value to limit the number of taskflow workers. Only
# relevant if taskflow_engine_mode is 'parallel'.
# Defaults to $facts['os_service_default']
#
# [*conversion_format*]
# (optional) Allow automatic image conversion.
# Allowed values: 'qcow2', 'raw', 'vmdk', false.
# Defaults to $facts['os_service_default'] (disabled)
#
# [*enable_proxy_headers_parsing*]
# (Optional) Enable paste middleware to handle SSL requests through
# HTTPProxyToWSGI middleware.
# Defaults to $facts['os_service_default'].
#
# [*max_request_body_size*]
# (Optional) Set max request body size
# Defaults to $facts['os_service_default'].
#
# [*sync_db*]
# (Optional) Run db sync on the node.
# Defaults to true
#
# [*limit_param_default*]
# (optional) Default value for the number of items returned by a request if not
# specified explicitly in the request (integer value)
# Default: $facts['os_service_default'].
#
# [*api_limit_max*]
# (optional) Maximum number of results that could be returned by a request
# Default: $facts['os_service_default'].
#
# [*lock_path*]
# (optional) Where to store lock files. This directory must be writeable
# by the user executing the agent
# Defaults to: $glance::params::lock_path
#
# [*public_endpoint*]
# (optional) Public url endpoint to use for Glance versions response.
# Change the endpoint to represent the proxy URL if the API service is
# running behind a proxy. This is especially useful if the public endpoint
# is advertised with a base URL not pointing to the server root in Keystone.
# ie. https://cloud.acme.org/api/image
# Default: $facts['os_service_default'].
#
# [*hashing_algorithm*]
# (optional) Secure hashing altorithm used for computing
# the `os_hash_value` property.
# Default: $facts['os_service_default'].
#
# DEPRECATED PARAMETERS
#
# [*stores*]
# (optional) List of which store classes and store class locations are
# currently known to glance at startup.
# Defaults to undef
# Example: ['file','http']
#
# [*default_store*]
# (optional) The default backend store, should be given as a string. Value
# must be provided if more than one store is listed in 'stores'.
# Defaults to undef
#
# [*multi_store*]
# (optional) Boolean describing if multiple backends will be configured
# Defaults to false
#
# [*show_multiple_locations*]
# (optional) Whether to include the backend image locations in image
# properties.
# Defaults to undef
#
# [*filesystem_store_metadata_file*]
# (optional) The path to a file which contains the metadata to be returned
# with any location associated with the filesystem store
# properties.
# Defaults to undef
#
# [*filesystem_store_file_perm*]
# (optional) File access permissions for the image files.
# Defaults to undef
#
# [*delayed_delete*]
# (optional) Turn on/off delayed delete.
# Defaults to undef
#
class glance::api (
Stdlib::Ensure::Package $package_ensure = 'present',
$bind_host = $facts['os_service_default'],
$bind_port = $facts['os_service_default'],
$backlog = $facts['os_service_default'],
$workers = $facts['os_workers'],
$auth_strategy = 'keystone',
String $paste_deploy_flavor = 'keystone',
$paste_deploy_config_file = $facts['os_service_default'],
Boolean $manage_service = true,
Boolean $enabled = true,
String[1] $service_name = $glance::params::api_service_name,
$show_image_direct_url = $facts['os_service_default'],
Boolean $purge_config = false,
$enforce_secure_rbac = $facts['os_service_default'],
$use_keystone_limits = $facts['os_service_default'],
$enabled_backends = undef,
$default_backend = undef,
$container_formats = $facts['os_service_default'],
$disk_formats = $facts['os_service_default'],
$require_image_format_match = $facts['os_service_default'],
$image_cache_driver = $facts['os_service_default'],
$image_cache_dir = '/var/lib/glance/image-cache',
$image_cache_max_size = $facts['os_service_default'],
$image_cache_stall_time = $facts['os_service_default'],
$image_import_plugins = $facts['os_service_default'],
$inject_metadata_properties = $facts['os_service_default'],
$ignore_user_roles = $facts['os_service_default'],
$image_conversion_output_format = $facts['os_service_default'],
$enabled_import_methods = $facts['os_service_default'],
$node_staging_uri = $facts['os_service_default'],
$worker_self_reference_url = $facts['os_service_default'],
$image_member_quota = $facts['os_service_default'],
$image_property_quota = $facts['os_service_default'],
$image_tag_quota = $facts['os_service_default'],
$image_location_quota = $facts['os_service_default'],
$image_size_cap = $facts['os_service_default'],
$user_storage_quota = $facts['os_service_default'],
$task_time_to_live = $facts['os_service_default'],
$task_executor = $facts['os_service_default'],
$task_work_dir = $facts['os_service_default'],
$taskflow_engine_mode = $facts['os_service_default'],
$taskflow_max_workers = $facts['os_service_default'],
$conversion_format = $facts['os_service_default'],
$enable_proxy_headers_parsing = $facts['os_service_default'],
$max_request_body_size = $facts['os_service_default'],
Boolean $sync_db = true,
$limit_param_default = $facts['os_service_default'],
$api_limit_max = $facts['os_service_default'],
$lock_path = $glance::params::lock_path,
$public_endpoint = $facts['os_service_default'],
$hashing_algorithm = $facts['os_service_default'],
# DEPRECATED PARAMETERS
$stores = undef,
$default_store = undef,
Boolean $multi_store = false,
$show_multiple_locations = undef,
$filesystem_store_metadata_file = undef,
$filesystem_store_file_perm = undef,
$delayed_delete = undef,
) inherits glance {
include glance::deps
include glance::policy
include glance::api::db
['filesystem_store_metadata_file', 'filesystem_store_file_perm'].each |String $fs_opt| {
if getvar($fs_opt) != undef {
warning("The ${fs_opt} parameter has been deprecated and will be removed.")
}
}
if $delayed_delete != undef {
warning('The delayed_delete parameter was deprecated and will be removed.')
}
if $sync_db {
include glance::db::sync
include glance::db::metadefs
}
if ( $glance::params::api_package_name != undef ) {
package { 'glance-api':
ensure => $package_ensure,
name => $glance::params::api_package_name,
tag => ['openstack', 'glance-package'],
}
}
if $enabled_import_methods != $facts['os_service_default'] {
# This option is a ListOpt that requires explicit brackets.
$enabled_import_methods_real = sprintf('[%s]', join(any2array($enabled_import_methods), ','))
} else {
$enabled_import_methods_real = $enabled_import_methods
}
# basic service config
glance_api_config {
'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/delayed_delete': value => pick($delayed_delete, $facts['os_service_default']);
'DEFAULT/enforce_secure_rbac': value => $enforce_secure_rbac;
'DEFAULT/use_keystone_limits': value => $use_keystone_limits;
'DEFAULT/image_cache_driver': value => $image_cache_driver;
'DEFAULT/image_cache_dir': value => $image_cache_dir;
'DEFAULT/image_cache_stall_time': value => $image_cache_stall_time;
'DEFAULT/image_cache_max_size': value => $image_cache_max_size;
'DEFAULT/enabled_import_methods': value => $enabled_import_methods_real;
'DEFAULT/node_staging_uri': value => $node_staging_uri;
'DEFAULT/worker_self_reference_url': value => $worker_self_reference_url;
'DEFAULT/image_member_quota': value => $image_member_quota;
'DEFAULT/image_property_quota': value => $image_property_quota;
'DEFAULT/image_tag_quota': value => $image_tag_quota;
'DEFAULT/image_location_quota': value => $image_location_quota;
'DEFAULT/image_size_cap': value => $image_size_cap;
'DEFAULT/user_storage_quota': value => $user_storage_quota;
'DEFAULT/limit_param_default': value => $limit_param_default;
'DEFAULT/api_limit_max': value => $api_limit_max;
'DEFAULT/public_endpoint': value => $public_endpoint;
'DEFAULT/hashing_algorithm': value => $hashing_algorithm;
}
if $show_multiple_locations {
warning('The show_multiple_locations parameter is deprecated, and will be removed in a future release')
}
glance_api_config {
'DEFAULT/show_multiple_locations': value => pick($show_multiple_locations, $facts['os_service_default']);
}
# task/taskflow_executor config.
glance_api_config {
'task/task_time_to_live': value => $task_time_to_live;
'task/task_executor': value => $task_executor;
'task/work_dir': value => $task_work_dir;
'taskflow_executor/engine_mode': value => $taskflow_engine_mode;
'taskflow_executor/max_workers': value => $taskflow_max_workers;
'taskflow_executor/conversion_format': value => $conversion_format,
}
if $enabled_backends {
$enabled_backends_array = any2array($enabled_backends)
# Verify the backend types are valid.
$enabled_backends_array.each |$backend| {
$backend_type = split($backend, /:/)[1]
unless $backend_type in ['file', 'http', 'swift', 'rbd', 'cinder', 's3'] {
fail("\'${backend_type}\' is not a valid backend type.")
}
}
# Verify the backend identifiers are unique and the default_backend is valid.
$backend_ids = $enabled_backends_array.map |$backend| { split($backend, /:/)[0] }
unless $backend_ids == unique($backend_ids) {
fail('All backend identifiers in enabled_backends must be unique.')
}
unless $default_backend {
fail('A glance default_backend must be specified.')
}
unless $default_backend in $backend_ids {
fail("The default_backend \'${default_backend}\' is not a valid backend identifier.")
}
glance_api_config {
'DEFAULT/enabled_backends': value => join($enabled_backends_array, ',');
'glance_store/default_backend': value => $default_backend;
'glance_store/stores': ensure => absent;
'glance_store/default_store': ensure => absent;
}
glance_cache_config {
'DEFAULT/enabled_backends': value => join($enabled_backends_array, ',');
'glance_store/default_backend': value => $default_backend;
'glance_store/stores': ensure => absent;
'glance_store/default_store': ensure => absent;
}
} elsif $stores or $default_store {
warning('The stores and default_store parameters are deprecated. Please use \
enabled_backends instead.')
if ($stores and !empty($stores)) {
# determine value for glance_store/stores
$stores_real = any2array($stores)
if !$default_store {
# set default store based on provided stores when it isn't explicitly set
warning("default_store not provided, it will be automatically set to ${stores[0]}")
$default_store_real = $stores[0]
} else {
$default_store_real = $default_store
}
} elsif $default_store {
# set stores based on default_store if only default_store is provided
$stores_real = [$default_store]
$default_store_real = $default_store
} else {
warning('Glance-api is being provisioned without any stores configured')
$stores_real = undef
$default_store_real = undef
}
if $multi_store {
if $default_store_real {
$default_store_opt = {
'glance_store/default_store' => { 'value' => $default_store_real },
}
} else {
$default_store_opt = {
'glance_store/default_store' => { 'ensure' => absent },
}
}
} else {
$default_store_opt = {}
}
if $stores_real {
$stores_opt = {
'glance_store/stores' => { 'value' => join($stores_real, ',') },
}
} else {
$stores_opt = {
'glance_store/stores' => { 'ensure' => absent },
}
}
create_resources('glance_api_config', stdlib::merge($default_store_opt, $stores_opt))
create_resources('glance_cache_config', stdlib::merge($default_store_opt, $stores_opt))
} else {
warning('Glance-api is being provisioned without any backends')
}
glance_api_config {
'glance_store/filesystem_store_metadata_file':
value => pick($filesystem_store_metadata_file, $facts['os_service_default']);
'glance_store/filesystem_store_file_perm':
value => pick($filesystem_store_file_perm, $facts['os_service_default']);
}
glance_cache_config {
'glance_store/filesystem_store_metadata_file':
value => pick($filesystem_store_metadata_file, $facts['os_service_default']);
'glance_store/filesystem_store_file_perm':
value => pick($filesystem_store_file_perm, $facts['os_service_default']);
}
glance_api_config {
'image_format/container_formats': value => join(any2array($container_formats), ',');
'image_format/disk_formats': value => join(any2array($disk_formats), ',');
'image_format/require_image_format_match': value => $require_image_format_match;
}
resources { 'glance_api_config':
purge => $purge_config,
}
glance_cache_config {
'DEFAULT/image_cache_driver': value => $image_cache_driver;
'DEFAULT/image_cache_dir': value => $image_cache_dir;
'DEFAULT/image_cache_stall_time': value => $image_cache_stall_time;
'DEFAULT/image_cache_max_size': value => $image_cache_max_size;
}
if $image_import_plugins != $facts['os_service_default'] {
$image_import_plugins_real = sprintf('[%s]', join(any2array($image_import_plugins), ','))
} else {
$image_import_plugins_real = $image_import_plugins
}
glance_image_import_config {
'image_import_opts/image_import_plugins': value => $image_import_plugins_real;
'image_conversion/output_format': value => $image_conversion_output_format;
'inject_metadata_properties/inject': value => $inject_metadata_properties;
'inject_metadata_properties/ignore_user_roles': value => $ignore_user_roles;
}
glance_api_config {
'paste_deploy/flavor': value => $paste_deploy_flavor;
'paste_deploy/config_file': value => $paste_deploy_config_file;
}
# keystone config
if $auth_strategy == 'keystone' {
include glance::api::authtoken
}
oslo::concurrency { ['glance_api_config', 'glance_cache_config']:
lock_path => $lock_path,
}
oslo::middleware { 'glance_api_config':
enable_proxy_headers_parsing => $enable_proxy_headers_parsing,
max_request_body_size => $max_request_body_size,
}
if $manage_service {
case $service_name {
'httpd': {
Service <| title == 'httpd' |> { tag +> 'glance-service' }
service { 'glance-api':
ensure => 'stopped',
name => $glance::params::api_service_name,
enable => false,
tag => 'glance-service',
}
# we need to make sure glance-api/eventlet is stopped before trying to start apache
Service['glance-api'] -> Service['httpd']
# On any paste-api.ini config change, we must restart Glance API.
Glance_api_paste_ini<||> ~> Service['httpd']
}
default: {
$service_ensure = $enabled ? {
true => 'running',
default => 'stopped',
}
service { 'glance-api':
ensure => $service_ensure,
name => $service_name,
enable => $enabled,
hasstatus => true,
hasrestart => true,
tag => 'glance-service',
}
# On any paste-api.ini config change, we must restart Glance API.
Glance_api_paste_ini<||> ~> Service['glance-api']
# On any uwsgi config change, we must restart Glance API.
Glance_api_uwsgi_config<||> ~> Service['glance-api']
}
}
}
}