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

ENTERPRISE-724: Allie / updating ip restriction docs #3963

Merged

Conversation

nm0s
Copy link
Contributor

@nm0s nm0s commented Aug 21, 2023

What are you changing in this pull request and why?

Updating docs to reflect that service tokens will now be blocked by ip restrictions. And BC customers with Gitlab or ADO integrations must add their respective integration ips to their ip rules

Checklist

  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):

  • Remove page from website/sidebars.js
  • Add an entry website/static/_redirects
  • Ran link testing to update the links that point to the deleted page

@netlify
Copy link

netlify bot commented Aug 21, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit 0c98632
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64ff262ebfabf60008291179
😎 Deploy Preview https://deploy-preview-3963--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added content Improvements or additions to content size: x-small This change will take under 3 hours to fix. labels Aug 21, 2023
@@ -71,6 +71,8 @@ The application form in GitLab should look as follows when completed:

Click **Save application** in GitLab, and GitLab will then generate an **Application ID** and **Secret**. These values will be available even if you close the app screen, so this is not the only chance you have to save them.

If you're a Business Critical customer using IP restrictions ensure you've added the appropriate Gitlab CIDRs to your IP restriction rules, or else the Gitlab connection will fail.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@saimaddali I've added these lines to the bottom of the gitlab and ADO integration sections - would you rather these be in a more visible place?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's also add it to the ip restriction docs (website/docs/docs/cloud/secure/ip-restrictions.md)

@nm0s nm0s requested a review from saimaddali August 31, 2023 18:32
@nm0s nm0s marked this pull request as ready for review August 31, 2023 22:59
@nm0s nm0s requested a review from a team as a code owner August 31, 2023 22:59
@@ -23,3 +23,4 @@ To connect Azure DevOps in dbt Cloud:
2. dbt Cloud developers need to [personally authenticate with Azure DevOps](/docs/cloud/git/authenticate-azure) from dbt Cloud.


If you're a Business Critical customer using IP restrictions ensure you've added the appropriate Azure DevOps CIDRs to your IP restriction rules, or else the Azure DevOps connection will fail.
Copy link
Contributor

Choose a reason for hiding this comment

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

using IP restrictions ensure

nit: a , before ensure.
Can you also link IP restrictions back to website/docs/docs/cloud/secure/ip-restrictions.md docs

Copy link
Contributor

Choose a reason for hiding this comment

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

Similar below.

@@ -71,6 +71,8 @@ The application form in GitLab should look as follows when completed:

Click **Save application** in GitLab, and GitLab will then generate an **Application ID** and **Secret**. These values will be available even if you close the app screen, so this is not the only chance you have to save them.

If you're a Business Critical customer using IP restrictions ensure you've added the appropriate Gitlab CIDRs to your IP restriction rules, or else the Gitlab connection will fail.
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's also add it to the ip restriction docs (website/docs/docs/cloud/secure/ip-restrictions.md)

@@ -19,7 +19,7 @@ To configure IP restrictions, go to **Account Settings** → **IP Restrictions**
- Deny IPs flagged by the Security team
- Allow only VPN traffic but make an exception for contractors’ IP addresses

IP restrictions will block all user requests done via the API (via personal user token) and the UI. Service tokens are exempt from IP restrictions and can still make requests to dbt Cloud API.
IP restrictions will block all service tokens, user requests done via the API (via personal user token), and the UI.
Copy link
Contributor

Choose a reason for hiding this comment

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

IP restrictions will block all service tokens requests, user requests done via the API (via personal user token), and the UI, if they are coming from blocked IP addresses.

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 for you can add a note about integrations using serviceTokens.
"For any versionControl system integrations inbound into dbt Cloud, ensure their IP addresses are added to the allowed list. Examples: Gitlab, ADO and Github"

@matthewshaver matthewshaver merged commit c7c5b73 into current Sep 11, 2023
10 checks passed
@matthewshaver matthewshaver deleted the allie/updating-docs-to-reflect-service-token-changes branch September 11, 2023 14:48
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 size: x-small This change will take under 3 hours to fix.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants