From a5d78457d67e1ce894f811a4058ef53aae9623a7 Mon Sep 17 00:00:00 2001 From: Takashi Kajinami Date: Tue, 15 Dec 2020 20:20:53 +0900 Subject: [PATCH] Fix leftovers about removed v1 API Designate has already removed its v1 API, so we should deprecate and remove all parameters for it. This change also fixes the outdated default value for keystone endpoint url, which still includes '/v1'. Change-Id: I645af15a9825ad000fc951d6c8334e715e645c8a --- manifests/api.pp | 19 +++++++++++++------ manifests/keystone/auth.pp | 6 +++--- .../v1-api-removal-2812946a138e4199.yaml | 10 ++++++++++ spec/classes/designate_api_spec.rb | 3 --- spec/classes/designate_keystone_auth_spec.rb | 6 +++--- 5 files changed, 29 insertions(+), 15 deletions(-) create mode 100644 releasenotes/notes/v1-api-removal-2812946a138e4199.yaml diff --git a/manifests/api.pp b/manifests/api.pp index 9ffced86..c7c4c88f 100644 --- a/manifests/api.pp +++ b/manifests/api.pp @@ -76,10 +76,6 @@ # (optional) Show the pecan HTML based debug interface (v2 only). # Defaults to $::os_service_default # -# [*enabled_extensions_v1*] -# (optional) API Version 1 extensions. -# Defaults to $::os_service_default -# # [*enabled_extensions_v2*] # (optional) API Version 2 extensions. # Defaults to $::os_service_default @@ -88,6 +84,12 @@ # (optional) Admin API extensions. # Defaults to $::os_service_default # +# DEPRECATED PARAMETERS +# +# [*enabled_extensions_v1*] +# (optional) API Version 1 extensions. +# Defaults to $::os_service_default +# class designate::api ( $package_ensure = present, $api_package_name = $::designate::params::api_package_name, @@ -107,13 +109,19 @@ class designate::api ( $default_limit_v2 = $::os_service_default, $max_limit_v2 = $::os_service_default, $pecan_debug = $::os_service_default, - $enabled_extensions_v1 = $::os_service_default, $enabled_extensions_v2 = $::os_service_default, $enabled_extensions_admin = $::os_service_default, + # DEPRECATED PARAMETERS + $enabled_extensions_v1 = undef, ) inherits designate { include designate::deps + if $enabled_extensions_v1 != undef { + warning('The enabled_extensions_v1 parameter has been deprecated and has \ +no effect now') + } + # API Service designate_config { 'service:api/listen' : value => $listen; @@ -130,7 +138,6 @@ class designate::api ( 'service:api/default_limit_v2' : value => $default_limit_v2; 'service:api/max_limit_v2' : value => $max_limit_v2; 'service:api/pecan_debug' : value => $pecan_debug; - 'service:api/enabled_extensions_v1' : value => $enabled_extensions_v1; 'service:api/enabled_extensions_v2' : value => $enabled_extensions_v2; 'service:api/enabled_extensions_admin' : value => $enabled_extensions_admin; } diff --git a/manifests/keystone/auth.pp b/manifests/keystone/auth.pp index 62f7e24f..467adeae 100644 --- a/manifests/keystone/auth.pp +++ b/manifests/keystone/auth.pp @@ -82,9 +82,9 @@ class designate::keystone::auth ( $configure_user = true, $configure_user_role = true, $configure_endpoint = true, - $public_url = 'http://127.0.0.1:9001/v1', - $admin_url = 'http://127.0.0.1:9001/v1', - $internal_url = 'http://127.0.0.1:9001/v1', + $public_url = 'http://127.0.0.1:9001', + $admin_url = 'http://127.0.0.1:9001', + $internal_url = 'http://127.0.0.1:9001', ) { include designate::deps diff --git a/releasenotes/notes/v1-api-removal-2812946a138e4199.yaml b/releasenotes/notes/v1-api-removal-2812946a138e4199.yaml new file mode 100644 index 00000000..651d2014 --- /dev/null +++ b/releasenotes/notes/v1-api-removal-2812946a138e4199.yaml @@ -0,0 +1,10 @@ +--- +features: + - | + The ``designate::api::enabled_extensions_v1`` parameter has been deprecated + and has no effect. This parmaeter will be removed in a future release. + +upgrade: + - | + The keystone endpoint urls no longer include ``/v1`` by default, since + v1 API was already removed from Designate. diff --git a/spec/classes/designate_api_spec.rb b/spec/classes/designate_api_spec.rb index 588a193e..a0ee5085 100644 --- a/spec/classes/designate_api_spec.rb +++ b/spec/classes/designate_api_spec.rb @@ -46,7 +46,6 @@ describe 'designate::api' do is_expected.to contain_designate_config('service:api/default_limit_v2').with_value('') is_expected.to contain_designate_config('service:api/max_limit_v2').with_value('') is_expected.to contain_designate_config('service:api/pecan_debug').with_value('') - is_expected.to contain_designate_config('service:api/enabled_extensions_v1').with_value('') is_expected.to contain_designate_config('service:api/enabled_extensions_v2').with_value('') is_expected.to contain_designate_config('service:api/enabled_extensions_admin').with_value('') is_expected.to_not contain_designate__keystone__authtoken('designate_config') @@ -70,7 +69,6 @@ describe 'designate::api' do :default_limit_v2 => '25', :max_limit_v2 => '1500', :pecan_debug => true, - :enabled_extensions_v1 => 'diagnostics,quotas,reports,sync,touch', :enabled_extensions_v2 => 'experimental', :enabled_extensions_admin => 'reports,quotas,counts,tenants,target_sync', }) @@ -91,7 +89,6 @@ describe 'designate::api' do is_expected.to contain_designate_config('service:api/default_limit_v2').with_value(params[:default_limit_v2]) is_expected.to contain_designate_config('service:api/max_limit_v2').with_value(params[:max_limit_v2]) is_expected.to contain_designate_config('service:api/pecan_debug').with_value(params[:pecan_debug]) - is_expected.to contain_designate_config('service:api/enabled_extensions_v1').with_value(params[:enabled_extensions_v1]) is_expected.to contain_designate_config('service:api/enabled_extensions_v2').with_value(params[:enabled_extensions_v2]) is_expected.to contain_designate_config('service:api/enabled_extensions_admin').with_value(params[:enabled_extensions_admin]) end diff --git a/spec/classes/designate_keystone_auth_spec.rb b/spec/classes/designate_keystone_auth_spec.rb index 5317521a..8a7f2f03 100644 --- a/spec/classes/designate_keystone_auth_spec.rb +++ b/spec/classes/designate_keystone_auth_spec.rb @@ -28,9 +28,9 @@ describe 'designate::keystone::auth' do it { is_expected.to contain_keystone_endpoint('RegionOne/designate::dns').with( :ensure => 'present', - :public_url => "http://127.0.0.1:9001/v1", - :admin_url => "http://127.0.0.1:9001/v1", - :internal_url => "http://127.0.0.1:9001/v1" + :public_url => "http://127.0.0.1:9001", + :admin_url => "http://127.0.0.1:9001", + :internal_url => "http://127.0.0.1:9001" ) } end