Deprecate ineffective watcher_client_default_domain_name parameter

The parameter has never been implemented actually and has had no effect
since the module was initially created. Because the default_domain_name
parameter is not generally used in the other modules, this change
deprecates the parameter instead of implementing the logic to use it.

Change-Id: I16d87e403d7412831704c5d683599764bad3c882
This commit is contained in:
Takashi Kajinami 2022-03-04 03:02:42 +09:00
parent c507b55112
commit 3fe4b7d3a0
2 changed files with 16 additions and 7 deletions

View File

@ -57,12 +57,6 @@
# API endpoint to represent SSL termination URL with 'public_endpoint' option.
# Defaults to $::os_service_default.
#
# [*watcher_client_default_domain_name*]
# (Optional)domain name to use with v3 API and v2 parameters. It will
# be used for both the user and project domain in v3 and ignored in v2
# authentication.
# Defaults to $::os_service_default
#
# [*watcher_client_project_name*]
# (Optional) Service project name.
# Defaults to 'services'
@ -163,6 +157,12 @@
# (Optional) Public Identity API endpoint.
# Defaults to undef
#
# [*watcher_client_default_domain_name*]
# (Optional)domain name to use with v3 API and v2 parameters. It will
# be used for both the user and project domain in v3 and ignored in v2
# authentication.
# Defaults to undef
#
class watcher::api (
$watcher_client_password,
$watcher_client_username = 'watcher',
@ -175,7 +175,6 @@ class watcher::api (
$bind_host = '0.0.0.0',
$workers = $::os_workers,
$enable_ssl_api = $::os_service_default,
$watcher_client_default_domain_name = $::os_service_default,
$watcher_client_project_name = 'services',
$watcher_client_certfile = $::os_service_default,
$watcher_client_cafile = $::os_service_default,
@ -197,6 +196,7 @@ class watcher::api (
$watcher_api_workers = undef,
$watcher_api_enable_ssl_api = undef,
$watcher_client_auth_uri = undef,
$watcher_client_default_domain_name = undef,
) inherits watcher::params {
include watcher::policy
@ -305,4 +305,8 @@ as a standalone service, or httpd for being run by a httpd server")
'watcher_clients_auth/auth_uri': ensure => absent;
}
if $watcher_client_default_domain_name != undef {
warning('The watcher_client_default_domain_name parameter is deprecated and has no effect.')
}
}

View File

@ -0,0 +1,5 @@
---
deprecations:
- |
The ``watcher::api::watcher_client_default_domain_name`` parameter has been
deprecated. The parameter has never been used actually.