Skip to content

Commit 86e0e35

Browse files
authored
[Doc] Improve docs for Network Connectivity Config (#3794)
## Changes <!-- Summary of your changes that are easy to understand --> Changes include: * Document missing `egress_conf` attribute - the information about `default_rules.azure_service_endpoint_rule` was incorrect * Fix the name of NCC - we don't allow spaces in the name ## 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` - [ ] relevant acceptance tests are passing - [ ] using Go SDK
1 parent ab4fd40 commit 86e0e35

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

docs/resources/mws_ncc_binding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ variable "prefix" {}
1919
2020
resource "databricks_mws_network_connectivity_config" "ncc" {
2121
provider = databricks.account
22-
name = "Network Connectivity Config for ${var.prefix}"
22+
name = "ncc-for-${var.prefix}"
2323
region = var.region
2424
}
2525

docs/resources/mws_ncc_private_endpoint_rule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ variable "prefix" {}
1717
1818
resource "databricks_mws_network_connectivity_config" "ncc" {
1919
provider = databricks.account
20-
name = "Network Connectivity Config for ${var.prefix}"
20+
name = "ncc-for-${var.prefix}"
2121
region = var.region
2222
}
2323

docs/resources/mws_network_connectivity_config.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ variable "prefix" {}
1717
1818
resource "databricks_mws_network_connectivity_config" "ncc" {
1919
provider = databricks.account
20-
name = "Network Connectivity Config for ${var.prefix}"
20+
name = "ncc-for-${var.prefix}"
2121
region = var.region
2222
}
2323
@@ -39,8 +39,19 @@ The following arguments are available:
3939

4040
In addition to all arguments above, the following attributes are exported:
4141

42+
* `id` - combination of `account_id` and `network_connectivity_config_id` separated by `/` character
4243
* `network_connectivity_config_id` - Canonical unique identifier of Network Connectivity Config in Databricks Account
43-
* `default_rules.azure_service_endpoint_rule` - This provides a list of subnets. These subnets need to be allowed in your Azure resources in order for Databricks to access. See `default_rules.azure_service_endpoint_rule.target_services` for the supported Azure services.
44+
* `egress_conf` - block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:
45+
* `default_rules` - block describing network connectivity rules that are applied by default without resource specific configurations. Consists of the following fields:
46+
* `aws_stable_ip_rule` (AWS only) - block with information about stable AWS IP CIDR blocks. You can use these to configure the firewall of your resources to allow traffic from your Databricks workspace. Consists of the following fields:
47+
* `cidr_blocks` - list of IP CIDR blocks.
48+
* `azure_service_endpoint_rule` (Azure only) - block with information about stable Azure service endpoints. You can configure the firewall of your Azure resources to allow traffic from your Databricks serverless compute resources. Consists of the following fields:
49+
* `subnets` - list of subnets from which Databricks network traffic originates when accessing your Azure resources.
50+
* `target_region` - the Azure region in which this service endpoint rule applies.
51+
* `target_services` - the Azure services to which this service endpoint rule applies to.
52+
* `target_rules` - block describing network connectivity rules that configured for each destinations. These rules override default rules. Consists of the following fields:
53+
* `azure_private_endpoint_rules` (Azure only) - list containing information about configure Azure Private Endpoints.
54+
4455

4556
## Import
4657

0 commit comments

Comments
 (0)