Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add callout to PrivateLink docs about Environment Variables #4701

Merged

Conversation

ryancharris
Copy link
Contributor

@ryancharris ryancharris commented Jan 3, 2024

What are you changing in this pull request and why?

This PR adds a callout snippet regarding the limitation in terms of using custom Environment Variables to populate the hostname of a PrivateLink endpoint (for the warehouses that support it). This is not supported in dbt Cloud and the suggested workaround is to use Extended Attributes.

Instructions were updated for:

  • Databricks
  • Redshift
  • Postgres

Instructions were not updated for:

  • Snowflake
  • VCS

MUL-512

image

Checklist

@ryancharris ryancharris requested a review from a team as a code owner January 3, 2024 19:02
Copy link

welcome bot commented Jan 3, 2024

Hello!👋 Thanks for contributing to the dbt product documentation and opening this pull request! ✨
We use Markdown and some HTML to write the dbt product documentation. When writing content, you can use our style guide and content types to understand our writing standards and how we organize information in the dbt product docs.
We'll review your contribution and respond as soon as we can. 😄

Copy link

vercel bot commented Jan 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 4, 2024 5:35pm

@runleonarun runleonarun added the new contributor Label for first-time contributors label Jan 3, 2024
@github-actions github-actions bot added content Improvements or additions to content size: small This change will take 1 to 2 days to address and removed new contributor Label for first-time contributors labels Jan 3, 2024
Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm @ryancharris! made some very small tweaks and thank you so much for opening up your very first PR and using the partials ✨ ! let me know if you have any thoughts and will get this merged for you!

@mirnawong1
Copy link
Contributor

approved from the docs side, however this PR needs to be reviewed and approved by the other multi-cell teammates.

Copy link
Contributor

@aaronbini aaronbini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryancharris this looks good, thanks for updating this! I believe we can add this snippet for Snowflake too?

Edit: Extended attributes will work for Snowflake, however the field that would get updated is account rather than hostname.

@ryancharris ryancharris force-pushed the ryancharris/add-pl-custom-env-var-restriction-callout branch from 0b3ee2d to 39c6248 Compare January 3, 2024 21:15
@@ -0,0 +1,5 @@
:::caution Environment variables

Using [Environment variables](/docs/build/environment-variables) when configuring PrivateLink endpoints isn't supported in dbt Cloud. Instead, use [Extended Attributes](/docs/deploy/deploy-environments#extended-attributes) to dynamically change these values in your dbt Cloud environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only sorta true, since it technically works in ST. There's some nuance I guess though in that in ST, you dont configure to use a PL endpoint in-app, where as you do in MT. Do we foresee this causing extra confusion/issues for customers due to this difference?

To be clear though, I'm more than happy for us to just say across the board, regardless of ST vs MT, that we just dont want folks to use env vars for their connection hostnames if they use PL.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ryancharris ryancharris force-pushed the ryancharris/add-pl-custom-env-var-restriction-callout branch from 39c6248 to 5263dfe Compare January 4, 2024 17:30
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢

@runleonarun runleonarun enabled auto-merge (squash) January 4, 2024 17:34
@runleonarun runleonarun merged commit 116c46c into current Jan 4, 2024
7 checks passed
@runleonarun runleonarun deleted the ryancharris/add-pl-custom-env-var-restriction-callout branch January 4, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content do not merge January-2024 size: small This change will take 1 to 2 days to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants