Skip to content

Commit c6f6f77

Browse files
alexottnkvuong
andauthored
[Doc] Unify/reorganize notes in docs for resources/data sources (#4657)
## Changes <!-- Summary of your changes that are easy to understand --> Changes include: * Remove not necessary `**Note**` in `->`, etc. * Put notes about account or workspace level provider after the first paragraph, so it's easier to understand what resource/data source is doing, and then read the note. * Added missing notes about account or workspace level provider * Removed repeated notes about `authentication is not configured for provider errors` that is more about troubleshooting than about specific resource/data source. ## Tests <!-- How is this tested? Please see the checklist below and also describe any other relevant tests --> - [ ] `make test` run locally - [x] relevant change in `docs/` folder - [ ] covered with integration tests in `internal/acceptance` - [ ] using Go SDK - [ ] using TF Plugin Framework --------- Co-authored-by: vuong-nguyen <[email protected]>
1 parent 4720882 commit c6f6f77

File tree

154 files changed

+333
-239
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+333
-239
lines changed

NEXT_CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
### Documentation
1212

13+
* Unify/reorganize notes in docs for resources/data sources ([#4657](https://github.com/databricks/terraform-provider-databricks/pull/4657))
14+
1315
### Exporter
1416

1517
### Internal Changes

docs/data-sources/app.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ subcategory: "Apps"
33
---
44
# databricks_app Data Source
55

6+
-> This data source can only be used with a workspace-level provider!
7+
68
-> This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html).
79

810
[Databricks Apps](https://docs.databricks.com/en/dev-tools/databricks-apps/index.html) run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on. This resource creates the application but does not handle app deployment, which should be handled separately as part of your CI/CD pipeline.

docs/data-sources/apps.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ subcategory: "Apps"
33
---
44
# databricks_apps Data Source
55

6+
-> This data source can only be used with a workspace-level provider!
7+
68
-> This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html).
79

810
[Databricks Apps](https://docs.databricks.com/en/dev-tools/databricks-apps/index.html) run directly on a customer’s Databricks instance, integrate with their data, use and extend Databricks services, and enable users to interact through single sign-on. This resource creates the application but does not handle app deployment, which should be handled separately as part of your CI/CD pipeline.

docs/data-sources/aws_assume_role_policy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ subcategory: "Deployment"
66

77
This data source constructs necessary AWS STS assume role policy for you.
88

9+
-> This data source can be used with an account or workspace-level provider.
10+
911
## Example Usage
1012

1113
End-to-end example of provisioning Cross-account IAM role with [databricks_mws_credentials](../resources/mws_credentials.md) and [aws_iam_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role):

docs/data-sources/aws_bucket_policy.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ subcategory: "Deployment"
55

66
This datasource configures a simple access policy for AWS S3 buckets, so that Databricks can access data in it.
77

8+
-> This data source can be used with an account or workspace-level provider.
9+
810
## Example Usage
911

1012
```hcl

docs/data-sources/aws_crossaccount_policy.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ subcategory: "Deployment"
33
---
44
# databricks_aws_crossaccount_policy Data Source
55

6-
-> **Note** This data source can only be used with an account-level provider!
7-
86
This data source constructs necessary AWS cross-account policy for you, which is based on [official documentation](https://docs.databricks.com/administration-guide/account-api/iam-role.html#language-Your%C2%A0VPC,%C2%A0default).
97

8+
-> This data source can be used with an account or workspace-level provider.
9+
1010
## Example Usage
1111

1212
For more detailed usage please see [databricks_aws_assume_role_policy](aws_assume_role_policy.md) or [databricks_aws_s3_mount](../resources/mount.md) pages.

docs/data-sources/aws_unity_catalog_assume_role_policy.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ subcategory: "Deployment"
33
---
44
# databricks_aws_unity_catalog_assume_role_policy Data Source
55

6-
-> **Note** This resource has an evolving API, which may change in future versions of the provider. Please always consult [latest documentation](https://docs.databricks.com/data-governance/unity-catalog/get-started.html#configure-a-storage-bucket-and-iam-role-in-aws) in case of any questions.
7-
86
This data source constructs the necessary AWS Unity Catalog assume role policy for you.
97

8+
-> This data source can be used with an account or workspace-level provider.
9+
10+
-> This data source has an evolving API, which may change in future versions of the provider. Please always consult [latest documentation](https://docs.databricks.com/data-governance/unity-catalog/get-started.html#configure-a-storage-bucket-and-iam-role-in-aws) in case of any questions.
11+
1012
## Example Usage
1113

1214
```hcl

docs/data-sources/aws_unity_catalog_policy.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@ subcategory: "Deployment"
33
---
44
# databricks_aws_unity_catalog_policy Data Source
55

6-
-> **Note** This resource has an evolving API, which may change in future versions of the provider. Please always consult [latest documentation](https://docs.databricks.com/data-governance/unity-catalog/get-started.html#configure-a-storage-bucket-and-iam-role-in-aws) in case of any questions.
7-
86
This data source constructs the necessary AWS Unity Catalog policy for you.
97

8+
-> This data source can be used with an account or workspace-level provider.
9+
10+
-> This data source has an evolving API, which may change in future versions of the provider. Please always consult [latest documentation](https://docs.databricks.com/data-governance/unity-catalog/get-started.html#configure-a-storage-bucket-and-iam-role-in-aws) in case of any questions.
11+
1012
## Example Usage
1113

1214
```hcl

docs/data-sources/budget_policies.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
subcategory: "FinOps"
33
---
44
# databricks_budget_policies Data Source
5-
This data source can be used to fetch the list of budget policies.
65

7-
-> **Note** This data source can only be used with an account-level provider!
6+
This data source can be used to fetch the list of budget policies.
87

8+
-> This data source can only be used with an account-level provider!
99

1010
## Example Usage
1111

@@ -26,4 +26,4 @@ data "databricks_budget_policies" "all" {
2626

2727
Data source exposes the following attributes:
2828

29-
- `budget_policies` - The list of budget policy.
29+
- `budget_policies` - The list of budget policy.

docs/data-sources/budget_policy.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
subcategory: "FinOps"
33
---
44
# databricks_budget_policy Data Source
5+
56
This data source can be used to get a single budget policy.
67

7-
-> **Note** This data source can only be used with an account-level provider!
8+
-> This data source can only be used with an account-level provider!
89

910
## Example Usage
1011

@@ -27,4 +28,4 @@ Data source allows you to get a budget policy by the following attribute
2728
Data source exposes the following attributes:
2829

2930
- `policy_id` - The id of the budget policy.
30-
- `policy_name` - The name of the budget policy.
31+
- `policy_name` - The name of the budget policy.

0 commit comments

Comments
 (0)