Skip to content

Commit

Permalink
[Doc] Improve docs for Network Connectivity Config
Browse files Browse the repository at this point in the history
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
  • Loading branch information
alexott committed Jul 18, 2024
1 parent 9e8fd30 commit 4a92c38
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/resources/mws_ncc_binding.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ variable "prefix" {}
resource "databricks_mws_network_connectivity_config" "ncc" {
provider = databricks.account
name = "Network Connectivity Config for ${var.prefix}"
name = "ncc-for-${var.prefix}"
region = var.region
}
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/mws_ncc_private_endpoint_rule.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ variable "prefix" {}
resource "databricks_mws_network_connectivity_config" "ncc" {
provider = databricks.account
name = "Network Connectivity Config for ${var.prefix}"
name = "ncc-for-${var.prefix}"
region = var.region
}
Expand Down
15 changes: 13 additions & 2 deletions docs/resources/mws_network_connectivity_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ variable "prefix" {}
resource "databricks_mws_network_connectivity_config" "ncc" {
provider = databricks.account
name = "Network Connectivity Config for ${var.prefix}"
name = "ncc-for-${var.prefix}"
region = var.region
}
Expand All @@ -39,8 +39,19 @@ The following arguments are available:

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

* `id` - combination of `account_id` and `network_connectivity_config_id` separated by `/` character
* `network_connectivity_config_id` - Canonical unique identifier of Network Connectivity Config in Databricks Account
* `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.
* `egress_conf` - block containing information about network connectivity rules that apply to network traffic from your serverless compute resources. Consists of the following fields:
* `default_rules` - block describing network connectivity rules that are applied by default without resource specific configurations. Consists of the following fields:
* `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:
* `cidr_blocks` - list of IP CIDR blocks.
* `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:
* `subnets` - list of subnets from which Databricks network traffic originates when accessing your Azure resources.
* `target_region` - the Azure region in which this service endpoint rule applies.
* `target_services` - the Azure services to which this service endpoint rule applies to.
* `target_rules` - block describing network connectivity rules that configured for each destinations. These rules override default rules. Consists of the following fields:
* `azure_private_endpoint_rules` (Azure only) - list containing information about configure Azure Private Endpoints.


## Import

Expand Down

0 comments on commit 4a92c38

Please sign in to comment.