Update Databricks integration setup docs (DOIO-94)#38129
Open
charlesmyu wants to merge 1 commit into
Open
Conversation
Contributor
charlesmyu
force-pushed
the
charlesyu/doio-94-update-databricks-integration-docs
branch
from
a75c7c2 to
2b1b494
Compare
Reduce onboarding friction in the Databricks setup docs: - Fold the required workspace entitlements (Workspace access, Databricks SQL access, Admin access) into service principal creation, replacing the separate "add to admins group" steps; note the granular-permissions fallback when Admin access cannot be granted. - Restructure SQL Warehouse setup into a single step with ordered substeps: select a Pro/Serverless warehouse (recommend a dedicated 2XS), copy the ID, grant CAN USE, and grant system-table read access. - Document where to find the SQL Warehouse ID, and note it powers Quality Monitoring, with a cross-link to that page. - Tell users to run the system-table GRANT commands in the SQL Editor, and fix the grant syntax to use the backticked client ID instead of the service principal display name. - Surface the MANAGE-on-CATALOG-system prerequisite as a warning callout. Also updates the Cloud Cost Management (saas_costs) and Quality Monitoring Databricks docs to use the SQL Editor and backticked client ID for the system-table grants. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
charlesmyu
force-pushed
the
charlesyu/doio-94-update-databricks-integration-docs
branch
from
2b1b494 to
fd25825
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Addresses user-reported friction in the Databricks integration setup docs (DOIO-94).
Files touched:
content/en/data_observability/jobs_monitoring/databricks/_index.mdcontent/en/data_observability/quality_monitoring/data_warehouses/databricks.mdcontent/en/cloud_cost_management/setup/saas_costs.mdChanges, mapped to the ticket items:
adminsgroup" steps (Admin access is equivalent). Added a note that granular access (per the Permissions section under Advanced Configuration) is the fallback when Admin access can't be granted.GRANTblock (jobs-monitoring, quality-monitoring, saas_costs). (Screenshot not added — docs-repo limitation; follow-up.)<service_principal>/<token_principal>with the backticked`<client-id>`and a "use the client ID, not the display name" note.MANAGEonCATALOG systemprerequisite as a warning callout next to the grant commands.Intentionally not changed (per ticket-owner feedback during review):
DATABRICKS_WORKSPACE="..."quotes and the "enclose in double quotes if it contains whitespace" note, since quotes are needed for workspace names containing whitespace.Out of scope for this docs repo (follow-ups for the owning team): the in-tile UI copy for items 3/7 and the SQL Editor screenshot for item 5.
Motivation
DOIO-94 — reduce onboarding friction for the Databricks integration.
Additional Notes
Draft — pending review, not intended to merge yet.
🤖 Generated with Claude Code