323 lines
12 KiB
Puppet
323 lines
12 KiB
Puppet
# == Class: nova::api
|
|
#
|
|
# Setup and configure the Nova API endpoint
|
|
#
|
|
# === Parameters
|
|
#
|
|
# [*enabled*]
|
|
# (optional) Whether the nova api service will be run
|
|
# Defaults to true
|
|
#
|
|
# [*api_paste_config*]
|
|
# (optional) File name for the paste.deploy config for nova-api
|
|
# Defaults to 'api-paste.ini'
|
|
#
|
|
# [*manage_service*]
|
|
# (optional) Whether to start/stop the service
|
|
# Defaults to true
|
|
#
|
|
# [*ensure_package*]
|
|
# (optional) Whether the nova api package will be installed
|
|
# Defaults to 'present'
|
|
#
|
|
# [*api_bind_address*]
|
|
# (optional) IP address for nova-api server to listen
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*metadata_listen*]
|
|
# (optional) IP address for metadata server to listen
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*metadata_listen_port*]
|
|
# (optional) The port on which the metadata API will listen.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*enabled_apis*]
|
|
# (optional) A list of apis to enable
|
|
# Defaults to ['osapi_compute', 'metadata']
|
|
#
|
|
# [*osapi_compute_workers*]
|
|
# (optional) Number of workers for OpenStack API service
|
|
# Defaults to $facts['os_workers']
|
|
#
|
|
# [*osapi_compute_listen_port*]
|
|
# (optional) The port on which the OpenStack API will listen.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*metadata_workers*]
|
|
# (optional) Number of workers for metadata service
|
|
# Defaults to $facts['os_workers']
|
|
#
|
|
# [*sync_db*]
|
|
# (optional) Run nova-manage db sync on api nodes after installing the package.
|
|
# Defaults to true
|
|
#
|
|
# [*sync_db_api*]
|
|
# (optional) Run nova-manage api_db sync on api nodes after installing the package.
|
|
# Defaults to true
|
|
#
|
|
# [*db_online_data_migrations*]
|
|
# (optional) Run nova-manage db online_data_migrations on api nodes after
|
|
# installing the package - required on upgrade.
|
|
# Defaults to false.
|
|
#
|
|
# [*enable_proxy_headers_parsing*]
|
|
# (optional) This determines if the HTTPProxyToWSGI
|
|
# middleware should parse the proxy headers or not.(boolean value)
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*max_request_body_size*]
|
|
# (Optional) Set max request body size
|
|
# Defaults to $facts['os_service_default'].
|
|
#
|
|
# [*service_name*]
|
|
# (optional) Name of the service that will be providing the
|
|
# server functionality of nova-api.
|
|
# If the value is 'httpd', this means nova-api will be a web
|
|
# service, and you must use another class to configure that
|
|
# web service. For example, use class { 'nova::wsgi::apache'...}
|
|
# to make nova be a web app using apache mod_wsgi.
|
|
# Defaults to '$::nova::params::api_service_name'
|
|
#
|
|
# [*metadata_service_name*]
|
|
# (optional) Name of the service that will be providing the
|
|
# server functionality of nova-api-metadata.
|
|
# If the value is undef, no management of the service will be
|
|
# done by puppet. If the value is defined, and manage_service
|
|
# is set to true, the service will be managed by Puppet.
|
|
# Default to $::nova::params::api_metadata_service_name
|
|
#
|
|
# [*max_limit*]
|
|
# (optional) This option is limit the maximum number of items in a single response.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*compute_link_prefix*]
|
|
# (optional) This string is prepended to the normal URL that is returned in links
|
|
# to the OpenStack Compute API.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*glance_link_prefix*]
|
|
# (optional) This string is prepended to the normal URL that is returned in links
|
|
# to Glance resources.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*enable_instance_password*]
|
|
# (optional) Enables returning of the instance password by the relevant server API calls
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*password_length*]
|
|
# (optional) Length of generated instance admin passwords (integer value)
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*allow_resize_to_same_host*]
|
|
# (optional) Allow destination machine to match source for resize.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*instance_list_per_project_cells*]
|
|
# (optional) Only query cell databases in which the tenant has mapped
|
|
# instances
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*instance_list_cells_batch_strategy*]
|
|
# (optional) The method by which the API queries cell databases in smaller
|
|
# batches during large instance list operations.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*instance_list_cells_batch_fixed_size*]
|
|
# (optional) This controls batch size of instances requested from each cell
|
|
# database if ``instance_list_cells_batch_strategy``` is set to ``fixed``
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# [*list_records_by_skipping_down_cells*]
|
|
# (optional) Whether to skip the down cells and return the results from
|
|
# the up cells.
|
|
# Defaults to $facts['os_service_default']
|
|
#
|
|
# DEPRECATED
|
|
#
|
|
# [*nova_metadata_wsgi_enabled*]
|
|
# Wether nova metadata api is run via wsgi. Since running metadata via eventlet is
|
|
# going to be removed in the Sein release we can deprecate this and plan to remove
|
|
# metadata handling from api class.
|
|
# Defaults to false
|
|
#
|
|
# [*hide_server_address_states*]
|
|
# (optional) This option is a list of all instance states for which network address
|
|
# information should not be returned from the API.
|
|
# Defaults to undef
|
|
#
|
|
# [*allow_instance_snapshots*]
|
|
# (optional) Operators can turn off the ability for a user to take snapshots of their
|
|
# instances by setting this option to False
|
|
# Defaults to undef
|
|
#
|
|
# [*enable_network_quota*]
|
|
# (optional) This option is used to enable or disable quota checking for tenant networks
|
|
# Defaults to undef
|
|
#
|
|
class nova::api(
|
|
Boolean $enabled = true,
|
|
Boolean $manage_service = true,
|
|
$api_paste_config = 'api-paste.ini',
|
|
$ensure_package = 'present',
|
|
$api_bind_address = $facts['os_service_default'],
|
|
$osapi_compute_listen_port = $facts['os_service_default'],
|
|
$metadata_listen = $facts['os_service_default'],
|
|
$metadata_listen_port = $facts['os_service_default'],
|
|
$enabled_apis = ['osapi_compute', 'metadata'],
|
|
$osapi_compute_workers = $facts['os_workers'],
|
|
$metadata_workers = $facts['os_workers'],
|
|
Boolean $sync_db = true,
|
|
Boolean $sync_db_api = true,
|
|
Boolean $db_online_data_migrations = false,
|
|
$service_name = $::nova::params::api_service_name,
|
|
$metadata_service_name = $::nova::params::api_metadata_service_name,
|
|
$enable_proxy_headers_parsing = $facts['os_service_default'],
|
|
$max_request_body_size = $facts['os_service_default'],
|
|
$max_limit = $facts['os_service_default'],
|
|
$compute_link_prefix = $facts['os_service_default'],
|
|
$glance_link_prefix = $facts['os_service_default'],
|
|
$enable_instance_password = $facts['os_service_default'],
|
|
$password_length = $facts['os_service_default'],
|
|
$allow_resize_to_same_host = $facts['os_service_default'],
|
|
$instance_list_per_project_cells = $facts['os_service_default'],
|
|
$instance_list_cells_batch_strategy = $facts['os_service_default'],
|
|
$instance_list_cells_batch_fixed_size = $facts['os_service_default'],
|
|
$list_records_by_skipping_down_cells = $facts['os_service_default'],
|
|
# DEPRECATED PARAMETER
|
|
$nova_metadata_wsgi_enabled = undef,
|
|
$hide_server_address_states = undef,
|
|
$allow_instance_snapshots = undef,
|
|
$enable_network_quota = undef,
|
|
) inherits nova::params {
|
|
|
|
include nova::deps
|
|
include nova::db
|
|
include nova::policy
|
|
include nova::keystone::authtoken
|
|
include nova::availability_zone
|
|
include nova::pci
|
|
|
|
if $nova_metadata_wsgi_enabled != undef {
|
|
warning('The nova_metadata_wsgi_enabled parameter has been deprecated and has no effect')
|
|
}
|
|
|
|
[
|
|
'hide_server_address_states',
|
|
'allow_instance_snapshots',
|
|
'enable_network_quota'
|
|
].each |String $opt| {
|
|
if getvar($opt) != undef {
|
|
warning("The ${opt} parameter has been deprecated and has no effect.")
|
|
}
|
|
}
|
|
|
|
# sanitize service_name and prepare DEFAULT/enabled_apis parameter
|
|
if $service_name == $::nova::params::api_service_name {
|
|
nova_config {
|
|
'DEFAULT/enabled_apis': value => join(any2array($enabled_apis), ',');
|
|
}
|
|
$service_enabled = $enabled
|
|
} elsif $service_name == 'httpd' {
|
|
nova_config {
|
|
'DEFAULT/enabled_apis': ensure => absent;
|
|
}
|
|
$service_enabled = false
|
|
|
|
policy_rcd { 'nova-api':
|
|
ensure => present,
|
|
set_code => '101',
|
|
before => Package['nova-api'],
|
|
}
|
|
|
|
if $manage_service {
|
|
Service <| title == 'httpd' |> { tag +> 'nova-service' }
|
|
# make sure we start apache before nova-api and nova-metadata-api are
|
|
# stopped to avoid binding issues
|
|
Service['nova-api'] -> Service[$service_name]
|
|
if $metadata_service_name {
|
|
Service['nova-api-metadata'] -> Service[$service_name]
|
|
}
|
|
}
|
|
} else {
|
|
fail("Invalid service_name. Either nova-api/openstack-nova-api for running \
|
|
as a standalone service, or httpd for being run by a httpd server")
|
|
}
|
|
|
|
nova::generic_service { 'api':
|
|
enabled => $service_enabled,
|
|
manage_service => $manage_service,
|
|
ensure_package => $ensure_package,
|
|
package_name => $::nova::params::api_package_name,
|
|
service_name => $::nova::params::api_service_name,
|
|
}
|
|
|
|
if $metadata_service_name {
|
|
nova::generic_service { 'api-metadata':
|
|
enabled => $service_enabled,
|
|
manage_service => $manage_service,
|
|
ensure_package => $ensure_package,
|
|
package_name => $::nova::params::api_package_name,
|
|
service_name => $metadata_service_name,
|
|
}
|
|
}
|
|
|
|
if $service_name != 'httpd' {
|
|
nova_config {
|
|
'DEFAULT/osapi_compute_listen': value => $api_bind_address;
|
|
'DEFAULT/osapi_compute_listen_port': value => $osapi_compute_listen_port;
|
|
'DEFAULT/osapi_compute_workers': value => $osapi_compute_workers;
|
|
'DEFAULT/metadata_workers': value => $metadata_workers;
|
|
'DEFAULT/metadata_listen': value => $metadata_listen;
|
|
'DEFAULT/metadata_listen_port': value => $metadata_listen_port;
|
|
}
|
|
} else {
|
|
nova_config {
|
|
'DEFAULT/osapi_compute_listen': ensure => absent;
|
|
'DEFAULT/osapi_compute_listen_port': ensure => absent;
|
|
'DEFAULT/osapi_compute_workers': ensure => absent;
|
|
'DEFAULT/metadata_workers': ensure => absent;
|
|
'DEFAULT/metadata_listen': ensure => absent;
|
|
'DEFAULT/metadata_listen_port': ensure => absent;
|
|
}
|
|
}
|
|
|
|
oslo::middleware {'nova_config':
|
|
enable_proxy_headers_parsing => $enable_proxy_headers_parsing,
|
|
max_request_body_size => $max_request_body_size,
|
|
}
|
|
|
|
nova_config {
|
|
'wsgi/api_paste_config': value => $api_paste_config;
|
|
'DEFAULT/password_length': value => $password_length;
|
|
'api/max_limit': value => $max_limit;
|
|
'api/compute_link_prefix': value => $compute_link_prefix;
|
|
'api/glance_link_prefix': value => $glance_link_prefix;
|
|
'api/enable_instance_password': value => $enable_instance_password;
|
|
'DEFAULT/allow_resize_to_same_host': value => $allow_resize_to_same_host;
|
|
'api/instance_list_per_project_cells': value => $instance_list_per_project_cells;
|
|
'api/instance_list_cells_batch_strategy': value => $instance_list_cells_batch_strategy;
|
|
'api/instance_list_cells_batch_fixed_size': value => $instance_list_cells_batch_fixed_size;
|
|
'api/list_records_by_skipping_down_cells': value => $list_records_by_skipping_down_cells;
|
|
}
|
|
|
|
# TODO(tkajinam): Remove this after 2024.1 release
|
|
nova_config {
|
|
'api/hide_server_address_states': ensure => absent;
|
|
'api/allow_instance_snapshots': ensure => absent;
|
|
'DEFAULT/enable_network_quota': ensure => absent;
|
|
}
|
|
|
|
# Added arg and if statement prevents this from being run
|
|
# where db is not active i.e. the compute
|
|
if $sync_db {
|
|
include nova::db::sync
|
|
}
|
|
if $sync_db_api {
|
|
include nova::db::sync_api
|
|
}
|
|
if $db_online_data_migrations {
|
|
include nova::db::online_data_migrations
|
|
}
|
|
}
|