Skip to content

Commit 22aea9a

Browse files
authored
Cross-linked resource documentation (databricks#1027)
This change should improve the user experience of discovering relevant resources with minimal knowledge of Databricks Platform.
1 parent 8547157 commit 22aea9a

Some content is hidden

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

56 files changed

+615
-39
lines changed

docs/data-sources/aws_assume_role_policy.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This data source constructs necessary AWS STS assume role policy for you.
88

99
## Example Usage
1010

11-
End-to-end example of provisioning Cross-account IAM role:
11+
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):
1212

1313
```hcl
1414
variable "databricks_account_id" {
@@ -56,3 +56,11 @@ resource "databricks_mws_credentials" "this" {
5656
In addition to all arguments above, the following attributes are exported:
5757

5858
* `json` - AWS IAM Policy JSON document
59+
60+
## Related Resources
61+
62+
The following resources are used in the same context:
63+
64+
* [Provisioning AWS Databricks E2 with a Hub & Spoke firewall for data exfiltration protection](../guides/aws-e2-firewall-hub-and-spoke.md) guide
65+
* [databricks_aws_bucket_policy](aws_bucket_policy.md) data to configure a simple access policy for AWS S3 buckets, so that Databricks can access data in it.
66+
* [databricks_aws_crossaccount_policy](aws_crossaccount_policy.md) data to construct the 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).

docs/data-sources/aws_bucket_policy.md

+9
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,12 @@ resource "aws_s3_bucket_policy" "ds" {
8080
In addition to all arguments above, the following attributes are exported:
8181

8282
* `json` - (Read-only) AWS IAM Policy JSON document to grant Databricks full access to bucket.
83+
84+
## Related Resources
85+
86+
The following resources are used in the same context:
87+
88+
* [Provisioning AWS Databricks E2 with a Hub & Spoke firewall for data exfiltration protection](../guides/aws-e2-firewall-hub-and-spoke.md) guide
89+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
90+
* [databricks_instance_profile](../resources/instance_profile.md) to manage AWS EC2 instance profiles that users can launch [databricks_cluster](../resources/cluster.md) and access data, like [databricks_mount](../resources/mount.md).
91+
* [databricks_mount](../resources/mount.md) to [mount your cloud storage](https://docs.databricks.com/data/databricks-file-system.html#mount-object-storage-to-dbfs) on `dbfs:/mnt/name`.

docs/data-sources/aws_crossaccount_policy.md

+9
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,12 @@ data "databricks_aws_crossaccount_policy" "this" {}
2424
In addition to all arguments above, the following attributes are exported:
2525

2626
* `json` - AWS IAM Policy JSON document
27+
28+
## Related Resources
29+
30+
The following resources are used in the same context:
31+
32+
* [Provisioning AWS Databricks E2 with a Hub & Spoke firewall for data exfiltration protection](../guides/aws-e2-firewall-hub-and-spoke.md) guide
33+
* [databricks_aws_assume_role_policy](aws_assume_role_policy.md) data to construct the necessary AWS STS assume role policy.
34+
* [databricks_aws_bucket_policy](aws_bucket_policy.md) data to configure a simple access policy for AWS S3 buckets, so that Databricks can access data in it.
35+
* [databricks_instance_profile](../resources/instance_profile.md) to manage AWS EC2 instance profiles that users can launch [databricks_cluster](../resources/cluster.md) and access data, like [databricks_mount](../resources/mount.md).

docs/data-sources/clusters.md

+12
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,15 @@ data "databricks_clusters" "all_shared" {
3535
This data source exports the following attributes:
3636

3737
* `ids` - list of [databricks_cluster](../resources/cluster.md#cluster_id) ids
38+
39+
## Related Resources
40+
41+
The following resources are used in the same context:
42+
43+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
44+
* [databricks_cluster](../resources/cluster.md) to create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).
45+
* [databricks_cluster_policy](../resources/cluster_policy.md) to create a [databricks_cluster](../resources/cluster.md) policy, which limits the ability to create clusters based on a set of rules.
46+
* [databricks_instance_pool](../resources/instance_pool.md) to manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce [cluster](../resources/cluster.md) start and auto-scaling times by maintaining a set of idle, ready-to-use instances.
47+
* [databricks_job](../resources/job.md) to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a [databricks_cluster](../resources/cluster.md).
48+
* [databricks_library](../resources/library.md) to install a [library](https://docs.databricks.com/libraries/index.html) on [databricks_cluster](../resources/cluster.md).
49+
* [databricks_pipeline](../resources/pipeline.md) to deploy [Delta Live Tables](https://docs.databricks.com/data-engineering/delta-live-tables/index.html).

docs/data-sources/current_user.md

+10
Original file line numberDiff line numberDiff line change
@@ -61,3 +61,13 @@ Data source exposes the following attributes:
6161
* `home` - Home folder of the [user](../resources/user.md), e.g. `/Users/[email protected]`.
6262
* `repos` - Personal Repos location of the [user](../resources/user.md), e.g. `/Repos/[email protected]`.
6363
* `alphanumeric` - Alphanumeric representation of user local name. e.g. `mr_foo`.
64+
65+
66+
## Related Resources
67+
68+
The following resources are used in the same context:
69+
70+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
71+
* [databricks_directory](../resources/directory.md) to manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).
72+
* [databricks_notebook](../resources/notebook.md) to manage [Databricks Notebooks](https://docs.databricks.com/notebooks/index.html).
73+
* [databricks_repo](../resources/repo.md) to manage [Databricks Repos](https://docs.databricks.com/repos.html).

docs/data-sources/dbfs_file.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Storage"
55

66
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
77

8-
This data source allows to get file content from DBFS
8+
This data source allows to get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
99

1010
## Example Usage
1111

@@ -26,3 +26,12 @@ This data source exports the following attributes:
2626

2727
* `content` - base64-encoded file contents
2828
* `file_size` - size of the file in bytes
29+
30+
## Related Resources
31+
32+
The following resources are used in the same context:
33+
34+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
35+
* [databricks_dbfs_file_paths](dbfs_file_paths.md) data to get list of file names from get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
36+
* [databricks_dbfs_file](../resources/dbfs_file.md) to manage relatively small files on [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
37+
* [databricks_mount](../resources/mount.md) to [mount your cloud storage](https://docs.databricks.com/data/databricks-file-system.html#mount-object-storage-to-dbfs) on `dbfs:/mnt/name`.

docs/data-sources/dbfs_file_paths.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Storage"
55

66
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
77

8-
This data source allows to get list of file names from DBFS
8+
This data source allows to get list of file names from get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
99

1010
## Example Usage
1111

@@ -25,3 +25,15 @@ data "databricks_dbfs_file_paths" "partitions" {
2525
This data source exports the following attributes:
2626

2727
* `path_list` - returns list of objects with `path` and `file_size` attributes in each
28+
29+
30+
## Related Resources
31+
32+
The following resources are used in the same context:
33+
34+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
35+
* [databricks_dbfs_file](dbfs_file.md) data to get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
36+
* [databricks_dbfs_file_paths](dbfs_file_paths.md) data to get list of file names from get file content from [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
37+
* [databricks_dbfs_file](../resources/dbfs_file.md) to manage relatively small files on [Databricks File System (DBFS)](https://docs.databricks.com/data/databricks-file-system.html).
38+
* [databricks_library](../resources/library.md) to install a [library](https://docs.databricks.com/libraries/index.html) on [databricks_cluster](../resources/cluster.md).
39+
* [databricks_mount](../resources/mount.md) to [mount your cloud storage](https://docs.databricks.com/data/databricks-file-system.html#mount-object-storage-to-dbfs) on `dbfs:/mnt/name`.

docs/data-sources/group.md

+12
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,15 @@ Data source exposes the following attributes:
4444
* `instance_profiles` - Set of [instance profile](../resources/instance_profile.md) ARNs, that can be modified by [databricks_group_instance_profile](../resources/group_instance_profile.md) resource.
4545
* `allow_cluster_create` - True if group members can create [clusters](../resources/cluster.md)
4646
* `allow_instance_pool_create` - True if group members can create [instance pools](../resources/instance_pool.md)
47+
48+
49+
## Related Resources
50+
51+
The following resources are used in the same context:
52+
53+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
54+
* [databricks_cluster](../resources/cluster.md) to create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).
55+
* [databricks_directory](../resources/directory.md) to manage directories in [Databricks Workpace](https://docs.databricks.com/workspace/workspace-objects.html).
56+
* [databricks_group_member](../resources/group_member.md) to attach [users](../resources/user.md) and [groups](../resources/group.md) as group members.
57+
* [databricks_permissions](../resources/permissions.md) to manage [access control](https://docs.databricks.com/security/access-control/index.html) in Databricks workspace.
58+
* [databricks_user](../resources/user.md) to [manage users](https://docs.databricks.com/administration-guide/users-groups/users.html), that could be added to [databricks_group](../resources/group.md) within the workspace.

docs/data-sources/node_type.md

+10
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,13 @@ Data source allows you to pick groups by the following attributes
6363
Data source exposes the following attributes:
6464

6565
* `id` - node type, that can be used for [databricks_job](../resources/job.md), [databricks_cluster](../resources/cluster.md), or [databricks_instance_pool](../resources/instance_pool.md).
66+
67+
## Related Resources
68+
69+
The following resources are used in the same context:
70+
71+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
72+
* [databricks_cluster](../resources/cluster.md) to create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).
73+
* [databricks_cluster_policy](../resources/cluster_policy.md) to create a [databricks_cluster](../resources/cluster.md) policy, which limits the ability to create clusters based on a set of rules.
74+
* [databricks_instance_pool](../resources/instance_pool.md) to manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce [cluster](../resources/cluster.md) start and auto-scaling times by maintaining a set of idle, ready-to-use instances.
75+
* [databricks_job](../resources/job.md) to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a [databricks_cluster](../resources/cluster.md).

docs/data-sources/notebook.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Workspace"
55

66
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
77

8-
This data source allows to export a notebook from workspace
8+
This data source allows to export a notebook from Databricks Workspace.
99

1010
## Example Usage
1111

docs/data-sources/notebook_paths.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Workspace"
55

66
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
77

8-
This data source allows to list notebooks in the workspace
8+
This data source allows to list notebooks in the Databricks Workspace.
99

1010
## Example Usage
1111

docs/data-sources/spark_version.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Compute"
55

66
-> **Note** If you have a fully automated setup with workspaces created by [databricks_mws_workspaces](../resources/mws_workspaces.md) or [azurerm_databricks_workspace](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/databricks_workspace), please make sure to add [depends_on attribute](../index.md#data-resources-and-authentication-is-not-configured-errors) in order to prevent _authentication is not configured for provider_ errors.
77

8-
Gets Databricks Runtime (DBR) version that could be used for `spark_version` parameter in [databricks_cluster](../resources/cluster.md) and other resources that fits search criteria, like specific Spark or Scala version, ML or Genomics runtime, etc., similar to executing `databricks clusters spark-versions`, and filters it to return the latest version that matches criteria. Often used along [databricks_node_type](node_type.md) data source.
8+
Gets [Databricks Runtime (DBR)](https://docs.databricks.com/runtime/dbr.html) version that could be used for `spark_version` parameter in [databricks_cluster](../resources/cluster.md) and other resources that fits search criteria, like specific Spark or Scala version, ML or Genomics runtime, etc., similar to executing `databricks clusters spark-versions`, and filters it to return the latest version that matches criteria. Often used along [databricks_node_type](node_type.md) data source.
99

1010
-> **Note** This is experimental functionality, which aims to simplify things. In case of wrong parameters given (e.g. together `ml = true` and `genomics = true`, or something like), data source will throw an error. Similarly, if search returns multiple results, and `latest = false`, data source will throw an error.
1111

@@ -55,3 +55,13 @@ Data source allows you to pick groups by the following attributes:
5555
Data source exposes the following attributes:
5656

5757
* `id` - Databricks Runtime version, that can be used as `spark_version` field in [databricks_job](../resources/job.md), [databricks_cluster](../resources/cluster.md), or [databricks_instance_pool](../resources/instance_pool.md).
58+
59+
## Related Resources
60+
61+
The following resources are used in the same context:
62+
63+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
64+
* [databricks_cluster](../resources/cluster.md) to create [Databricks Clusters](https://docs.databricks.com/clusters/index.html).
65+
* [databricks_cluster_policy](../resources/cluster_policy.md) to create a [databricks_cluster](../resources/cluster.md) policy, which limits the ability to create clusters based on a set of rules.
66+
* [databricks_instance_pool](../resources/instance_pool.md) to manage [instance pools](https://docs.databricks.com/clusters/instance-pools/index.html) to reduce [cluster](../resources/cluster.md) start and auto-scaling times by maintaining a set of idle, ready-to-use instances.
67+
* [databricks_job](../resources/job.md) to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code in a [databricks_cluster](../resources/cluster.md).

docs/data-sources/user.md

+14
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,17 @@ Data source exposes the following attributes:
4545
- `home` - Home folder of the [user](../resources/user.md), e.g. `/Users/[email protected]`.
4646
- `repos` - Personal Repos location of the [user](../resources/user.md), e.g. `/Repos/[email protected]`.
4747
- `alphanumeric` - Alphanumeric representation of user local name. e.g. `mr_foo`.
48+
49+
## Related Resources
50+
51+
The following resources are used in the same context:
52+
53+
* [End to end workspace management](../guides/passthrough-cluster-per-user.md) guide
54+
* [databricks_current_user](current_user.md) data to retrieve information about [databricks_user](../resources/user.md) or [databricks_service_principal](../resources/service_principal.md), that is calling Databricks REST API.
55+
* [databricks_group](../resources/group.md) to manage [groups in Databricks Workspace](https://docs.databricks.com/administration-guide/users-groups/groups.html) or [Account Console](https://accounts.cloud.databricks.com/) (for AWS deployments).
56+
* [databricks_group](group.md) data to retrieve information about [databricks_group](../resources/group.md) members, entitlements and instance profiles.
57+
* [databricks_group_instance_profile](../resources/group_instance_profile.md) to attach [databricks_instance_profile](../resources/instance_profile.md) (AWS) to [databricks_group](../resources/group.md).
58+
* [databricks_group_member](../resources/group_member.md) to attach [users](../resources/user.md) and [groups](../resources/group.md) as group members.
59+
* [databricks_permissions](../resources/permissions.md) to manage [access control](https://docs.databricks.com/security/access-control/index.html) in Databricks workspace.
60+
* [databricks_user](../resources/user.md) to [manage users](https://docs.databricks.com/administration-guide/users-groups/users.html), that could be added to [databricks_group](../resources/group.md) within the workspace.
61+
* [databricks_user_instance_profile](../resources/user_instance_profile.md) to attach [databricks_instance_profile](../resources/instance_profile.md) (AWS) to [databricks_user](../resources/user.md).

0 commit comments

Comments
 (0)