From 415d4de0884a691a01f14e7954aadc203e033a8b Mon Sep 17 00:00:00 2001
From: Emilien Macchi <emilien@redhat.com>
Date: Mon, 9 Dec 2019 18:19:51 -0500
Subject: [PATCH] swift-external: deprecate External*Url

ExternalPublicUrl (and the 2 others) are too generic to know that they
are for Swift only.
Let's rename them and deprecate the old ones.

This patch does the following:
ExternalPublicUrl, ExternalAdminUrl and ExternalInternalUrl are deprecated.
ExternalSwiftPublicUrl, ExternalSwiftAdminUrl and ExternalSwiftInternalUrl
should now be used.

Change-Id: I4634447762aad20f2c450fe4bb7f0803d13efec2
---
 ...external-swift-proxy-baremetal-puppet.yaml | 51 +++++++++++++++++--
 environments/swift-external.yaml              |  6 +--
 .../swift_external-d9870450f191b89a.yaml      |  6 +++
 3 files changed, 55 insertions(+), 8 deletions(-)
 create mode 100644 releasenotes/notes/swift_external-d9870450f191b89a.yaml

diff --git a/deployment/swift/external-swift-proxy-baremetal-puppet.yaml b/deployment/swift/external-swift-proxy-baremetal-puppet.yaml
index 39b93f91c1..07550be067 100644
--- a/deployment/swift/external-swift-proxy-baremetal-puppet.yaml
+++ b/deployment/swift/external-swift-proxy-baremetal-puppet.yaml
@@ -31,12 +31,24 @@ parameters:
                  via parameter_defaults in the resource registry.
     type: json
   ExternalPublicUrl:
+    description: (DEPRECATED) Public endpoint url for the external swift proxy
+    type: string
+    default: 'deprecated'
+  ExternalInternalUrl:
+    description: (DEPRECATED) Internal endpoint url for the external swift proxy
+    type: string
+    default: 'deprecated'
+  ExternalAdminUrl:
+    description: (DEPRECATED) External endpoint url for the external swift proxy
+    type: string
+    default: 'deprecated'
+  ExternalSwiftPublicUrl:
     description: Public endpoint url for the external swift proxy
     type: string
-  ExternalInternalUrl:
+  ExternalSwiftInternalUrl:
     description: Internal endpoint url for the external swift proxy
     type: string
-  ExternalAdminUrl:
+  ExternalSwiftAdminUrl:
     description: External endpoint url for the external swift proxy
     type: string
   ExternalSwiftUserTenant:
@@ -52,8 +64,25 @@ parameters:
     default: 'regionOne'
     description: Keystone region for endpoint
 
+parameter_groups:
+- label: deprecated
+  description: |
+   The following parameters are deprecated and will be removed. They should not
+   be relied on for new deployments. If you have concerns regarding deprecated
+   parameters, please contact the TripleO development team on IRC or the
+   OpenStack mailing list.
+  parameters:
+  - ExternalAdminUrl
+  - ExternalInternalUrl
+  - ExternalPublicUrl
+
 resources:
 
+conditions:
+  deprecated_external_admin_url: {not: {equals: [{get_param: ExternalAdminUrl}, 'deprecated']}}
+  deprecated_external_internal_url: {not: {equals: [{get_param: ExternalInternalUrl}, 'deprecated']}}
+  deprecated_external_public_url: {not: {equals: [{get_param: ExternalPublicUrl}, 'deprecated']}}
+
 outputs:
   role_data:
     description: Role data for External Swift proxy.
@@ -65,9 +94,21 @@ outputs:
 
       service_config_settings:
         keystone:
-          swift::keystone::auth::public_url: {get_param: ExternalPublicUrl}
-          swift::keystone::auth::internal_url: {get_param: ExternalInternalUrl}
-          swift::keystone::auth::admin_url: {get_param: ExternalAdminUrl}
+          swift::keystone::auth::public_url:
+            if:
+            - deprecated_external_public_url
+            - {get_param: ExternalPublicUrl}
+            - {get_param: ExternalSwiftPublicUrl}
+          swift::keystone::auth::internal_url:
+            if:
+            - deprecated_external_internal_url
+            - {get_param: ExternalInternalUrl}
+            - {get_param: ExternalSwiftInternalUrl}
+          swift::keystone::auth::admin_url:
+            if:
+            - deprecated_external_admin_url
+            - {get_param: ExternalAdminUrl}
+            - {get_param: ExternalSwiftAdminUrl}
           swift::keystone::auth::public_url_s3: ''
           swift::keystone::auth::internal_url_s3: ''
           swift::keystone::auth::admin_url_s3: ''
diff --git a/environments/swift-external.yaml b/environments/swift-external.yaml
index 9e76cda8b2..97cae811bb 100644
--- a/environments/swift-external.yaml
+++ b/environments/swift-external.yaml
@@ -5,8 +5,8 @@ resource_registry:
   OS::TripleO::Services::SwiftRingBuilder: OS::Heat::None
 
 parameter_defaults:
-  ExternalPublicUrl: 'http://swiftproxy:9024/v1/%(tenant_id)s'
-  ExternalInternalUrl: 'http://swiftproxy:9024/v1/%(tenant_id)s'
-  ExternalAdminUrl: 'http://swiftproxy:9024/v1/%(tenant_id)s'
+  ExternalSwiftPublicUrl: 'http://swiftproxy:9024/v1/%(tenant_id)s'
+  ExternalSwiftInternalUrl: 'http://swiftproxy:9024/v1/%(tenant_id)s'
+  ExternalSwiftAdminUrl: 'http://swiftproxy:9024/v1/%(tenant_id)s'
   ExternalSwiftUserTenant: 'service'
 
diff --git a/releasenotes/notes/swift_external-d9870450f191b89a.yaml b/releasenotes/notes/swift_external-d9870450f191b89a.yaml
new file mode 100644
index 0000000000..b3ba0bbeb1
--- /dev/null
+++ b/releasenotes/notes/swift_external-d9870450f191b89a.yaml
@@ -0,0 +1,6 @@
+---
+deprecations:
+  - |
+    ExternalPublicUrl, ExternalAdminUrl and ExternalInternalUrl are deprecated.
+    ExternalSwiftPublicUrl, ExternalSwiftAdminUrl and ExternalSwiftInternalUrl
+    should now be used.