openstack/puppet-cinder
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: I7072db60688fdafe122c1a9fd2b06f21f0a695e5
Depends-On: I4c82a63baabd6b9304b302c97cd751a0103d8316
Closes-Bug: #1759098
This commit is contained in:
ZhongShengping 2018-04-03 16:54:59 +08:00
parent e7142cd57b
commit e916d71a07
6 changed files with 36 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -52,7 +52,7 @@ class Puppet::Provider::Cinder < Puppet::Provider::Openstack
end end
def self.get_cinder_credentials def self.get_cinder_credentials
auth_keys = ['auth_uri', 'project_name', 'username', auth_keys = ['www_authenticate_uri', 'project_name', 'username',
'password'] 'password']
conf = cinder_conf conf = cinder_conf
if conf and conf['keystone_authtoken'] and if conf and conf['keystone_authtoken'] and
@ -82,7 +82,7 @@ class Puppet::Provider::Cinder < Puppet::Provider::Openstack
def self.get_auth_endpoint def self.get_auth_endpoint
q = cinder_credentials q = cinder_credentials
"#{q['auth_uri']}" "#{q['www_authenticate_uri']}"
end end
def self.auth_endpoint def self.auth_endpoint

2
manifests/api.pp
View File

@ -363,7 +363,7 @@ running as a standalone service, or httpd for being run by a httpd server")
$defaults = { $defaults = {
'cinder-api' => { 'cinder-api' => {
# lint:ignore:140chars # lint:ignore:140chars
'command' => "cinder --os-auth-url ${::cinder::keystone::authtoken::auth_uri} --os-project-name ${keystone_project_name} --os-username ${keystone_username} --os-password ${keystone_password} list", 'command' => "cinder --os-auth-url ${::cinder::keystone::authtoken::www_authenticate_uri} --os-project-name ${keystone_project_name} --os-username ${keystone_username} --os-password ${keystone_password} list",
# lint:endignore # lint:endignore
} }
} }

19
manifests/keystone/authtoken.pp
View File

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

4
releasenotes/notes/deprecate_auth_uri_parameter-a30b9e7c7d8cee38.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/cinder_keystone_authtoken_spec.rb
View File

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

4
spec/unit/provider/cinder_spec.rb
View File

@ -24,7 +24,7 @@ describe Puppet::Provider::Cinder do
it 'should read conf file with all sections' do it 'should read conf file with all sections' do
creds_hash = { creds_hash = {
'auth_uri' => 'https://192.168.56.210:35357/v2.0/', 'www_authenticate_uri' => 'https://192.168.56.210:35357/v2.0/',
'project_name' => 'admin_tenant', 'project_name' => 'admin_tenant',
'username' => 'admin', 'username' => 'admin',
'password' => 'password', 'password' => 'password',
@ -33,7 +33,7 @@ describe Puppet::Provider::Cinder do
} }
mock = { mock = {
'keystone_authtoken' => { 'keystone_authtoken' => {
'auth_uri' => 'https://192.168.56.210:35357/v2.0/', 'www_authenticate_uri' => 'https://192.168.56.210:35357/v2.0/',
'project_name' => 'admin_tenant', 'project_name' => 'admin_tenant',
'username' => 'admin', 'username' => 'admin',
'password' => 'password', 'password' => 'password',