openstack/puppet-trove
Code Issues Proposed changes

Deprecate auth_uri option

Browse Source 
Option auth_uri from group keystone_authtoken is deprecated[1].
Use option www_authenticate_uri from group keystone_authtoken.

[1]https://review.openstack.org/#/c/508522/

Change-Id: If7049561c6a9e94fc5074112db9597cd8cb6996e
Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316
Depends-On: I0dd36ef1f1f5dcdc57413736ecb8f2555712c36d
Closes-Bug: #1759098
This commit is contained in:
ZhongShengping 2018-04-03 16:55:04 +08:00 committed by Tobias Urdin
parent 2a99e642d8
commit 4e3341f589
5 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/puppet/provider/trove.rb
View File

@ -26,7 +26,7 @@ class Puppet::Provider::Trove < Puppet::Provider
end
def self.get_trove_credentials
auth_keys = ['auth_uri', 'project_name', 'username', 'password',
auth_keys = ['www_authenticate_uri', 'project_name', 'username', 'password',
'project_domain_name', 'user_domain_name']
conf = trove_conf
if conf and conf['keystone_authtoken'] and
@ -54,7 +54,7 @@ correctly configured.")
def self.auth_trove(*args)
q = trove_credentials
authenv = {
:OS_AUTH_URL => q['auth_uri'],
:OS_AUTH_URL => q['www_authenticate_uri'],
:OS_USERNAME => q['username'],
:OS_PROJECT_NAME => q['project_name'],
:OS_PASSWORD => q['password'],

4
manifests/api.pp
View File

@ -188,7 +188,9 @@ class trove::api(
if $auth_strategy == 'keystone' {
include ::trove::keystone::authtoken
$trove_auth_url = "${regsubst($::trove::keystone::authtoken::auth_uri, '(\/v3$|\/v2.0$|\/$)', '')}/v3"
# TODO(tobasco): Remove pick when deprecated auth_url is removed and only use www_authenticate_url
$trove_auth_url_pick = pick($::trove::keystone::authtoken::auth_uri, $::trove::keystone::authtoken::www_authenticate_uri)
$trove_auth_url = "${regsubst($trove_auth_url_pick, '(\/v3$|\/v2.0$|\/$)', '')}/v3"
trove_config {
'DEFAULT/trove_auth_url' : value => $trove_auth_url;
}

19
manifests/keystone/authtoken.pp
View File

@ -42,7 +42,7 @@
# (Optional) Authentication type to load
# Defaults to 'password'
#
# [*auth_uri*]
# [*www_authenticate_uri*]
# (Optional) Complete public Identity API endpoint.
# Defaults to 'http://localhost:5000'.
#
@ -183,6 +183,12 @@
# (in seconds). Set to -1 to disable caching completely. Integer value
# Defaults to $::os_service_default.
#
# DEPRECATED PARAMETERS
#
# [*auth_uri*]
# (Optional) Complete public Identity API endpoint.
# Defaults to undef
#
class trove::keystone::authtoken(
$username = 'trove',
$password = $::os_service_default,
@ -193,7 +199,7 @@ class trove::keystone::authtoken(
$insecure = $::os_service_default,
$auth_section = $::os_service_default,
$auth_type = 'password',
$auth_uri = 'http://localhost:5000',
$www_authenticate_uri = 'http://localhost:5000',
$auth_version = $::os_service_default,
$cache = $::os_service_default,
$cafile = $::os_service_default,
@ -218,6 +224,8 @@ class trove::keystone::authtoken(
$manage_memcache_package = false,
$region_name = $::os_service_default,
$token_cache_time = $::os_service_default,
# DEPRECATED PARAMETERS
$auth_uri = undef,
) {
include ::trove::deps
@ -226,12 +234,17 @@ class trove::keystone::authtoken(
fail('Please set password for trove service user')
}
if $auth_uri {
warning('The auth_uri parameter is deprecated. Please use www_authenticate_uri instead.')
}
$www_authenticate_uri_real = pick($auth_uri, $www_authenticate_uri)
keystone::resource::authtoken { 'trove_config':
username => $username,
password => $password,
project_name => $project_name,
auth_url => $auth_url,
auth_uri => $auth_uri,
www_authenticate_uri => $www_authenticate_uri_real,
auth_version => $auth_version,
auth_type => $auth_type,
auth_section => $auth_section,

4
releasenotes/notes/deprecate_auth_uri_parameter-87ffc735509a6e7c.yaml Normal file
View File

@ -0,0 +1,4 @@
---
deprecations:
- auth_uri is deprecated and will be removed in a future release.
Please use www_authenticate_uri instead.

6
spec/classes/trove_keystone_authtoken_spec.rb
View File

@ -20,7 +20,7 @@ describe 'trove::keystone::authtoken' do
is_expected.to contain_trove_config('keystone_authtoken/insecure').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/auth_section').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/auth_type').with_value('password')
is_expected.to contain_trove_config('keystone_authtoken/auth_uri').with_value('http://localhost:5000')
is_expected.to contain_trove_config('keystone_authtoken/www_authenticate_uri').with_value('http://localhost:5000')
is_expected.to contain_trove_config('keystone_authtoken/auth_version').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/cache').with_value('<SERVICE DEFAULT>')
is_expected.to contain_trove_config('keystone_authtoken/cafile').with_value('<SERVICE DEFAULT>')
@ -50,7 +50,7 @@ describe 'trove::keystone::authtoken' do
context 'when overriding parameters' do
before do
params.merge!({
:auth_uri => 'https://10.0.0.1:9999/',
:www_authenticate_uri => 'https://10.0.0.1:9999/',
:username => 'myuser',
:password => 'mypasswd',
:auth_url => 'http://:127.0.0.1:35357',
@ -88,7 +88,7 @@ describe 'trove::keystone::authtoken' do
end
it 'configure keystone_authtoken' do
is_expected.to contain_trove_config('keystone_authtoken/auth_uri').with_value('https://10.0.0.1:9999/')
is_expected.to contain_trove_config('keystone_authtoken/www_authenticate_uri').with_value('https://10.0.0.1:9999/')
is_expected.to contain_trove_config('keystone_authtoken/username').with_value(params[:username])
is_expected.to contain_trove_config('keystone_authtoken/password').with_value(params[:password]).with_secret(true)
is_expected.to contain_trove_config('keystone_authtoken/auth_url').with_value(params[:auth_url])