diff --git a/manifests/api.pp b/manifests/api.pp index 97f9c042..27cde521 100644 --- a/manifests/api.pp +++ b/manifests/api.pp @@ -48,283 +48,56 @@ # [*api_base_uri*] # Set the base URI of the Designate API service. # -# KeystoneMiddleware Parameters -# -# [*username*] -# (optional) The name of the service user -# Defaults to 'designate' -# -# [*password*] -# (optional) Password for the user -# Defaults to $::os_service_default -# -# [*auth_url*] -# (optional) The URL to use for admin authentication. -# Defaults to: 'http://localhost:35357' -# -# [*auth_uri*] -# (optional) The URL to use for public authentication. -# Defaults to: 'http://localhost:5000'. -# -# [*project_name*] -# (optional) Service project name -# Defaults to 'services' -# -# [*user_domain_name*] -# (optional) Name of domain for $username -# Defaults to $::os_service_default -# -# [*project_domain_name*] -# (optional) Name of domain for $project_name -# Defaults to $::os_service_default -# -# [*insecure*] -# (optional) If true, explicitly allow TLS without checking server cert -# against any certificate authorities. -# WARNING: not recommended. Use with caution. -# Defaults to $::os_service_default -# -# [*auth_section*] -# (optional) Config Section from which to load plugin specific options -# Defaults to $::os_service_default -# -# [*auth_type*] -# (optional) Authentication type to load -# Defaults to $::os_service_default -# -# [*cache*] -# (optional) Env key for the swift cache. -# Defaults to $::os_service_default -# -# [*cafile*] -# (optional) A PEM encoded Certificate Authority to use when verifying HTTPs -# connections -# Defaults to $::os_service_default -# -# [*certfile*] -# (optional) Required if identity server requires client certificate -# Defaults to $::os_service_default -# -# [*check_revocations_for_cached*] -# (optional) If true, the revocation list will be checked for cached tokens. -# This requires that PKI tokens are configured on the identity server. -# boolean value. -# Defaults to $::os_service_default -# -# [*delay_auth_decision*] -# (optional) Do not handle authorization requests within the middleware, but -# delegate the authorization decision to downstream WSGI components. Boolean -# value -# Defaults to $::os_service_default -# -# [*enforce_token_bind*] -# (Optional) Used to control the use and type of token binding. Can be set -# to: "disabled" to not check token binding. "permissive" (default) to -# validate binding information if the bind type is of a form known to the -# server and ignore it if not. "strict" like "permissive" but if the bind -# type is unknown the token will be rejected. "required" any form of token -# binding is needed to be allowed. Finally the name of a binding method that -# must be present in tokens. String value. -# Defaults to $::os_service_default. -# -# [*hash_algorithms*] -# (Optional) Hash algorithms to use for hashing PKI tokens. This may be a -# single algorithm or multiple. The algorithms are those supported by Python -# standard hashlib.new(). The hashes will be tried in the order given, so put -# the preferred one first for performance. The result of the first hash will -# be stored in the cache. This will typically be set to multiple values only -# while migrating from a less secure algorithm to a more secure one. Once all -# the old tokens are expired this option should be set to a single value for -# better performance. List value. -# Defaults to $::os_service_default. -# -# [*http_connect_timeout*] -# (optional) Request timeout value for communicating with Identity API server. -# Defaults to $::os_service_default -# -# [*http_request_max_retries*] -# (optional) How many times are we trying to reconnect when communicating -# with Identity API Server. Integer value -# Defaults to $::os_service_default -# -# [*include_service_catalog*] -# (Optional) Indicate whether to set the X-Service-Catalog header. If False, -# middleware will not ask for service catalog on token validation and will not -# set the X-Service-Catalog header. Boolean value. -# Defaults to $::os_service_default. -# -# [*keyfile*] -# (Optional) Required if identity server requires client certificate -# Defaults to $::os_service_default. -# -# [*memcache_pool_conn_get_timeout*] -# (Optional) Number of seconds that an operation will wait to get a memcached -# client connection from the pool. Integer value -# Defaults to $::os_service_default. -# -# [*memcache_pool_dead_retry*] -# (Optional) Number of seconds memcached server is considered dead before it -# is tried again. Integer value -# Defaults to $::os_service_default. -# -# [*memcache_pool_maxsize*] -# (Optional) Maximum total number of open connections to every memcached -# server. Integer value -# Defaults to $::os_service_default. -# -# [*memcache_pool_socket_timeout*] -# (Optional) Number of seconds a connection to memcached is held unused in -# the -# pool before it is closed. Integer value -# Defaults to $::os_service_default. -# -# [*memcache_pool_unused_timeout*] -# (Optional) Number of seconds a connection to memcached is held unused in -# the -# pool before it is closed. Integer value -# Defaults to $::os_service_default. -# -# [*memcache_secret_key*] -# (Optional, mandatory if memcache_security_strategy is defined) This string -# is used for key derivation. -# Defaults to $::os_service_default. -# -# [*memcache_security_strategy*] -# (Optional) If defined, indicate whether token data should be authenticated -# or -# authenticated and encrypted. If MAC, token data is authenticated (with -# HMAC) -# in the cache. If ENCRYPT, token data is encrypted and authenticated in the -# cache. If the value is not one of these options or empty, auth_token will -# raise an exception on initialization. -# Defaults to $::os_service_default. -# -# [*memcache_use_advanced_pool*] -# (Optional) Use the advanced (eventlet safe) memcached client pool. The -# advanced pool will only work under python 2.x Boolean value -# Defaults to $::os_service_default. -# -# [*memcached_servers*] -# (Optional) Optionally specify a list of memcached server(s) to use for -# caching. If left undefined, tokens will instead be cached in-process. -# Defaults to $::os_service_default. -# -# [*region_name*] -# (Optional) The region in which the identity server can be found. -# Defaults to $::os_service_default. -# -# [*region_name*] -# (optional) -# Defaults to $::os_service_default -# -# [*revocation_cache_time*] -# (Optional) Determines the frequency at which the list of revoked tokens is -# retrieved from the Identity service (in seconds). A high number of -# revocation events combined with a low cache duration may significantly -# reduce performance. Only valid for PKI tokens. Integer value -# Defaults to $::os_service_default. -# -# [*signing_dir*] -# (Optional) Directory used to cache files related to PKI tokens. -# Defaults to $::os_service_default. -# -# [*token_cache_time*] -# (Optional) In order to prevent excessive effort spent validating tokens, -# the middleware caches previously-seen tokens for a configurable duration -# (in seconds). Set to -1 to disable caching completely. Integer value -# Defaults to $::os_service_default. -# -# [*auth_version*] -# (optional) API version of the identity API endpoint -# Defaults to $::os_service_default. -# # DEPRECATED PARAMETERS # # [*keystone_host*] -# (optional) Host running auth service. +# (optional) DEECATED. Host running auth service. # Defaults to undef # # [*keystone_port*] -# (optional) Port to use for auth service on auth_host. +# (optional) DEPRECATED. Port to use for auth service on auth_host. # Defaults to undef # # [*keystone_protocol*] -# (optional) Protocol to use for auth. +# (optional) DEPRECATED. Protocol to use for auth. # Defaults to undef # # [*keystone_tenant*] -# (optional) Tenant to authenticate to. +# (optional) DPRECATED. Use designate::keystone::authtoken::project_name # Defaults to undef # # [*keystone_user*] -# (optional) User to authenticate as with keystone. +# (optional) DEPRECATED. Use designate::keystone::authtoken::username # Defaults to undef # # [*keystone_password*] -# (optional) Password used to authentication. +# (optional) DEPRECATED. Use designate::keystone::authtoken::password # Defaults to undef # # [*keystone_memcached_servers*] -# (optional) Memcached Servers for keystone. Supply a list of memcached server -# IP's:Memcached Port. -# Defaults to false +# (optional) DEPRECATED. Use designate::keystone::authtoken::memcached_servers instead +# Defaults to undef # class designate::api ( - $package_ensure = present, - $api_package_name = $::designate::params::api_package_name, - $enabled = true, - $service_ensure = 'running', - $auth_strategy = 'noauth', - $enable_api_v1 = true, - $enable_api_v2 = false, - $enable_api_admin = false, - $api_host = '0.0.0.0', - $api_port = '9001', - $api_base_uri = $::os_service_default, - # keystone::resource::authtoken parameters - $username = 'designate', - $password = $::os_service_default, - $auth_url = 'http://localhost:35357', - $auth_uri = 'http://localhost:5000', - $project_name = 'services', - $user_domain_name = $::os_service_default, - $project_domain_name = $::os_service_default, - $insecure = $::os_service_default, - $auth_section = $::os_service_default, - $auth_type = 'password', - $cache = $::os_service_default, - $cafile = $::os_service_default, - $certfile = $::os_service_default, - $check_revocations_for_cached = $::os_service_default, - $delay_auth_decision = $::os_service_default, - $enforce_token_bind = $::os_service_default, - $hash_algorithms = $::os_service_default, - $http_connect_timeout = $::os_service_default, - $http_request_max_retries = $::os_service_default, - $include_service_catalog = $::os_service_default, - $keyfile = $::os_service_default, - $memcache_pool_conn_get_timeout = $::os_service_default, - $memcache_pool_dead_retry = $::os_service_default, - $memcache_pool_maxsize = $::os_service_default, - $memcache_pool_socket_timeout = $::os_service_default, - $memcache_secret_key = $::os_service_default, - $memcache_security_strategy = $::os_service_default, - $memcache_use_advanced_pool = $::os_service_default, - $memcache_pool_unused_timeout = $::os_service_default, - $memcached_servers = $::os_service_default, - $region_name = $::os_service_default, - $revocation_cache_time = $::os_service_default, - $signing_dir = $::os_service_default, - $token_cache_time = $::os_service_default, - $auth_version = $::os_service_default, + $package_ensure = present, + $api_package_name = $::designate::params::api_package_name, + $enabled = true, + $service_ensure = 'running', + $auth_strategy = 'noauth', + $enable_api_v1 = true, + $enable_api_v2 = false, + $enable_api_admin = false, + $api_host = '0.0.0.0', + $api_port = '9001', + $api_base_uri = $::os_service_default, # DEPRECATED PARAMETERS - $keystone_host = undef, - $keystone_port = undef, - $keystone_protocol = undef, - $keystone_tenant = undef, - $keystone_user = undef, - $keystone_password = undef, - $keystone_memcached_servers = undef, + $keystone_host = undef, + $keystone_port = undef, + $keystone_protocol = undef, + $keystone_tenant = undef, + $keystone_user = undef, + $keystone_password = undef, + $keystone_memcached_servers = undef, ) inherits designate { # API Service @@ -340,78 +113,32 @@ class designate::api ( # Keystone Middleware if ($keystone_host and $keystone_port and $keystone_protocol) { - warning('keystone_host, keystone_port and keystone_protocol are deprecated, use auth_uri and auth_url instead') - $auth_uri_real = "${keystone_protocol}://${keystone_host}:${keystone_port}" - $auth_url_real = "${keystone_protocol}://${keystone_host}:${keystone_port}" + warning('keystone_host, keystone_port and keystone_protocol are deprecated, please use designate::keystone::authtoken') + $auth_uri = "${keystone_protocol}://${keystone_host}:${keystone_port}" + $auth_url = "${keystone_protocol}://${keystone_host}:${keystone_port}" } else { - $auth_uri_real = $auth_uri - $auth_url_real = $auth_url + $auth_uri = undef + $auth_url = undef } if ($keystone_user) { - warning('keystone_user is deprecated, use username instead') - $username_real = $keystone_user - } else { - $username_real = $username + warning('keystone_user is deprecated, please use designate::keystone::authtoken::username') } if ($keystone_password) { - warning('keystone_password is deprecated, use password instead') - $password_real = $keystone_password - } else { - $password_real = $password + warning('keystone_password is deprecated, please use designate::keystone::authtoken::password') } if ($keystone_tenant) { - warning('keystone_tenant is deprecated, use project_name instead') - $project_name_real = $keystone_tenant - } else { - $project_name_real = $project_name + warning('keystone_tenant is deprecated, please use designate::keystone::authtoken::project_name') } if ($keystone_memcached_servers) { - warning('keystone_memcached_servers is deprecated use memcached_servers instead') - $memcached_servers_real = $keystone_memcached_servers - } else { - $memcached_servers_real = $memcached_servers + warning('keystone_memcached_servers is deprecated, please use designate::keystone::authtoken::memcached_servers') } - keystone::resource::authtoken { 'designate_config': - username => $username_real, - password => $password_real, - auth_url => $auth_url_real, - project_name => $project_name_real, - user_domain_name => $user_domain_name, - project_domain_name => $project_domain_name, - insecure => $insecure, - auth_section => $auth_section, - auth_type => $auth_type, - auth_uri => $auth_uri_real, - auth_version => $auth_version, - cache => $cache, - cafile => $cafile, - certfile => $certfile, - check_revocations_for_cached => $check_revocations_for_cached, - delay_auth_decision => $delay_auth_decision, - enforce_token_bind => $enforce_token_bind, - hash_algorithms => $hash_algorithms, - http_connect_timeout => $http_connect_timeout, - http_request_max_retries => $http_request_max_retries, - include_service_catalog => $include_service_catalog, - keyfile => $keyfile, - memcache_pool_conn_get_timeout => $memcache_pool_conn_get_timeout, - memcache_pool_dead_retry => $memcache_pool_dead_retry, - memcache_pool_maxsize => $memcache_pool_maxsize, - memcache_pool_socket_timeout => $memcache_pool_socket_timeout, - memcache_pool_unused_timeout => $memcache_pool_unused_timeout, - memcache_secret_key => $memcache_secret_key, - memcache_security_strategy => $memcache_security_strategy, - memcache_use_advanced_pool => $memcache_use_advanced_pool, - memcached_servers => $memcached_servers_real, - region_name => $region_name, - revocation_cache_time => $revocation_cache_time, - signing_dir => $signing_dir, - token_cache_time => $token_cache_time, + if $auth_strategy == 'keystone' { + include ::designate::keystone::authtoken } designate::generic_service { 'api': @@ -421,5 +148,4 @@ class designate::api ( package_name => $api_package_name, service_name => $::designate::params::api_service_name, } - } diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp new file mode 100644 index 00000000..66d4b682 --- /dev/null +++ b/manifests/keystone/authtoken.pp @@ -0,0 +1,279 @@ +# class: designate::keystone::authtoken +# +# Configure the keystone_authtoken section in the configuration file +# +# === Parameters +# +# [*username*] +# (Optional) The name of the service user +# Defaults to 'designate' +# +# [*password*] +# (Optional) Password to create for the service user +# Defaults to $::os_service_default +# +# [*auth_url*] +# (Optional) The URL to use for authentication. +# Defaults to 'http://localhost:35357'. +# +# [*project_name*] +# (Optional) Service project name +# Defaults to 'services' +# +# [*user_domain_name*] +# (Optional) Name of domain for $username +# Defaults to $::os_service_default +# +# [*project_domain_name*] +# (Optional) Name of domain for $project_name +# Defaults to $::os_service_default +# +# [*insecure*] +# (Optional) If true, explicitly allow TLS without checking server cert +# against any certificate authorities. WARNING: not recommended. Use with +# caution. +# Defaults to $:os_service_default +# +# [*auth_section*] +# (Optional) Config Section from which to load plugin specific options +# Defaults to $::os_service_default. +# +# [*auth_type*] +# (Optional) Authentication type to load +# Defaults to 'password' +# +# [*auth_uri*] +# (Optional) Complete public Identity API endpoint. +# Defaults to 'http://localhost:5000'. +# +# [*auth_version*] +# (Optional) API version of the admin Identity API endpoint. +# Defaults to $::os_service_default. +# +# [*cache*] +# (Optional) Env key for the swift cache. +# Defaults to $::os_service_default. +# +# [*cafile*] +# (Optional) A PEM encoded Certificate Authority to use when verifying HTTPs +# connections. +# Defaults to $::os_service_default. +# +# [*certfile*] +# (Optional) Required if identity server requires client certificate +# Defaults to $::os_service_default. +# +# [*check_revocations_for_cached*] +# (Optional) If true, the revocation list will be checked for cached tokens. +# This requires that PKI tokens are configured on the identity server. +# boolean value. +# Defaults to $::os_service_default. +# +# [*delay_auth_decision*] +# (Optional) Do not handle authorization requests within the middleware, but +# delegate the authorization decision to downstream WSGI components. Boolean +# value +# Defaults to $::os_service_default. +# +# [*enforce_token_bind*] +# (Optional) Used to control the use and type of token binding. Can be set +# to: "disabled" to not check token binding. "permissive" (default) to +# validate binding information if the bind type is of a form known to the +# server and ignore it if not. "strict" like "permissive" but if the bind +# type is unknown the token will be rejected. "required" any form of token +# binding is needed to be allowed. Finally the name of a binding method that +# must be present in tokens. String value. +# Defaults to $::os_service_default. +# +# [*hash_algorithms*] +# (Optional) Hash algorithms to use for hashing PKI tokens. This may be a +# single algorithm or multiple. The algorithms are those supported by Python +# standard hashlib.new(). The hashes will be tried in the order given, so put +# the preferred one first for performance. The result of the first hash will +# be stored in the cache. This will typically be set to multiple values only +# while migrating from a less secure algorithm to a more secure one. Once all +# the old tokens are expired this option should be set to a single value for +# better performance. List value. +# Defaults to $::os_service_default. +# +# [*http_connect_timeout*] +# (Optional) Request timeout value for communicating with Identity API +# server. +# Defaults to $::os_service_default. +# +# [*http_request_max_retries*] +# (Optional) How many times are we trying to reconnect when communicating +# with Identity API Server. Integer value +# Defaults to $::os_service_default. +# +# [*include_service_catalog*] +# (Optional) Indicate whether to set the X-Service-Catalog header. If False, +# middleware will not ask for service catalog on token validation and will +# not +# set the X-Service-Catalog header. Boolean value. +# Defaults to $::os_service_default. +# +# [*keyfile*] +# (Optional) Required if identity server requires client certificate +# Defaults to $::os_service_default. +# +# [*memcache_pool_conn_get_timeout*] +# (Optional) Number of seconds that an operation will wait to get a memcached +# client connection from the pool. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_dead_retry*] +# (Optional) Number of seconds memcached server is considered dead before it +# is tried again. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_maxsize*] +# (Optional) Maximum total number of open connections to every memcached +# server. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_socket_timeout*] +# (Optional) Number of seconds a connection to memcached is held unused in +# the +# pool before it is closed. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_pool_unused_timeout*] +# (Optional) Number of seconds a connection to memcached is held unused in +# the +# pool before it is closed. Integer value +# Defaults to $::os_service_default. +# +# [*memcache_secret_key*] +# (Optional, mandatory if memcache_security_strategy is defined) This string +# is used for key derivation. +# Defaults to $::os_service_default. +# +# [*memcache_security_strategy*] +# (Optional) If defined, indicate whether token data should be authenticated +# or +# authenticated and encrypted. If MAC, token data is authenticated (with +# HMAC) +# in the cache. If ENCRYPT, token data is encrypted and authenticated in the +# cache. If the value is not one of these options or empty, auth_token will +# raise an exception on initialization. +# Defaults to $::os_service_default. +# +# [*memcache_use_advanced_pool*] +# (Optional) Use the advanced (eventlet safe) memcached client pool. The +# advanced pool will only work under python 2.x Boolean value +# Defaults to $::os_service_default. +# +# [*memcached_servers*] +# (Optional) Optionally specify a list of memcached server(s) to use for +# caching. If left undefined, tokens will instead be cached in-process. +# Defaults to $::os_service_default. +# +# [*region_name*] +# (Optional) The region in which the identity server can be found. +# Defaults to $::os_service_default. +# +# [*revocation_cache_time*] +# (Optional) Determines the frequency at which the list of revoked tokens is +# retrieved from the Identity service (in seconds). A high number of +# revocation events combined with a low cache duration may significantly +# reduce performance. Only valid for PKI tokens. Integer value +# Defaults to $::os_service_default. +# +# [*signing_dir*] +# (Optional) Directory used to cache files related to PKI tokens. +# Defaults to $::os_service_default. +# +# [*token_cache_time*] +# (Optional) In order to prevent excessive effort spent validating tokens, +# the middleware caches previously-seen tokens for a configurable duration +# (in seconds). Set to -1 to disable caching completely. Integer value +# Defaults to $::os_service_default. +# +class designate::keystone::authtoken( + $username = 'designate', + $password = $::os_service_default, + $auth_url = 'http://localhost:35357', + $project_name = 'services', + $user_domain_name = $::os_service_default, + $project_domain_name = $::os_service_default, + $insecure = $::os_service_default, + $auth_section = $::os_service_default, + $auth_type = 'password', + $auth_uri = 'http://localhost:5000', + $auth_version = $::os_service_default, + $cache = $::os_service_default, + $cafile = $::os_service_default, + $certfile = $::os_service_default, + $check_revocations_for_cached = $::os_service_default, + $delay_auth_decision = $::os_service_default, + $enforce_token_bind = $::os_service_default, + $hash_algorithms = $::os_service_default, + $http_connect_timeout = $::os_service_default, + $http_request_max_retries = $::os_service_default, + $include_service_catalog = $::os_service_default, + $keyfile = $::os_service_default, + $memcache_pool_conn_get_timeout = $::os_service_default, + $memcache_pool_dead_retry = $::os_service_default, + $memcache_pool_maxsize = $::os_service_default, + $memcache_pool_socket_timeout = $::os_service_default, + $memcache_pool_unused_timeout = $::os_service_default, + $memcache_secret_key = $::os_service_default, + $memcache_security_strategy = $::os_service_default, + $memcache_use_advanced_pool = $::os_service_default, + $memcached_servers = $::os_service_default, + $region_name = $::os_service_default, + $revocation_cache_time = $::os_service_default, + $signing_dir = $::os_service_default, + $token_cache_time = $::os_service_default, +) { + + if is_service_default($password) and ! $::designate::api::keystone_password { + fail('Please set password for designate service user') + } + + $username_real = pick($::designate::api::keystone_user,$username) + $password_real = pick($::designate::api::keystone_password,$password) + $project_name_real = pick($::designate::api::keystone_tenant,$project_name) + $auth_uri_real = pick($::designate::api::auth_uri,$auth_uri) + $auth_url_real = pick($::designate::api::auth_url,$auth_url) + $memcached_servers_real = pick($::designate::api::keystone_memcached_servers,$memcached_servers) + + keystone::resource::authtoken { 'designate_config': + username => $username_real, + password => $password_real, + project_name => $project_name_real, + auth_url => $auth_url_real, + auth_uri => $auth_uri_real, + auth_version => $auth_version, + auth_type => $auth_type, + auth_section => $auth_section, + user_domain_name => $user_domain_name, + project_domain_name => $project_domain_name, + insecure => $insecure, + cache => $cache, + cafile => $cafile, + certfile => $certfile, + check_revocations_for_cached => $check_revocations_for_cached, + delay_auth_decision => $delay_auth_decision, + enforce_token_bind => $enforce_token_bind, + hash_algorithms => $hash_algorithms, + http_connect_timeout => $http_connect_timeout, + http_request_max_retries => $http_request_max_retries, + include_service_catalog => $include_service_catalog, + keyfile => $keyfile, + memcache_pool_conn_get_timeout => $memcache_pool_conn_get_timeout, + memcache_pool_dead_retry => $memcache_pool_dead_retry, + memcache_pool_maxsize => $memcache_pool_maxsize, + memcache_pool_socket_timeout => $memcache_pool_socket_timeout, + memcache_secret_key => $memcache_secret_key, + memcache_security_strategy => $memcache_security_strategy, + memcache_use_advanced_pool => $memcache_use_advanced_pool, + memcache_pool_unused_timeout => $memcache_pool_unused_timeout, + memcached_servers => $memcached_servers_real, + region_name => $region_name, + revocation_cache_time => $revocation_cache_time, + signing_dir => $signing_dir, + token_cache_time => $token_cache_time, + } +} diff --git a/releasenotes/notes/authtoken-e83781cebdc8ea4c.yaml b/releasenotes/notes/authtoken-e83781cebdc8ea4c.yaml index 330fe5b5..830e6e60 100644 --- a/releasenotes/notes/authtoken-e83781cebdc8ea4c.yaml +++ b/releasenotes/notes/authtoken-e83781cebdc8ea4c.yaml @@ -4,13 +4,14 @@ features: for Keystone v3. deprecations: - designate::api::keystone_tenant is deprecated in favor of - designate::api::project_name. + designate::keystone::authtoken::project_name. - designate::api::keystone_user is deprecated in favor of - designate::api::username. + designate::keystone::authtoken::username. - designate::api::keystone_password is deprecated in favor of - designate::api::password. + designate::keystone::authtoken::password. - designate::api::keystone_host, designate::api::keystone_port, designate::api::keystone_protocol are deprecated in favor of - designate::api::auth_uri and designate::api_auth_url. + designate::keystone::authtoken::auth_uri and + designate::keystone::authtoken::auth_url. - designate::api::keystone_memcached_servers is deprecated in favor of - designate::api::memcached_servers. + designate::keystone::authtoken::memcached_servers. diff --git a/spec/acceptance/basic_designate_spec.rb b/spec/acceptance/basic_designate_spec.rb index 6c667fc6..3caa7bb5 100644 --- a/spec/acceptance/basic_designate_spec.rb +++ b/spec/acceptance/basic_designate_spec.rb @@ -40,10 +40,12 @@ describe 'basic designate' do rabbit_host => '127.0.0.1', debug => true, } + class { '::designate::keystone::authtoken': + password => 'a_big_secret', + } class { '::designate::api': enabled => true, auth_strategy => 'keystone', - password => 'a_big_secret', } class {'::designate::central': backend_driver => 'bind9', diff --git a/spec/classes/designate_api_spec.rb b/spec/classes/designate_api_spec.rb index 5afc72c3..285fa8b7 100644 --- a/spec/classes/designate_api_spec.rb +++ b/spec/classes/designate_api_spec.rb @@ -6,11 +6,12 @@ require 'spec_helper' describe 'designate::api' do let :params do { - :username => 'designate', - :password => 'passw0rd', - :auth_uri => 'https://10.0.0.42:5000', - :auth_url => 'https://10.0.0.42:35357', - :project_name => '_services_', + :keystone_password => 'passw0rd', + :keystone_host => '10.0.0.42', + :keystone_port => '35357', + :keystone_protocol => 'https', + :keystone_tenant => '_services_', + :keystone_user => 'designate', } end @@ -38,12 +39,7 @@ describe 'designate::api' do is_expected.to contain_designate_config('service:api/api_host').with_value('0.0.0.0') is_expected.to contain_designate_config('service:api/api_port').with_value('9001') is_expected.to contain_designate_config('service:api/api_base_uri').with_value('') - is_expected.to contain_designate_config('keystone_authtoken/auth_url').with_value('https://10.0.0.42:35357') - is_expected.to contain_designate_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.42:5000') - is_expected.to contain_designate_config('keystone_authtoken/project_name').with_value('_services_') - is_expected.to contain_designate_config('keystone_authtoken/username').with_value('designate') - is_expected.to contain_designate_config('keystone_authtoken/password').with_value('passw0rd') - + is_expected.to_not contain_designate__keystone__authtoken('designate_config') end context 'when using auth against keystone' do @@ -54,7 +50,12 @@ describe 'designate::api' do end context 'when using memcached with keystone auth' do - before { params.merge!(:keystone_memcached_servers => [ '127.0.0.1:11211', '127.0.0.1:11212' ]) } + before do + params.merge!( + :keystone_memcached_servers => [ '127.0.0.1:11211', '127.0.0.1:11212' ], + :auth_strategy => 'keystone', + ) + end it 'configures designate-api with keystone memcached servers' do is_expected.to contain_designate_config('keystone_authtoken/memcached_servers').with_value('127.0.0.1:11211,127.0.0.1:11212') end @@ -78,6 +79,7 @@ describe 'designate::api' do context 'with backwards compatible parameters' do let :params do { + :auth_strategy => 'keystone', :keystone_password => 'passw0rd', :keystone_host => '10.0.0.42', :keystone_port => '35357', @@ -88,7 +90,7 @@ describe 'designate::api' do end it 'configures designate-api with correct parameters' do - is_expected.to contain_designate_config('service:api/auth_strategy').with_value('noauth') + is_expected.to contain_designate_config('service:api/auth_strategy').with_value('keystone') is_expected.to contain_designate_config('service:api/enable_api_v1').with_value(true) is_expected.to contain_designate_config('service:api/enable_api_v2').with_value(false) is_expected.to contain_designate_config('service:api/enable_api_admin').with_value(false) diff --git a/spec/classes/designate_keystone_authtoken_spec.rb b/spec/classes/designate_keystone_authtoken_spec.rb new file mode 100644 index 00000000..a48c0e50 --- /dev/null +++ b/spec/classes/designate_keystone_authtoken_spec.rb @@ -0,0 +1,144 @@ +require 'spec_helper' + +describe 'designate::keystone::authtoken' do + + let :params do + { :password => 'designate_password', } + end + + shared_examples 'designate authtoken' do + + context 'with default parameters' do + + it 'configure keystone_authtoken' do + is_expected.to contain_designate_config('keystone_authtoken/username').with_value('designate') + is_expected.to contain_designate_config('keystone_authtoken/password').with_value('designate_password') + is_expected.to contain_designate_config('keystone_authtoken/auth_url').with_value('http://localhost:35357') + is_expected.to contain_designate_config('keystone_authtoken/project_name').with_value('services') + is_expected.to contain_designate_config('keystone_authtoken/user_domain_name').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/project_domain_name').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/insecure').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/auth_section').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/auth_type').with_value('password') + is_expected.to contain_designate_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000') + is_expected.to contain_designate_config('keystone_authtoken/auth_version').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/cache').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/cafile').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/certfile').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/check_revocations_for_cached').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/delay_auth_decision').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/enforce_token_bind').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/hash_algorithms').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/http_connect_timeout').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/http_request_max_retries').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/include_service_catalog').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/keyfile').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_conn_get_timeout').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_dead_retry').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_maxsize').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_socket_timeout').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_unused_timeout').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_secret_key').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_security_strategy').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcache_use_advanced_pool').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/memcached_servers').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/region_name').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/revocation_cache_time').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/signing_dir').with_value('') + is_expected.to contain_designate_config('keystone_authtoken/token_cache_time').with_value('') + end + end + + context 'when overriding parameters' do + before do + params.merge!({ + :auth_uri => 'https://10.0.0.1:9999/', + :username => 'myuser', + :password => 'mypasswd', + :auth_url => 'https://127.0.0.1:35357', + :project_name => 'service_project', + :user_domain_name => 'domainX', + :project_domain_name => 'domainX', + :insecure => false, + :auth_section => 'new_section', + :auth_type => 'password', + :auth_version => 'v3', + :cache => 'somevalue', + :cafile => '/opt/stack/data/cafile.pem', + :certfile => 'certfile.crt', + :check_revocations_for_cached => false, + :delay_auth_decision => false, + :enforce_token_bind => 'permissive', + :hash_algorithms => 'md5', + :http_connect_timeout => '300', + :http_request_max_retries => '3', + :include_service_catalog => true, + :keyfile => 'keyfile', + :memcache_pool_conn_get_timeout => '9', + :memcache_pool_dead_retry => '302', + :memcache_pool_maxsize => '11', + :memcache_pool_socket_timeout => '2', + :memcache_pool_unused_timeout => '61', + :memcache_secret_key => 'secret_key', + :memcache_security_strategy => 'ENCRYPT', + :memcache_use_advanced_pool => true, + :memcached_servers => ['memcached01:11211','memcached02:11211'], + :region_name => 'region2', + :revocation_cache_time => '11', + :signing_dir => '/var/cache', + :token_cache_time => '301', + }) + end + + it 'configure keystone_authtoken' do + is_expected.to contain_designate_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/') + is_expected.to contain_designate_config('keystone_authtoken/username').with_value(params[:username]) + is_expected.to contain_designate_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true) + is_expected.to contain_designate_config('keystone_authtoken/auth_url').with_value(params[:auth_url]) + is_expected.to contain_designate_config('keystone_authtoken/project_name').with_value(params[:project_name]) + is_expected.to contain_designate_config('keystone_authtoken/user_domain_name').with_value(params[:user_domain_name]) + is_expected.to contain_designate_config('keystone_authtoken/project_domain_name').with_value(params[:project_domain_name]) + is_expected.to contain_designate_config('keystone_authtoken/insecure').with_value(params[:insecure]) + is_expected.to contain_designate_config('keystone_authtoken/auth_section').with_value(params[:auth_section]) + is_expected.to contain_designate_config('keystone_authtoken/auth_type').with_value(params[:auth_type]) + is_expected.to contain_designate_config('keystone_authtoken/auth_version').with_value(params[:auth_version]) + is_expected.to contain_designate_config('keystone_authtoken/cache').with_value(params[:cache]) + is_expected.to contain_designate_config('keystone_authtoken/cafile').with_value(params[:cafile]) + is_expected.to contain_designate_config('keystone_authtoken/certfile').with_value(params[:certfile]) + is_expected.to contain_designate_config('keystone_authtoken/check_revocations_for_cached').with_value(params[:check_revocations_for_cached]) + is_expected.to contain_designate_config('keystone_authtoken/delay_auth_decision').with_value(params[:delay_auth_decision]) + is_expected.to contain_designate_config('keystone_authtoken/enforce_token_bind').with_value(params[:enforce_token_bind]) + is_expected.to contain_designate_config('keystone_authtoken/hash_algorithms').with_value(params[:hash_algorithms]) + is_expected.to contain_designate_config('keystone_authtoken/http_connect_timeout').with_value(params[:http_connect_timeout]) + is_expected.to contain_designate_config('keystone_authtoken/http_request_max_retries').with_value(params[:http_request_max_retries]) + is_expected.to contain_designate_config('keystone_authtoken/include_service_catalog').with_value(params[:include_service_catalog]) + is_expected.to contain_designate_config('keystone_authtoken/keyfile').with_value(params[:keyfile]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_conn_get_timeout').with_value(params[:memcache_pool_conn_get_timeout]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_dead_retry').with_value(params[:memcache_pool_dead_retry]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_maxsize').with_value(params[:memcache_pool_maxsize]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_socket_timeout').with_value(params[:memcache_pool_socket_timeout]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_pool_unused_timeout').with_value(params[:memcache_pool_unused_timeout]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_secret_key').with_value(params[:memcache_secret_key]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_security_strategy').with_value(params[:memcache_security_strategy]) + is_expected.to contain_designate_config('keystone_authtoken/memcache_use_advanced_pool').with_value(params[:memcache_use_advanced_pool]) + is_expected.to contain_designate_config('keystone_authtoken/memcached_servers').with_value('memcached01:11211,memcached02:11211') + is_expected.to contain_designate_config('keystone_authtoken/region_name').with_value(params[:region_name]) + is_expected.to contain_designate_config('keystone_authtoken/revocation_cache_time').with_value(params[:revocation_cache_time]) + is_expected.to contain_designate_config('keystone_authtoken/signing_dir').with_value(params[:signing_dir]) + is_expected.to contain_designate_config('keystone_authtoken/token_cache_time').with_value(params[:token_cache_time]) + end + end + end + + on_supported_os({ + :supported_os => OSDefaults.get_supported_os + }).each do |os,facts| + context "on #{os}" do + let (:facts) do + facts.merge!(OSDefaults.get_facts()) + end + + it_configures 'designate authtoken' + end + end +end