[Documentation] Unified Provider: One provider to manage both workspace and account level resources #5122

tanmay-db · 2025-10-20T19:51:22Z

Changes

Main landing page under guides
Reference under authentication where we specify using 2 providers
Stability: Public Beta

With these, users have sufficient information to start using, migrating to unified provider with examples and how to report issues. We can add more later on.

Tests

N/A

…ricks into doc-unified-tf

Copilot

Pull Request Overview

This PR introduces documentation for the Unified Provider feature, which enables managing workspace-level resources through a single account-level provider configuration, eliminating the need for separate workspace providers.

Key changes:

Added comprehensive guide explaining unified provider usage and migration
Updated main documentation with authentication examples
Added changelog entry

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
docs/index.md	Added authentication section with unified provider example
docs/guides/unified-provider.md	New comprehensive guide covering usage, migration, limitations, and issue reporting
NEXT_CHANGELOG.md	Added changelog entry for unified provider documentation

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

docs/index.md

docs/guides/unified-provider.md

mgyucht

Main gap is the instruction for migration. Otherwise this is looking pretty good, just a few nits.

docs/guides/unified-provider.md

docs/index.md

github-actions · 2025-10-22T21:27:57Z

If integration tests don't run automatically, an authorized user can run them manually by following the instructions below:

Trigger:
go/deco-tests-run/terraform

Inputs:

PR number: 5122
Commit SHA: 6c3c0fc7748f1dd5d5ef2d5d987814c1fb2f55f2

Checks will be approved automatically on success.

mgyucht

Some more feedback!

mgyucht · 2025-10-23T12:35:30Z

docs/guides/unified-provider.md

+### Block
+```hcl
+resource "workspace_level_resource" "this" {
+    provider_config {
+        workspace_id = "12345"
+    }
+    ...
+}
+```
+
+### Attribute
+```hcl
+resource "workspace_level_resource" "this" {
+    provider_config = {
+        workspace_id = "12345"
+    }
+    ...
+}
+```


Remove the subheadings and just add English describing the code blocks.

Use actual resources rather than fake ones.

mgyucht · 2025-10-23T12:36:33Z

docs/guides/unified-provider.md

+
+To manage a workspace-level resource through the account provider, specify the `provider_config` at the resource level with the `workspace_id` of the workspace the resource belongs to.
+
+Depending on the internal implementation of the resource or data source, `provider_config` can be either a block or an attribute. For details, please refer to the documentation of the specific resource or data source.


With attributes, an = separates the provider_config from its configuration, whereas with blocks, this = is omitted.

mgyucht · 2025-10-23T12:39:18Z

docs/guides/unified-provider.md

+}
+```
+
+**Note:** This feature is being rolled out incrementally. Some resources do not yet support the unified provider. Please check the resource-specific documentation to see if the `provider_config` attribute or block is available.


suggest not to document this change until after non-SDK resources are supported.

mgyucht · 2025-10-23T12:40:07Z

docs/guides/unified-provider.md

+```
+
+Once the workspace is created, create a workspace-level provider.
+```hcl


Suggested change

```

Once the workspace is created, create a workspace-level provider.

```hcl

mgyucht · 2025-10-23T12:41:12Z

docs/guides/unified-provider.md

+}
+
+// Use the workspace provider for workspace-level resources
+resource "databricks_workspace_level_resource" "this" {


Let's use real resources just for demonstration

mgyucht · 2025-10-23T12:50:12Z

docs/guides/unified-provider.md

+## FAQ
+
+* An empty `workspace_id` is not allowed, and `terraform plan` will fail with the error: `"workspace_id string length must be at least 1"`.
+* The `workspace_id` supplied to the resource through `provider_config` must belong to the account for which the provider is configured. If the workspace does not belong to the account, you will receive an error: `"failed to get workspace client, please check the workspace_id provided in the provider_config"`.


Or that the authenticated principal doesn't have permission to call the GetWorkspace API.

mgyucht · 2025-10-23T12:51:38Z

docs/guides/unified-provider.md

+
+## Usage
+
+To manage a workspace-level resource through the account provider, specify the `provider_config` at the resource level with the `workspace_id` of the workspace the resource belongs to.


You need to have the "account admin" permission. (Let's check this with Alex or LRM team.)

mgyucht · 2025-10-23T12:52:38Z

docs/guides/unified-provider.md

+There are some limitations to this feature that we plan to address in the near future:
+
+1. Databricks CLI and Azure CLI authentication methods are not currently supported
+2. Some resources do not yet support the unified provider as the support is rolling out incrementally. Please refer to the documentation for each resource or data source to check if they support the `provider_config` attribute or block.


This also will go away.

mgyucht · 2025-10-23T12:52:53Z

docs/guides/unified-provider.md

+
+1. Databricks CLI and Azure CLI authentication methods are not currently supported
+2. Some resources do not yet support the unified provider as the support is rolling out incrementally. Please refer to the documentation for each resource or data source to check if they support the `provider_config` attribute or block.
+


Maybe this is the right spot to mention the account admin permission restriction?

mgyucht · 2025-10-23T12:53:14Z

docs/index.md

+}
+
+// Create a workspace level resource under the workspace above
+resource "databricks_workspace_level_resource" "this" {


…amework resources and data sources (#5115) ## Changes  Add unified provider support for the following resources: - Quality Monitor - Library - Shares These use types.List to be compatible with SDKv2 Also noticed that we don't have documentation for library resource, added it as well. Main documentation: #5122 ## Tests  Integration tests

[Documentation] Add support for Unified Terraform Provider

5f4df4a

tanmay-db temporarily deployed to test-trigger-is October 20, 2025 19:51 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 20, 2025 19:52 — with GitHub Actions Inactive

tanmay-db changed the title ~~[Documentation] Add support for Unified Terraform Provider~~ [Documentation] Documentation for Unified Provider Oct 20, 2025

tanmay-db changed the title ~~[Documentation] Documentation for Unified Provider~~ [Documentation] Unified Provider Oct 20, 2025

-

d0aaf52

tanmay-db temporarily deployed to test-trigger-is October 20, 2025 20:06 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 20, 2025 20:07 — with GitHub Actions Inactive

tanmay-db added 2 commits October 21, 2025 16:35

-

12c04f5

-

fb8ab5b

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:11 — with GitHub Actions Inactive

Merge branch 'main' of github.com:databricks/terraform-provider-datab…

153a83a

…ricks into doc-unified-tf

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:12 — with GitHub Actions Inactive

tanmay-db changed the title ~~[Documentation] Unified Provider~~ [Documentation] Unified Provider: One provider to manage both workspace and account level resources Oct 21, 2025

tanmay-db marked this pull request as ready for review October 21, 2025 11:13

tanmay-db requested review from a team as code owners October 21, 2025 11:13

tanmay-db requested review from hectorcast-db and removed request for a team October 21, 2025 11:13

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:13 — with GitHub Actions Inactive

tanmay-db removed request for a team and hectorcast-db October 21, 2025 11:13

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:14 — with GitHub Actions Inactive

-

c2b0fe4

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:14 — with GitHub Actions Inactive

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:15 — with GitHub Actions Inactive

alexott requested a review from Copilot October 21, 2025 11:30

Copilot AI reviewed Oct 21, 2025

View reviewed changes

docs/index.md Outdated Show resolved Hide resolved

docs/guides/unified-provider.md Outdated Show resolved Hide resolved

-

62641be

tanmay-db temporarily deployed to test-trigger-is October 21, 2025 11:42 — with GitHub Actions Inactive

tanmay-db mentioned this pull request Oct 21, 2025

[Feature] Add unified provider support for SDKv2 compatible plugin framework resources and data sources #5115

Merged

mgyucht reviewed Oct 21, 2025

View reviewed changes

tanmay-db added 3 commits October 22, 2025 19:55

comments

a3e64b3

-

ef3fe9a

-

6c3c0fc

tanmay-db temporarily deployed to test-trigger-is October 22, 2025 21:27 — with GitHub Actions Inactive

tanmay-db requested a review from mgyucht October 22, 2025 21:27

tanmay-db temporarily deployed to test-trigger-is October 22, 2025 21:27 — with GitHub Actions Inactive

mgyucht reviewed Oct 23, 2025

View reviewed changes

alexott added the docs add explicit documentation about corner case label Nov 11, 2025


		To manage a workspace-level resource through the account provider, specify the `provider_config` at the resource level with the `workspace_id` of the workspace the resource belongs to.

		Depending on the internal implementation of the resource or data source, `provider_config` can be either a block or an attribute. For details, please refer to the documentation of the specific resource or data source.


		## Usage

		To manage a workspace-level resource through the account provider, specify the `provider_config` at the resource level with the `workspace_id` of the workspace the resource belongs to.


		1. Databricks CLI and Azure CLI authentication methods are not currently supported
		2. Some resources do not yet support the unified provider as the support is rolling out incrementally. Please refer to the documentation for each resource or data source to check if they support the `provider_config` attribute or block.

[Documentation] Unified Provider: One provider to manage both workspace and account level resources #5122

Are you sure you want to change the base?

[Documentation] Unified Provider: One provider to manage both workspace and account level resources #5122

Uh oh!

Conversation

tanmay-db commented Oct 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

mgyucht left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 22, 2025

Uh oh!

mgyucht left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tanmay-db commented Oct 20, 2025 •

edited

Loading