From 6ed31ddf8f56d52292a0618fcee47cccb8706c0b Mon Sep 17 00:00:00 2001
From: David Culley <6276049+davidculley@users.noreply.github.com>
Date: Sat, 9 Nov 2024 05:57:57 +0100
Subject: [PATCH 1/3] add warning about renaming connections
---
.../docs/cloud/connect-data-platform/about-connections.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/website/docs/docs/cloud/connect-data-platform/about-connections.md b/website/docs/docs/cloud/connect-data-platform/about-connections.md
index 89dd13808ec..e3952938f0a 100644
--- a/website/docs/docs/cloud/connect-data-platform/about-connections.md
+++ b/website/docs/docs/cloud/connect-data-platform/about-connections.md
@@ -64,6 +64,10 @@ However, to fully utilize the value of account-level connections, you may have t
+:::warning Renaming connections changes the public SSH key if connecting via a SSH tunnel
+For Redshift, PostgreSQL, and AlloyDB databases, for which you might need to [connect via a SSH tunnel](https://docs.getdbt.com/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb#connecting-via-an-ssh-tunnel), you need to copy the auto-generated public SSH key to the Bastion server to authorize dbt Cloud to connect to your database via the Bastion server. The Bastion server could be an instance running on AWS EC2 in the case of Redshift. Renaming a connection in dbt Cloud will change the public SSH key for this connection. Meaning **your dbt Cloud jobs will all fail as long as you don't copy the newly generated public SSH key to the Bastion server.** If you don't have access to that Bastion server, don't rename the connections in dbt Cloud. Otherwise your jobs won't be able to run anymore.
+:::
+
Please consider the following actions, as the steps you take will depend on the desired outcome.
- The initial clean-up of your connection list
From 1e7917313536f721bb8780d0b0af590faba5327b Mon Sep 17 00:00:00 2001
From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Date: Thu, 14 Nov 2024 13:21:17 -0500
Subject: [PATCH 2/3] Update about-connections.md
Changing to footnote
---
.../docs/cloud/connect-data-platform/about-connections.md | 8 +++-----
1 file changed, 3 insertions(+), 5 deletions(-)
diff --git a/website/docs/docs/cloud/connect-data-platform/about-connections.md b/website/docs/docs/cloud/connect-data-platform/about-connections.md
index ed4a32dacaa..bfec139a4d6 100644
--- a/website/docs/docs/cloud/connect-data-platform/about-connections.md
+++ b/website/docs/docs/cloud/connect-data-platform/about-connections.md
@@ -64,15 +64,11 @@ However, to fully utilize the value of account-level connections, you may have t
-:::warning Renaming connections changes the public SSH key if connecting via a SSH tunnel
-For Redshift, PostgreSQL, and AlloyDB databases, for which you might need to [connect via a SSH tunnel](https://docs.getdbt.com/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb#connecting-via-an-ssh-tunnel), you need to copy the auto-generated public SSH key to the Bastion server to authorize dbt Cloud to connect to your database via the Bastion server. The Bastion server could be an instance running on AWS EC2 in the case of Redshift. Renaming a connection in dbt Cloud will change the public SSH key for this connection. Meaning **your dbt Cloud jobs will all fail as long as you don't copy the newly generated public SSH key to the Bastion server.** If you don't have access to that Bastion server, don't rename the connections in dbt Cloud. Otherwise your jobs won't be able to run anymore.
-:::
-
Please consider the following actions, as the steps you take will depend on the desired outcome.
- The initial clean-up of your connection list
- Delete unused connections with 0 environments.
- - Rename connections with a temporary, descriptive naming scheme to better understand where each is used
+ - Rename connections with a temporary, descriptive naming scheme to better understand where each is used [^1]
@@ -105,3 +101,5 @@ dbt Cloud will always connect to your data platform from the IP addresses specif
Be sure to allow traffic from these IPs in your firewall, and include them in any database grants.
Allowing these IP addresses only enables the connection to your . However, you might want to send API requests from your restricted network to the dbt Cloud API. Using the dbt Cloud API requires allowing the `cloud.getdbt.com` subdomain. For more on the dbt Cloud architecture, see [Deployment architecture](/docs/cloud/about-cloud/architecture).
+
+[^1] Renaming Redshift, PostgreSQL, and AlloyDB connections that use an [SSH tunnel](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb#connecting-via-an-ssh-tunnel) changes the public SSH key. You must copy the new SSH key to the Bastion server, or your jobs will fail. We recommend against renaming connections in this scenario to prevent service disruptions.
From 9942a47f2487f62ed1da9502698521d7049748ee Mon Sep 17 00:00:00 2001
From: Matt Shaver <60105315+matthewshaver@users.noreply.github.com>
Date: Thu, 14 Nov 2024 13:53:25 -0500
Subject: [PATCH 3/3] Update
website/docs/docs/cloud/connect-data-platform/about-connections.md
---
.../docs/docs/cloud/connect-data-platform/about-connections.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/docs/docs/cloud/connect-data-platform/about-connections.md b/website/docs/docs/cloud/connect-data-platform/about-connections.md
index bfec139a4d6..8e1100c1f95 100644
--- a/website/docs/docs/cloud/connect-data-platform/about-connections.md
+++ b/website/docs/docs/cloud/connect-data-platform/about-connections.md
@@ -102,4 +102,4 @@ Be sure to allow traffic from these IPs in your firewall, and include them in an
Allowing these IP addresses only enables the connection to your . However, you might want to send API requests from your restricted network to the dbt Cloud API. Using the dbt Cloud API requires allowing the `cloud.getdbt.com` subdomain. For more on the dbt Cloud architecture, see [Deployment architecture](/docs/cloud/about-cloud/architecture).
-[^1] Renaming Redshift, PostgreSQL, and AlloyDB connections that use an [SSH tunnel](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb#connecting-via-an-ssh-tunnel) changes the public SSH key. You must copy the new SSH key to the Bastion server, or your jobs will fail. We recommend against renaming connections in this scenario to prevent service disruptions.
+[^1]: Renaming Redshift, PostgreSQL, and AlloyDB connections that use an [SSH tunnel](/docs/cloud/connect-data-platform/connect-redshift-postgresql-alloydb#connecting-via-an-ssh-tunnel) changes the public SSH key. You must copy the new SSH key to the Bastion server, or your jobs will fail. We recommend against renaming connections in this scenario to prevent service disruptions.