Skip to content

Commit 5a6a224

Browse files
authored
Doc updates for databricks_table and databricks_mws_vpc_endpoint (#1616)
* update privatelink guide with autoaccept * remove databricks_table resource from doc * close #1609 * fix following suggestions
1 parent bc24f3c commit 5a6a224

File tree

13 files changed

+25
-50
lines changed

13 files changed

+25
-50
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@
7979
| [databricks_sql_warehouses](docs/data-sources/sql_warehouses.md) data
8080
| [databricks_sql_widget](docs/resources/sql_widget.md)
8181
| [databricks_storage_credential](docs/resources/storage_credential.md)
82-
| [databricks_table](docs/resources/table.md)
83-
| [databricks_tables](docs/data-sources/table.md) data
82+
| [databricks_tables](docs/data-sources/tables.md) data
8483
| [databricks_token](docs/resources/token.md)
8584
| [databricks_user](docs/resources/user.md)
8685
| [databricks_user_role](docs/resources/user_role.md)

docs/data-sources/catalogs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,5 @@ This data source exports the following attributes:
2929

3030
The following resources are used in the same context:
3131

32-
* [databricks_table](../resources/table.md) to manage tables within Unity Catalog.
3332
* [databricks_schema](../resources/schema.md) to manage schemas within Unity Catalog.
3433
* [databricks_catalog](../resources/catalog.md) to manage catalogs within Unity Catalog.

docs/data-sources/schemas.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,5 @@ This data source exports the following attributes:
3535

3636
The following resources are used in the same context:
3737

38-
* [databricks_table](../resources/table.md) to manage tables within Unity Catalog.
3938
* [databricks_schema](../resources/schema.md) to manage schemas within Unity Catalog.
4039
* [databricks_catalog](../resources/catalog.md) to manage catalogs within Unity Catalog.

docs/data-sources/tables.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,11 @@ resource "databricks_grants" "things" {
3838

3939
This data source exports the following attributes:
4040

41-
* `ids` - set of [databricks_table](../resources/table.md) full names: *`catalog`.`schema`.`table`*
41+
* `ids` - set of databricks_table full names: *`catalog`.`schema`.`table`*
4242

4343
## Related Resources
4444

4545
The following resources are used in the same context:
4646

47-
* [databricks_table](../resources/table.md) to manage tables within Unity Catalog.
4847
* [databricks_schema](../resources/schema.md) to manage schemas within Unity Catalog.
4948
* [databricks_catalog](../resources/catalog.md) to manage catalogs within Unity Catalog.

docs/data-sources/views.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,11 @@ resource "databricks_grants" "things" {
3838

3939
This data source exports the following attributes:
4040

41-
* `ids` - set of [databricks_table](../resources/table.md) full names: *`catalog`.`schema`.`view`*
41+
* `ids` - set of databricks_view full names: *`catalog`.`schema`.`view`*
4242

4343
## Related Resources
4444

4545
The following resources are used in the same context:
4646

47-
* [databricks_table](../resources/table.md) to manage tables within Unity Catalog.
4847
* [databricks_schema](../resources/schema.md) to manage schemas within Unity Catalog.
4948
* [databricks_catalog](../resources/catalog.md) to manage catalogs within Unity Catalog.

docs/guides/aws-private-link-workspace.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ page_title: "Provisioning Databricks on AWS with PrivateLink"
44

55
# Deploying pre-requisite resources and enabling PrivateLink connections (AWS Preview)
66

7-
-> **Private Preview** This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html). Contact your Databricks representative to request access.
7+
-> **Public Preview** This feature is in [Public Preview](https://docs.databricks.com/release-notes/release-types.html). Contact your Databricks representative to request access.
88

99
Databricks PrivateLink support enables private connectivity between users and their Databricks workspaces and between clusters on the data plane and core services on the control plane within the Databricks workspace infrastructure. You can use Terraform to deploy the underlying cloud resources and the private access settings resources automatically, using a programmatic approach. This guide assumes you are deploying into an existing VPC and you have set up credentials and storage configurations as per prior examples, notably here.
1010

@@ -29,6 +29,7 @@ This guide uses the following variables in configurations:
2929
This guide is provided as-is and you can use this guide as the basis for your custom Terraform module.
3030

3131
To get started with AWS PrivateLink integration, this guide takes you throw the following high-level steps:
32+
3233
- Initialize the required providers
3334
- Configure AWS objects
3435
- A subnet dedicated to your VPC relay and workspace endpoints
@@ -80,16 +81,18 @@ variable "subnet_ids" { type = list(string) }
8081
variable "workspace_vpce_service" {}
8182
variable "relay_vpce_service" {}
8283
variable "vpce_subnet_cidr" {}
83-
variable "private_dns_enabled" { default = false }
84+
variable "private_dns_enabled" { default = true }
8485
variable "tags" { default = {} }
8586
8687
locals {
8788
prefix = "private-link-ws"
8889
}
8990
```
9091

91-
## Root bucket
92+
## Root bucket
93+
9294
Create new storage configuration with [databricks_mws_storage_configurations](../resources/mws_storage_configurations.md):
95+
9396
```hcl
9497
resource "databricks_mws_storage_configurations" "this" {
9598
provider = databricks.mws
@@ -100,7 +103,9 @@ resource "databricks_mws_storage_configurations" "this" {
100103
```
101104

102105
## Cross-account IAM role
106+
103107
Create new cross-account credentials with [databricks_mws_credentials](../resources/mws_credentials.md):
108+
104109
```hcl
105110
resource "databricks_mws_credentials" "this" {
106111
provider = databricks.mws
@@ -111,13 +116,16 @@ resource "databricks_mws_credentials" "this" {
111116
```
112117

113118
## Configure networking
119+
114120
In this section, the goal is to create the two back-end VPC endpoints:
121+
115122
- Back-end VPC endpoint for SSC relay
116123
- Back-end VPC endpoint for REST APIs
117124

118125
-> **Note** If you want to implement the front-end VPC endpoint as well for the connections from the user to the workspace front-end, use the transit (bastion) VPC that terminates your AWS Direct Connect or VPN gateway connection or one that is routable from such a transit (bastion) VPC. Once the front-end endpoint is created, it can be supplied to [databricks_mws_networks](../resources/mws_networks.md) resource using vpc_endpoints argument. Use the [databricks_mws_private_access_settings](../resources/mws_private_access_settings.md) resource to control which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object.
119126

120127
The first step is to create the required AWS objects:
128+
121129
- A subnet dedicated to your VPC endpoints.
122130
- A security group dedicated to your VPC endpoints and satisfying required inbound/outbound TCP/HTTPS traffic rules on ports 443 and 6666, respectively.
123131

@@ -208,18 +216,14 @@ resource "aws_security_group" "dataplane_vpce" {
208216
}
209217
```
210218

211-
Run terraform apply twice when configuring PrivateLink: see an [outstanding issue](https://github.com/hashicorp/terraform-provider-aws/issues/7148) for more information.
212-
* Run 1 - comment the `private_dns_enabled` lines.
213-
* Run 2 - uncomment the `private_dns_enabled` lines.
214-
215219
```hcl
216220
resource "aws_vpc_endpoint" "backend_rest" {
217221
vpc_id = var.vpc_id
218222
service_name = var.workspace_vpce_service
219223
vpc_endpoint_type = "Interface"
220224
security_group_ids = [aws_security_group.dataplane_vpce.id]
221225
subnet_ids = [aws_subnet.dataplane_vpce.id]
222-
// private_dns_enabled = var.private_dns_enabled
226+
private_dns_enabled = var.private_dns_enabled
223227
depends_on = [aws_subnet.dataplane_vpce]
224228
}
225229
@@ -229,7 +233,7 @@ resource "aws_vpc_endpoint" "relay" {
229233
vpc_endpoint_type = "Interface"
230234
security_group_ids = [aws_security_group.dataplane_vpce.id]
231235
subnet_ids = [aws_subnet.dataplane_vpce.id]
232-
// private_dns_enabled = var.private_dns_enabled
236+
private_dns_enabled = var.private_dns_enabled
233237
depends_on = [aws_subnet.dataplane_vpce]
234238
}
235239
@@ -252,8 +256,6 @@ resource "databricks_mws_vpc_endpoint" "relay" {
252256
}
253257
```
254258

255-
Once the VPC endpoints are created, they can be supplied in the [databricks_mws_networks](../resources/mws_networks.md) resource for workspace creation with AWS PrivateLink. After the `terraform apply` is run once (see the comment in the `aws_vpc_endpoint` resource above), run the terraform apply a second time with the line for `private_dns_enabled` set to true uncommented to set the proper DNS settings for PrivateLink. For understanding the reason that this needs to be applied twice, see this existing [issue](https://github.com/hashicorp/terraform-provider-aws/issues/7148) in the underlying AWS provider.
256-
257259
```hcl
258260
resource "databricks_mws_networks" "this" {
259261
provider = databricks.mws

docs/resources/grants.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ resource "databricks_grants" "things" {
8484

8585
## Table grants
8686

87-
You can grant `MODIFY` and `SELECT` privileges to [*`catalog`*.*`schema`*.*`table`*](table.md) specified in the `table` attribute. You can define a table through [databricks_table](table.md) resource.
87+
You can grant `MODIFY` and `SELECT` privileges to [*`catalog`*.*`schema`*.*`table`*](tables.md) specified in the `table` attribute.
8888

8989
```hcl
9090
resource "databricks_grants" "customers" {
@@ -122,7 +122,7 @@ resource "databricks_grants" "things" {
122122

123123
## View grants
124124

125-
You can grant `SELECT` privileges to [*`catalog`*.*`schema`*.*`view`*](table.md) specified in `table` attribute. You can define a view through [databricks_table](table.md) resource.
125+
You can grant `SELECT` privileges to [*`catalog`*.*`schema`*.*`view`*](views.md) specified in `table` attribute.
126126

127127
```hcl
128128
resource "databricks_grants" "customer360" {

docs/resources/group.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Security"
55

66
This resource allows you to manage [groups in Databricks Workspace](https://docs.databricks.com/administration-guide/users-groups/groups.html), [Databricks Account Console](https://accounts.cloud.databricks.com/) or [Azure Databricks Account Console](https://accounts.azuredatabricks.net). You can also [associate](group_member.md) Databricks users and [service principals](service_principal.md) to groups. This is useful if you are using an application to sync users & groups with SCIM API.
77

8-
To create groups in the Databricks account, the provider must be configured with `host = "https://accounts.cloud.databricks.com"` on AWS deployments or `host = "https://accounts.azuredatabricks.net"` and authenticate using AAD tokens on Azure deployments
8+
To create groups in the Databricks account, the provider must be configured with `host = "https://accounts.cloud.databricks.com"` on AWS deployments or `host = "https://accounts.azuredatabricks.net"` and authenticate using [AAD tokens](https://registry.terraform.io/providers/databricks/databricks/latest/docs#special-configurations-for-azure) on Azure deployments
99

1010
Recommended to use along with Identity Provider SCIM provisioning to populate users into those groups:
1111

docs/resources/group_member.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ subcategory: "Security"
55

66
This resource allows you to attach [users](user.md), [service_principal](service_principal.md), and [groups](group.md) as group members.
77

8-
To attach members to groups in the Databricks account, the provider must be configured with `host = "https://accounts.cloud.databricks.com"` on AWS deployments or `host = "https://accounts.azuredatabricks.net"` and authenticate using AAD tokens on Azure deployments
8+
To attach members to groups in the Databricks account, the provider must be configured with `host = "https://accounts.cloud.databricks.com"` on AWS deployments or `host = "https://accounts.azuredatabricks.net"` and authenticate using [AAD tokens](https://registry.terraform.io/providers/databricks/databricks/latest/docs#special-configurations-for-azure) on Azure deployments
99

1010
## Example Usage
1111

docs/resources/metastore.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ resource "databricks_metastore_assignment" "this" {
4848
The following arguments are required:
4949

5050
* `name` - Name of metastore.
51-
* `storage_root` - Path on cloud storage account, where managed [databricks_table](table.md) are stored. Change forces creation of a new resource.
51+
* `storage_root` - Path on cloud storage account, where managed `databricks_table` are stored. Change forces creation of a new resource.
5252
* `owner` - (Optional) Username/groupname/sp application_id of the metastore owner.
5353
* `delta_sharing_scope` - (Optional) Required along with `delta_sharing_recipient_token_lifetime_in_seconds`. Used to enable delta sharing on the metastore. Valid values: INTERNAL, INTERNAL_AND_EXTERNAL.
5454
* `delta_sharing_recipient_token_lifetime_in_seconds` - (Optional) Required along with `delta_sharing_scope`. Used to set expiration duration in seconds on recipient data access tokens. Set to 0 for unlimited duration.

0 commit comments

Comments
 (0)