feat(cli,build): remove deprecated variables GMS_HOST/_PORT (#5451)

docker/datahub-actions/env/docker.env

@@ -1,7 +1,3 @@
-# Deprecated
-GMS_HOST=datahub-gms
-GMS_PORT=8080
-# use these instead
 DATAHUB_GMS_HOST=datahub-gms
 DATAHUB_GMS_PORT=8080
 

docker/datahub-mae-consumer/env/docker-without-neo4j.env

@@ -1,7 +1,3 @@
-# Deprecated
-GMS_HOST=datahub-gms
-GMS_PORT=8080
-# use these instead
 DATAHUB_GMS_HOST=datahub-gms
 DATAHUB_GMS_PORT=8080
 

docker/datahub-mae-consumer/env/docker.env

@@ -1,7 +1,3 @@
-# Deprecated
-GMS_HOST=datahub-gms
-GMS_PORT=8080
-# use these instead
 DATAHUB_GMS_HOST=datahub-gms
 DATAHUB_GMS_PORT=8080
 

docker/datahub-mce-consumer/env/docker.env

@@ -2,9 +2,7 @@ MCE_CONSUMER_ENABLED=true
 KAFKA_BOOTSTRAP_SERVER=broker:29092
 KAFKA_SCHEMAREGISTRY_URL=http://schema-registry:8081
 DATAHUB_GMS_HOST=datahub-gms
-GMS_HOST=datahub-gms
 DATAHUB_GMS_PORT=8080
-GMS_PORT=8080
 
 # Uncomment to configure kafka topic names
 # Make sure these names are consistent across the whole deployment

docker/quickstart/docker-compose-without-neo4j-m1.quickstart.yml

@@ -23,9 +23,7 @@ services:
       - datahub-gms
     environment:
       - DATAHUB_GMS_HOST=datahub-gms
-      - GMS_HOST=datahub-gms
       - DATAHUB_GMS_PORT=8080
-      - GMS_PORT=8080
       - KAFKA_BOOTSTRAP_SERVER=broker:29092
       - SCHEMA_REGISTRY_URL=http://schema-registry:8081
       - METADATA_AUDIT_EVENT_NAME=MetadataAuditEvent_v4

docker/quickstart/docker-compose-without-neo4j.quickstart.yml

@@ -23,8 +23,6 @@ services:
     depends_on:
     - datahub-gms
     environment:
-    - GMS_HOST=datahub-gms
-    - GMS_PORT=8080
     - DATAHUB_GMS_HOST=datahub-gms
     - DATAHUB_GMS_PORT=8080
     - KAFKA_BOOTSTRAP_SERVER=broker:29092

docker/quickstart/docker-compose.quickstart.yml

@@ -24,8 +24,6 @@ services:
     depends_on:
     - datahub-gms
     environment:
-    - GMS_HOST=datahub-gms
-    - GMS_PORT=8080
     - DATAHUB_GMS_HOST=datahub-gms
     - DATAHUB_GMS_PORT=8080
     - KAFKA_BOOTSTRAP_SERVER=broker:29092

docs/how/updating-datahub.md

@@ -5,6 +5,7 @@ This file documents any backwards-incompatible changes in DataHub and assists pe
 ## Next
 
 ### Breaking Changes
+-  #5451 `GMS_HOST` and `GMS_PORT` environment variables deprecated in `v0.8.39` have been removed. Use `DATAHUB_GMS_HOST` and `DATAHUB_GMS_PORT` instead.
 
 ### Potential Downtime
 

metadata-ingestion/src/datahub/cli/cli_utils.py

@@ -70,8 +70,6 @@ ENV_METADATA_HOST_URL = "DATAHUB_GMS_URL"
 ENV_METADATA_HOST = "DATAHUB_GMS_HOST"
 ENV_METADATA_PORT = "DATAHUB_GMS_PORT"
 ENV_METADATA_PROTOCOL = "DATAHUB_GMS_PROTOCOL"
-ENV_METADATA_HOST_DEPRECATED = "GMS_HOST"
-ENV_METADATA_PORT_DEPRECATED = "GMS_PORT"
 ENV_METADATA_TOKEN = "DATAHUB_GMS_TOKEN"
 ENV_DATAHUB_SYSTEM_CLIENT_ID = "DATAHUB_SYSTEM_CLIENT_ID"
 ENV_DATAHUB_SYSTEM_CLIENT_SECRET = "DATAHUB_SYSTEM_CLIENT_SECRET"
@@ -144,12 +142,8 @@ def get_details_from_config():
 
 
 def get_details_from_env() -> Tuple[Optional[str], Optional[str]]:
-    host = os.environ.get(ENV_METADATA_HOST) or os.environ.get(
+    host = os.environ.get(ENV_METADATA_HOST)
-        ENV_METADATA_HOST_DEPRECATED
+    port = os.environ.get(ENV_METADATA_PORT)
-    )
-    port = os.environ.get(ENV_METADATA_PORT) or os.environ.get(
-        ENV_METADATA_PORT_DEPRECATED
-    )
     token = os.environ.get(ENV_METADATA_TOKEN)
     protocol = os.environ.get(ENV_METADATA_PROTOCOL, "http")
     url = os.environ.get(ENV_METADATA_HOST_URL)

metadata-ingestion/tests/unit/test_cli_utils.py

@@ -59,13 +59,3 @@ def test_correct_url_when_gms_host_port_url_protocol_set():
 )
 def test_correct_url_when_url_set():
     assert cli_utils.get_details_from_env() == ("https://example.com", None)
-
-
-@mock.patch.dict(
-    os.environ,
-    {
-        "GMS_HOST": "https://example.com",
-    },
-)
-def test_correct_url_when_deprecated_host_env_set():
-    assert cli_utils.get_details_from_env() == ("https://example.com", None)

metadata-service/factories/src/main/resources/application.yml

@@ -56,8 +56,8 @@ secretService:
 datahub:
   serverType: ${DATAHUB_SERVER_TYPE:prod}
   gms:
-    host: ${DATAHUB_GMS_HOST:${GMS_HOST:localhost}}
+    host: ${DATAHUB_GMS_HOST:localhost}
-    port: ${DATAHUB_GMS_PORT:${GMS_PORT:8080}}
+    port: ${DATAHUB_GMS_PORT:8080}
     useSSL: ${DATAHUB_GMS_USE_SSL:${GMS_USE_SSL:false}}
     sslContext:
       protocol: ${DATAHUB_GMS_SSL_PROTOCOL:${GMS_SSL_PROTOCOL:#{null}}}