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

update VCS and postgres PL docs for accuracy and completeness #4782

Merged
merged 11 commits into from
Jan 24, 2024

Conversation

dhaworth
Copy link
Contributor

@dhaworth dhaworth commented Jan 22, 2024

What are you changing in this pull request and why?

Noticed an incorrect principal ARN and some missing information in a couple of the PrivateLink docs, so updating them accordingly. In summary:

  • Postgres PL - Separate out connection request acceptance into separate step
  • VCS PL
    • Fix incorrect principal ARN
    • Change to numbered headers
    • Add missing step for submitting support request
    • Clarify DNS settings

Checklist

@dhaworth dhaworth requested a review from a team as a code owner January 22, 2024 20:34
Copy link

vercel bot commented Jan 22, 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 24, 2024 8:16pm

@github-actions github-actions bot added content Improvements or additions to content size: small This change will take 1 to 2 days to address labels Jan 22, 2024
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.

Mostly reviewed to check for typos (there weren't any!), and I trust that these are the right changes since Dave is an expert in this area.


When you have been notified that the resources are provisioned within the dbt Cloud environment, you must accept the endpoint connection (unless the VPC Endpoint Service is set to auto-accept connection requests). Requests can be accepted through the AWS console, as seen below, or through the AWS CLI.

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/accept-request.png" width="80%" title="Accept the connection request" />
Copy link
Contributor

Choose a reason for hiding this comment

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

Is the endpoint ID in this doc sensitive - does it need to be obfuscated or is it ok as-is?

Correct header spacing

Co-authored-by: Matt Shaver <[email protected]>

<Lightbox src="/img/docs/dbt-cloud/cloud-configuring-dbt-cloud/vpc-endpoint-service-name.png" width="80%" title="Location of the VPC Endpoint Service name in the AWS console" />

- **DNS configuration:** If the connection to the VCS service requires a custom domain and/or URL for TLS, a private hosted zone can be configured by the dbt Labs Infrastructure team in the dbt Cloud private network. For example:
### NOTE: Custom DNS configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't style Note: in header formats. Is it ok if I change this to a callout?

@github-actions github-actions bot added size: medium This change will take up to a week to address and removed size: small This change will take 1 to 2 days to address labels Jan 24, 2024
@matthewshaver matthewshaver merged commit d78c084 into current Jan 24, 2024
7 checks passed
@matthewshaver matthewshaver deleted the update-vcs-privatelink-details branch January 24, 2024 21:31
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 January-2024 size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants