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.

Sign up for GitHub

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

Jump to bottom

Added databricks_service_principal_secret documentation #2296

Merged
merged 5 commits into from
May 15, 2023
Merged

Added databricks_service_principal_secret documentation #2296

merged 5 commits into from
May 15, 2023

Conversation

jackyhu-db
Copy link
Contributor

@jackyhu-db jackyhu-db commented May 12, 2023 •
edited by alexott
Loading

Changes

  • Add the resource databricks_service_principal_secret into the docs/resources
  • Add the section Authenticating with hostname, client_id and client_secret in the docs/index.md

Tests

  • make test run locally
  • relevant change in docs/ folder
  • covered with integration tests in internal/acceptance
  • relevant acceptance tests are passing
  • using Go SDK

@jackyhu-db jackyhu-db requested a review from nfx May 12, 2023 01:37
@codecov-commenter
Copy link

Codecov Report

Merging #2296 (af53c18) into master (e431a01) will decrease coverage by 0.06%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2296      +/-   ##
==========================================
- Coverage   88.78%   88.72%   -0.06%     
==========================================
  Files         139      140       +1     
  Lines       11462    11551      +89     
==========================================
+ Hits        10176    10249      +73     
- Misses        861      869       +8     
- Partials      425      433       +8

see 10 files with indirect coverage changes

@alexott alexott requested review from a team May 12, 2023 06:20
alexott
alexott requested changes May 12, 2023
View reviewed changes
docs/index.md Outdated Show resolved Hide resolved
docs/resources/service_principal_secret.md Outdated Show resolved Hide resolved
docs/resources/service_principal_secret.md Outdated Show resolved Hide resolved
@jackyhu-db jackyhu-db requested a review from bryanmcq-db May 12, 2023 16:13
bryanmcq-db
bryanmcq-db approved these changes May 12, 2023
View reviewed changes
Copy link

@bryanmcq-db bryanmcq-db left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, thanks!

alexott
alexott approved these changes May 12, 2023
View reviewed changes
Copy link
Contributor

@alexott alexott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good, just one comment that we can add later

docs/resources/service_principal_secret.md Outdated

```hcl
resource "databricks_service_principal_secret" "terraform_sp" {
service_principal_id = "123456789012345"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can write this as to show that it refer to existing service principal:

service_principal_id = databricks_service_principal.this.id

@nfx nfx changed the title Update document with service principal secret support Added databricks_service_principal_secret documentation May 15, 2023
@nfx nfx merged commit 2b71739 into databricks:master May 15, 2023
nfx added a commit that referenced this pull request May 16, 2023
@nfx
Release v1.16.1
024055f 
# Version changelog

## 1.16.1

 * Added [databricks_service_principal_secret](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/service_principal_secret) documentation ([#2296](#2296)).
 * Documentation about Unity Catalog integration in [databricks_pipeline](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/pipeline) ([#2289](#2289)).
 * Exporter: don't emit [databricks_permissions](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/permissions) for `/Shared` directory ([#2288](#2288)).
 * Fix dependency when exporting [databricks_service_principal_role](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/service_principal_role) ([#2285](#2285)).
 * Removed reference to deprecated [databricks_group_instance_profile](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_instance_profile) from [databricks_group_role](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_role) docs ([#2290](#2290)).
 * Updated documentation for [databricks_secret_scope](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/secret_scope) resource ([#2297](#2297)).
@nfx nfx mentioned this pull request May 16, 2023
Merged
nfx added a commit that referenced this pull request May 16, 2023
@nfx
Release v1.16.1 (#2305)
318744f 
# Version changelog

## 1.16.1

 * Added [databricks_service_principal_secret](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/service_principal_secret) documentation ([#2296](#2296)).
 * Documentation about Unity Catalog integration in [databricks_pipeline](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/pipeline) ([#2289](#2289)).
 * Exporter: don't emit [databricks_permissions](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/permissions) for `/Shared` directory ([#2288](#2288)).
 * Fix dependency when exporting [databricks_service_principal_role](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/service_principal_role) ([#2285](#2285)).
 * Removed reference to deprecated [databricks_group_instance_profile](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_instance_profile) from [databricks_group_role](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/group_role) docs ([#2290](#2290)).
 * Updated documentation for [databricks_secret_scope](https://registry.terraform.io/providers/databricks/databricks/latest/docs/resources/secret_scope) resource ([#2297](#2297)).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bryanmcq-db bryanmcq-db bryanmcq-db approved these changes

@mgyucht mgyucht mgyucht approved these changes

@nfx nfx nfx approved these changes

@alexott alexott alexott approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jackyhu-db @codecov-commenter @alexott @nfx @mgyucht @bryanmcq-db