Skip to content

Commit b2028c0

Browse files
committed
Minor documentation fixes
1 parent cdef6f9 commit b2028c0

File tree

5 files changed

+19
-17
lines changed

5 files changed

+19
-17
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 0.3.0
44

5-
* Added global timeout for resource provisioning, which defaults to 15 minutes.
5+
* Added configurable provisioning timeout for `databricks_mws_workspaces`, so that local DNS cache issues would be more tolerated.
66
* Added [databricks_current_user] to simplify applying the same Terraform configuration by different users in the shared workspace for testing purposes.
77
* Added client-side rate limiting to release the pressure on backend APIs and prevent client blocking ([#465](https://github.com/databrickslabs/terraform-provider-databricks/pull/465))
88
* Member usernames, group names and instance profile names in `databricks_group` data source are now sorted and providing consistent behavior between runs ([#449](https://github.com/databrickslabs/terraform-provider-databricks/issues/449))

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,11 @@ We happily welcome contributions to databricks-terraform. We use GitHub Issues t
2121

2222
The following command (tested on Ubuntu 20.04) will install `make`, `golang`, `git` with all of the dependent packages as well as Databricks Terrafrom provider from sources. Required version of GoLang is at least 1.13. Required version of terraform is at least 0.12.
2323

24+
On MacOS X, you can install GoLang through `brew install go`, on Debian-based Linux, you can install it by `sudo apt-get install golang -y`.
25+
2426
```bash
25-
sudo apt-get update
26-
sudo apt-get install make golang git -y
2727
git clone https://github.com/databrickslabs/terraform-provider-databricks.git
2828
cd terraform-provider-databricks
29-
make vendor
3029
make install
3130
```
3231

@@ -43,6 +42,8 @@ terraform {
4342
}
4443
```
4544

45+
Most likely, `terraform init -upgrade -verify-plugins=false -lock=false` would be a very great command to use.
46+
4647
## Developing provider
4748

4849
After installing necessary software for building provider from sources, you should install `golangci-lint` and `gotestsum` in order to run `make test`.

common/http.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ func (c *DatabricksClient) genericQuery(ctx context.Context, method, requestURL
435435
headers := ""
436436
if c.DebugHeaders {
437437
for k, v := range request.Header {
438-
headers += fmt.Sprintf("\n * %s: %s", k, onlyNBytes(strings.Join(v, ""), 16))
438+
headers += fmt.Sprintf("\n * %s: %s", k, onlyNBytes(strings.Join(v, ""), c.DebugTruncateBytes))
439439
}
440440
if len(headers) > 0 {
441441
headers += "\n"

docs/guides/aws-workspace.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
## Provider initialization for E2 workspaces
44

5-
This guide assumes you have `username` and `password` for [https://accounts.cloud.databricks.com](https://accounts.cloud.databricks.com) and can find `account_id` in the top right corner of the page, once you're logged in. This guide is provided as is and assumes you'll use it as the basis for your setup.
5+
This guide assumes you have `databricks_account_username` and `databricks_account_password` for [https://accounts.cloud.databricks.com](https://accounts.cloud.databricks.com) and can find `databricks_account_id` in the top right corner of the page, once you're logged in. This guide is provided as is and assumes you'll use it as the basis for your setup.
66

77
```hcl
8-
variable "username" {}
9-
variable "password" {}
10-
variable "account_id" {}
8+
variable "databricks_account_username" {}
9+
variable "databricks_account_password" {}
10+
variable "databricks_account_id" {}
1111
1212
variable "cidr_block" {
1313
default = "10.4.0.0/16"
@@ -27,7 +27,7 @@ locals {
2727
prefix = "databricks${random_string.naming.result}"
2828
tags = {
2929
Environment = "Demo"
30-
Owner = var.username
30+
Owner = var.databricks_account_username
3131
}
3232
}
3333
```
@@ -52,8 +52,8 @@ provider "aws" {
5252
provider "databricks" {
5353
alias = "mws"
5454
host = "https://accounts.cloud.databricks.com"
55-
username = var.username
56-
password = var.password
55+
databricks_account_username = var.databricks_account_username
56+
databricks_account_password = var.databricks_account_password
5757
}
5858
```
5959

@@ -64,7 +64,7 @@ Cross-account IAM role is registered with [databricks_mws_credentials](../resour
6464
```hcl
6565
6666
data "databricks_aws_assume_role_policy" "this" {
67-
external_id = var.account_id
67+
external_id = var.databricks_account_id
6868
}
6969
7070
resource "aws_iam_role" "cross_account_role" {
@@ -85,7 +85,7 @@ resource "aws_iam_role_policy" "this" {
8585
8686
resource "databricks_mws_credentials" "this" {
8787
provider = databricks.mws
88-
account_id = var.account_id
88+
databricks_account_id = var.databricks_account_id
8989
role_arn = aws_iam_role.cross_account_role.arn
9090
credentials_name = "${local.prefix}-creds"
9191
depends_on = [aws_iam_role_policy.this]
@@ -261,7 +261,7 @@ resource "aws_security_group" "this" {
261261
262262
resource "databricks_mws_networks" "this" {
263263
provider = databricks.mws
264-
account_id = var.account_id
264+
databricks_account_id = var.databricks_account_id
265265
network_name = "${local.prefix}-network"
266266
subnet_ids = [aws_subnet.private.id, aws_subnet.private_secondary.id]
267267
vpc_id = aws_vpc.main.id
@@ -303,7 +303,7 @@ resource "aws_s3_bucket_policy" "root_bucket_policy" {
303303
304304
resource "databricks_mws_storage_configurations" "this" {
305305
provider = databricks.mws
306-
account_id = var.account_id
306+
databricks_account_id = var.databricks_account_id
307307
bucket_name = aws_s3_bucket.root_storage_bucket.bucket
308308
storage_configuration_name = "${local.prefix}-storage"
309309
}
@@ -316,7 +316,7 @@ Once you have [VPC](#vpc), [cross-account role](#cross-account-iam-role), and [r
316316
```hcl
317317
resource "databricks_mws_workspaces" "this" {
318318
provider = databricks.mws
319-
account_id = var.account_id
319+
databricks_account_id = var.databricks_account_id
320320
aws_region = var.region
321321
workspace_name = local.prefix
322322
deployment_name = local.prefix

scripts/azsp-integration/main.tf

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ output "test_key_vault_secret" {
9292
}
9393

9494
output "test_key_vault_secret_value" {
95+
sensitive = true
9596
value = module.this.test_key_vault_secret_value
9697
}
9798

0 commit comments

Comments
 (0)