Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for Unity Catalog new permissions model #1657

Merged
merged 35 commits into from
Oct 7, 2022

Conversation

nkvuong
Copy link
Contributor

@nkvuong nkvuong commented Oct 6, 2022

This closes #1642, #1656

nkvuong and others added 25 commits September 20, 2022 11:07
DBSQL resources are organized in a workspace structure as of recently.
As such it is no longer possible to use the same name for different
assets. This acceptance test used to use the same name for both
the dashboard and the query and started failing. The solution here
is to use a different suffix for the different resources.
aws_iam_policy.unity_metastore is referencing
aws_s3_bucket.unity_metastore.arn, which is non-existent.
Fix to use aws_s3_bucket.metastore.arn instead. This also
matches with the online tutorial.

https://docs.databricks.com/data-governance/unity-catalog/automate.html
Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.95.0 to 0.96.0.
- [Release notes](https://github.com/googleapis/google-api-go-client/releases)
- [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md)
- [Commits](googleapis/google-api-go-client@v0.95.0...v0.96.0)

---
updated-dependencies:
- dependency-name: google.golang.org/api
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
….0 (#1611)

Bumps [github.com/hashicorp/terraform-plugin-sdk/v2](https://github.com/hashicorp/terraform-plugin-sdk) from 2.22.0 to 2.23.0.
- [Release notes](https://github.com/hashicorp/terraform-plugin-sdk/releases)
- [Changelog](https://github.com/hashicorp/terraform-plugin-sdk/blob/main/CHANGELOG.md)
- [Commits](hashicorp/terraform-plugin-sdk@v2.22.0...v2.23.0)

---
updated-dependencies:
- dependency-name: github.com/hashicorp/terraform-plugin-sdk/v2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…1610)

Co-authored-by: Alex Ott <alexey.ott@databricks.com>
* Fix Azure authentication for dev and staging workspaces
* use env variable
* Fix client attributes tests
* Rename AzureDatabricksResourceId to AzureDatabricksLoginAppId
* Simplify GetAzureDatabricksLoginAppId
* Fixed errors in docs
* Fixed Azure SPOT and elastic disk
* Added fallback on SPOT_AZURE configuration
# Version changelog

## 1.3.1

 * Added autoscale `mode` configuration to [databricks_pipeline](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/pipeline) resource ([#1600](#1600)).
 * Fixed `gcp_availability` field in [databricks_insance_pool](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/insance_pool) resource ([#1610](#1610)).
 * Fixed `secret` field name in [databricks_mlflow_webhook](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/mlflow_webhook) resource ([#1625](#1625)).
 * Further improvements of exporter ([#1602](#1602)).

 Documentation improvements:
 
 * Updates for [databricks_table](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/table) and [databricks_mws_vpc_endpoint](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/mws_vpc_endpoint) ([#1616](#1616)).
 * Document `http_timeout_seconds` from `common/client.go` ([#1599](#1599)).
 * Expand `parameter` documentation for [databricks_sql_query](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/sql_query) resource ([#1603](#1603)).
 * Updated Unity Catalog docs ([#1605](#1605), [#1626](#1626), [#1620](#1620)).

 Updated dependency versions:

 * Bump github.com/hashicorp/terraform-plugin-sdk/v2 from 2.21.0 to 2.23.0 ([#1597](#1597), [#1611](#1611)).
 * Bump google.golang.org/api from 0.94.0 to 0.96.0 ([#1598](#1598), [#1612](#1612)).
Bumps [github.com/hashicorp/hcl/v2](https://github.com/hashicorp/hcl) from 2.14.0 to 2.14.1.
- [Release notes](https://github.com/hashicorp/hcl/releases)
- [Changelog](https://github.com/hashicorp/hcl/blob/main/CHANGELOG.md)
- [Commits](hashicorp/hcl@v2.14.0...v2.14.1)

---
updated-dependencies:
- dependency-name: github.com/hashicorp/hcl/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.96.0 to 0.97.0.
- [Release notes](https://github.com/googleapis/google-api-go-client/releases)
- [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md)
- [Commits](googleapis/google-api-go-client@v0.96.0...v0.97.0)

---
updated-dependencies:
- dependency-name: google.golang.org/api
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* expand documentation for `options` field in `sql-visualization` resource
* add wording for how to restore during issue scenario
Example: Getting the existing cluster id of specific databricks_job by name or by id:

```
data "databricks_job" "this" {
  job_name = "My job"
}
output "cluster_id" {
  value     = data.databricks_job.job_settings.existing_cluster_id
  sensitive = false
}
```

Co-authored-by: Serge Smertin <259697+nfx@users.noreply.github.com>
@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2022

Codecov Report

Merging #1657 (fe13157) into master (2f6b12f) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1657   +/-   ##
=======================================
  Coverage   90.01%   90.01%           
=======================================
  Files         136      136           
  Lines       10858    10858           
=======================================
  Hits         9774     9774           
  Misses        694      694           
  Partials      390      390           
Impacted Files Coverage Δ
catalog/resource_grants.go 96.03% <ø> (ø)

@nfx nfx self-assigned this Oct 7, 2022
@nfx nfx self-requested a review October 7, 2022 10:57
nfx and others added 6 commits October 7, 2022 12:09
author Serge Smertin <259697+nfx@users.noreply.github.com> 1664570116 -0700
committer Vuong Nguyen <vuong.nguyen@databricks.com> 1665140905 +0100

parent 06af47b
author Serge Smertin <259697+nfx@users.noreply.github.com> 1664570116 -0700
committer Vuong Nguyen <vuong.nguyen@databricks.com> 1665140865 +0100

parent 06af47b
author Serge Smertin <259697+nfx@users.noreply.github.com> 1664570116 -0700
committer Vuong Nguyen <vuong.nguyen@databricks.com> 1665140826 +0100

parent 06af47b
author Serge Smertin <259697+nfx@users.noreply.github.com> 1664570116 -0700
committer Vuong Nguyen <vuong.nguyen@databricks.com> 1665140786 +0100

Release 1.4.0 (#1650)

remove databricks_table resource from doc

fix following suggestions

update docs to match new privilege model

Fix dashboard acceptance test (#1618)

DBSQL resources are organized in a workspace structure as of recently.
As such it is no longer possible to use the same name for different
assets. This acceptance test used to use the same name for both
the dashboard and the query and started failing. The solution here
is to use a different suffix for the different resources.

Fix unity catalog docs to use correct metastore (#1620)

aws_iam_policy.unity_metastore is referencing
aws_s3_bucket.unity_metastore.arn, which is non-existent.
Fix to use aws_s3_bucket.metastore.arn instead. This also
matches with the online tutorial.

https://docs.databricks.com/data-governance/unity-catalog/automate.html

fix `secret` field name in `databricks_mlflow_webhook` resource (#1625)

fixes #1621

Fixed `gcp_availability` field in `databricks_insance_pool` resource (#1610)

Co-authored-by: Alex Ott <alexey.ott@databricks.com>

Add autoscale `mode` configuration to `databricks_pipeline` resource (#1600)

Fix Azure authentication for dev and staging workspaces (#1607)

* Fix Azure authentication for dev and staging workspaces
* use env variable
* Fix client attributes tests
* Rename AzureDatabricksResourceId to AzureDatabricksLoginAppId
* Simplify GetAzureDatabricksLoginAppId

Fixed minor errors in Unity Catalog docs (#1626)

* Fixed errors in docs
* Fixed Azure SPOT and elastic disk
* Added fallback on SPOT_AZURE configuration

Bump github.com/hashicorp/hcl/v2 from 2.14.0 to 2.14.1 (#1634)

Bumps [github.com/hashicorp/hcl/v2](https://github.com/hashicorp/hcl) from 2.14.0 to 2.14.1.
- [Release notes](https://github.com/hashicorp/hcl/releases)
- [Changelog](https://github.com/hashicorp/hcl/blob/main/CHANGELOG.md)
- [Commits](hashicorp/hcl@v2.14.0...v2.14.1)

---
updated-dependencies:
- dependency-name: github.com/hashicorp/hcl/v2
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bump google.golang.org/api from 0.96.0 to 0.97.0 (#1633)

Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.96.0 to 0.97.0.
- [Release notes](https://github.com/googleapis/google-api-go-client/releases)
- [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md)
- [Commits](googleapis/google-api-go-client@v0.96.0...v0.97.0)

---
updated-dependencies:
- dependency-name: google.golang.org/api
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Correct handling of references in `databricks_permissions` resources (#1631)

this fixes #1628

expand documentation for `databricks_sql_visualization` resource (#1630)

* expand documentation for `options` field in `sql-visualization` resource
* add wording for how to restore during issue scenario

Prevent stripping of `CAN_MANAGE` permission from caller of `databricks_sql_query` resource (#1644)

Make debugging work again (#1560)

Fix test for `databricks_job` data source (#1649)
Bumps [google.golang.org/api](https://github.com/googleapis/google-api-go-client) from 0.97.0 to 0.98.0.
- [Release notes](https://github.com/googleapis/google-api-go-client/releases)
- [Changelog](https://github.com/googleapis/google-api-go-client/blob/main/CHANGES.md)
- [Commits](googleapis/google-api-go-client@v0.97.0...v0.98.0)

---
updated-dependencies:
- dependency-name: google.golang.org/api
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
docs/resources/grants.md Outdated Show resolved Hide resolved
docs/resources/grants.md Show resolved Hide resolved
@nfx nfx enabled auto-merge (squash) October 7, 2022 12:00
@nfx nfx merged commit d0fecab into master Oct 7, 2022
@nfx nfx deleted the docs/update_uc branch October 7, 2022 12:02
@nfx nfx mentioned this pull request Oct 10, 2022
michael-berk pushed a commit to michael-berk/terraform-provider-databricks that referenced this pull request Feb 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Incorrect documentation on UC