doc fixes (#2987)

nkvuong · web-flow · commit 18b0585844cb · 2023-12-04T12:49:58.000Z
diff --git a/docs/guides/aws-private-link-workspace.md b/docs/guides/aws-private-link-workspace.md
@@ -300,5 +300,3 @@ resource "databricks_mws_workspaces" "this" {
   depends_on                 = [databricks_mws_networks.this]
 }
 ```
-
-
diff --git a/docs/guides/gcp-private-service-connect-workspace.md b/docs/guides/gcp-private-service-connect-workspace.md
@@ -15,6 +15,7 @@ To work with Databricks in GCP in an automated way, please create a service acco
 The very first step is VPC creation with the necessary resources. Please consult [main documentation page](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/customer-managed-vpc.html) for **the most complete and up-to-date details on networking**. A GCP VPC is registered as [databricks_mws_networks](../resources/mws_networks.md) resource.
 
 To enable [back-end Private Service Connect (data plane to control plane)](https://docs.gcp.databricks.com/administration-guide/cloud-configurations/gcp/private-service-connect.html#two-private-service-connect-options), configure the network with the two back-end VPC endpoints:
+
 - Back-end VPC endpoint for [Secure cluster connectivity](https://docs.gcp.databricks.com/security/secure-cluster-connectivity.html) relay
 - Back-end VPC endpoint for REST APIs
 
@@ -98,7 +99,7 @@ resource "databricks_mws_networks" "this" {
 
 ## Creating a Databricks Workspace
 
-Once [the VPC](#creating-a-vpc) is set up, you can create Databricks workspace through [databricks_mws_workspaces](../resources/mws_workspaces.md) resource.
+Once [the VPC](#creating-a-vpc-network) is set up, you can create Databricks workspace through [databricks_mws_workspaces](../resources/mws_workspaces.md) resource.
 
 For a workspace to support any of the Private Service Connect connectivity scenarios, the workspace must be created with an attached [databricks_mws_private_access_settings](../resources/mws_private_access_settings.md) resource.
 
@@ -126,7 +127,7 @@ resource "databricks_mws_workspaces" "this" {
     }
   }
 
-  private_service_connect_id = databricks_mws_private_access_settings.pas.private_access_settings_id
+  private_access_settings_id = databricks_mws_private_access_settings.pas.private_access_settings_id
   network_id                 = databricks_mws_networks.this.network_id
   gke_config {
     connectivity_type = "PRIVATE_NODE_PUBLIC_MASTER"
diff --git a/docs/guides/unity-catalog-azure.md b/docs/guides/unity-catalog-azure.md
@@ -7,6 +7,9 @@ page_title: "Unity Catalog set up on Azure"
 **Note**
 If your workspace was enabled for Unity Catalog automatically, this guide does not apply to you.
 
+**Note**
+Except for metastore, metastore assignment and storage credential objects, Unity Catalog APIs are accessible via **workspace-level APIs**. This design may change in the future.
+
 Databricks Unity Catalog brings fine-grained governance and security to Lakehouse data using a familiar, open interface. You can use Terraform to deploy the underlying cloud resources and Unity Catalog objects automatically, using a programmatic approach.
 
 This guide creates a metastore without a storage root location or credential to maintain strict separation of storage across catalogs or environments.
diff --git a/docs/guides/unity-catalog-gcp.md b/docs/guides/unity-catalog-gcp.md
@@ -7,6 +7,9 @@ page_title: "Unity Catalog set up on Google Cloud"
 **Note**
 If your workspace was enabled for Unity Catalog automatically, this guide does not apply to you.
 
+**Note**
+Except for metastore, metastore assignment and storage credential objects, Unity Catalog APIs are accessible via **workspace-level APIs**. This design may change in the future.
+
 Databricks Unity Catalog brings fine-grained governance and security to Lakehouse data using a familiar, open interface. You can use Terraform to deploy the underlying cloud resources and Unity Catalog objects automatically, using a programmatic approach.
 
 This guide creates a metastore without a storage root location or credential to maintain strict separation of storage across catalogs or environments.
diff --git a/docs/guides/unity-catalog.md b/docs/guides/unity-catalog.md
@@ -7,6 +7,9 @@ page_title: "Unity Catalog set up on AWS"
 **Note**
 If your workspace was enabled for Unity Catalog automatically, this guide does not apply to you.
 
+**Note**
+Except for metastore, metastore assignment and storage credential objects, Unity Catalog APIs are accessible via **workspace-level APIs**. This design may change in the future.
+
 Databricks Unity Catalog brings fine-grained governance and security to Lakehouse data using a familiar, open interface. You can use Terraform to deploy the underlying cloud resources and Unity Catalog objects automatically, using a programmatic approach.
 
 This guide creates a metastore without a storage root location or credential to maintain strict separation of storage across catalogs or environments.
diff --git a/docs/index.md b/docs/index.md
@@ -139,7 +139,7 @@ There are currently a number of supported methods to [authenticate](https://docs
 
 ### Authenticating with Databricks CLI credentials
 
-No configuration options given to your provider will look up configured credentials in `~/.databrickscfg` file. It is created by the `databricks configure --token` command. Check [this page](https://docs.databricks.com/dev-tools/cli/index.html#set-up-authentication)
+If no configuration option is given, the provider will look up configured credentials in `~/.databrickscfg` file. It is created by the `databricks configure --token` command. Check [this page](https://docs.databricks.com/dev-tools/cli/index.html#set-up-authentication)
 for more details. The provider uses config file credentials only when `host`/`token` or `azure_auth` options are not specified.
 It is the recommended way to use Databricks Terraform provider, in case you're already using the same approach with
 [AWS Shared Credentials File](https://www.terraform.io/docs/providers/aws/index.html#shared-credentials-file)
@@ -257,7 +257,7 @@ resource "databricks_group" "cluster_admin" {
 
 ## Special configurations for Azure
 
-The provider works with [Azure CLI authentication](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) to facilitate local development workflows, though for automated scenarios a service principal auth is necessary (and specification of `azure_use_msi`, `azure_client_id`, `azure_client_secret` and `azure_tenant_id` parameters).
+The below Azure authentication options are supported at both the account and workspace levels. The provider works with [Azure CLI authentication](https://docs.microsoft.com/en-us/cli/azure/authenticate-azure-cli?view=azure-cli-latest) to facilitate local development workflows, though for automated scenarios, managed identity or service principal auth is recommended (and specification of `azure_use_msi`, `azure_client_id`, `azure_client_secret` and `azure_tenant_id` parameters).
 
 ### Authenticating with Azure MSI
 
@@ -349,7 +349,7 @@ The provider works with [Google Cloud CLI authentication](https://cloud.google.c
 
 Except for metastore, metastore assignment and storage credential objects, Unity Catalog APIs are accessible via **workspace-level APIs**. This design may change in the future.
 
-If you are configuring a new Databricks account for the first time, please create at least one workspace and with an identity (user or service principal) that you intend to use for Unity Catalog rollout. You can then configure the provider using that identity and workspace to provision the required Unity Catalog resources.
+If you are configuring a new Databricks account for the first time, please create at least one workspace with an identity (user or service principal) that you intend to use for Unity Catalog rollout. You can then configure the provider using that identity and workspace to provision the required Unity Catalog resources.
 
 ## Miscellaneous configuration parameters
 
diff --git a/docs/resources/catalog.md b/docs/resources/catalog.md
@@ -41,6 +41,7 @@ The following arguments are required:
 In addition to all arguments above, the following attributes are exported:
 
 * `id` - ID of this catalog - same as the `name`.
+* `metastore_id` - ID of the metastore.
 
 ## Import
 
@@ -54,6 +55,6 @@ terraform import databricks_catalog.this <name>
 
 The following resources are used in the same context:
 
-* [databricks_table](../data-sources/tables.md) data to list tables within Unity Catalog.
-* [databricks_schema](../data-sources/schemas.md) data to list schemas within Unity Catalog.
-* [databricks_catalog](../data-sources/catalogs.md) data to list catalogs within Unity Catalog.
+* [databricks_tables](../data-sources/tables.md) data to list tables within Unity Catalog.
+* [databricks_schemas](../data-sources/schemas.md) data to list schemas within Unity Catalog.
+* [databricks_catalogs](../data-sources/catalogs.md) data to list catalogs within Unity Catalog.
diff --git a/docs/resources/job.md b/docs/resources/job.md
@@ -91,8 +91,6 @@ The resource supports the following arguments:
   ```
 
 * `library` - (Optional) (Set) An optional list of libraries to be installed on the cluster that will execute the job. Please consult [libraries section](cluster.md#libraries) for [databricks_cluster](cluster.md) resource.
-* `retry_on_timeout` - (Optional) (Bool) An optional policy to specify whether to retry a job when it times out. The default behavior is to not retry on timeout.
-* `max_retries` - (Optional) (Integer) An optional maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it completes with a `FAILED` or `INTERNAL_ERROR` lifecycle state. The value -1 means to retry indefinitely and the value 0 means to never retry. The default behavior is to never retry.
 * `timeout_seconds` - (Optional) (Integer) An optional timeout applied to each run of this job. The default behavior is to have no timeout.
 * `min_retry_interval_millis` - (Optional) (Integer) An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. The default behavior is that unsuccessful runs are immediately retried.
 * `max_concurrent_runs` - (Optional) (Integer) An optional maximum allowed number of concurrent runs of the job. Defaults to *1*.
diff --git a/docs/resources/provider.md b/docs/resources/provider.md
@@ -46,6 +46,6 @@ In addition to all arguments above, the following attributes are exported:
 
 The following resources are used in the same context:
 
-* [databricks_table](../data-sources/tables.md) data to list tables within Unity Catalog.
-* [databricks_schema](../data-sources/schemas.md) data to list schemas within Unity Catalog.
-* [databricks_catalog](../data-sources/catalogs.md) data to list catalogs within Unity Catalog.
+* [databricks_tables](../data-sources/tables.md) data to list tables within Unity Catalog.
+* [databricks_schemas](../data-sources/schemas.md) data to list schemas within Unity Catalog.
+* [databricks_catalogs](../data-sources/catalogs.md) data to list catalogs within Unity Catalog.
diff --git a/docs/resources/schema.md b/docs/resources/schema.md
@@ -59,6 +59,6 @@ terraform import databricks_schema.this <catalog_name>.<name>
 
 The following resources are used in the same context:
 
-* [databricks_table](../data-sources/tables.md) data to list tables within Unity Catalog.
-* [databricks_schema](../data-sources/schemas.md) data to list schemas within Unity Catalog.
-* [databricks_catalog](../data-sources/catalogs.md) data to list catalogs within Unity Catalog.
+* [databricks_tables](../data-sources/tables.md) data to list tables within Unity Catalog.
+* [databricks_schemas](../data-sources/schemas.md) data to list schemas within Unity Catalog.
+* [databricks_catalogs](../data-sources/catalogs.md) data to list catalogs within Unity Catalog.

Original file line number	Diff line number	Diff line change
`@@ -300,5 +300,3 @@ resource "databricks_mws_workspaces" "this" {`
`300`	`300`	`depends_on = [databricks_mws_networks.this]`
`301`	`301`	`}`
`302`	`302`	```
`303`		`-`
`304`		`-`