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

[Doc] Add guide for OIDC authentication #4016

Merged
merged 4 commits into from
Sep 18, 2024
Merged

[Doc] Add guide for OIDC authentication #4016

merged 4 commits into from
Sep 18, 2024

Conversation

mgyucht
Copy link
Contributor

@mgyucht mgyucht commented Sep 13, 2024

Changes

To encourage users to follow best security practices, we recommend authenticating to Databricks using OIDC where possible. This PR introduces a guide for setting up OIDC from GitHub Actions and Azure DevOps when authenticating to Azure and GCP Databricks.

Currently, Databricks on AWS doesn't support OIDC authentication natively.

Tests

  • The GCP configuration is used internally already; this just documents how we've set up OIDC. Thanks @hectorcast-db!
  • The Azure configuration still needs to be tested.

@mgyucht mgyucht requested review from a team as code owners September 13, 2024 11:56
@mgyucht mgyucht requested review from tanmay-db and removed request for a team September 13, 2024 11:56
docs/guides/azure-authenticate-with-oidc.md Outdated Show resolved Hide resolved
docs/guides/gcp-authenticate-with-oidc.md Outdated Show resolved Hide resolved
docs/guides/gcp-authenticate-with-oidc.md Outdated Show resolved Hide resolved
@mgyucht
Copy link
Contributor Author

mgyucht commented Sep 18, 2024

Merging this for now, will accept feedback on it if there are any bugs that need correction.

@mgyucht mgyucht added this pull request to the merge queue Sep 18, 2024
Merged via the queue into main with commit af46555 Sep 18, 2024
7 checks passed
@mgyucht mgyucht deleted the oidc-guide branch September 18, 2024 11:44
parthban-db added a commit that referenced this pull request Oct 6, 2024
### New Features and Improvements

 * Add `databricks_budget` resource ([#3955](#3955)).
 * Add `databricks_mlflow_models` data source ([#3874](#3874)).
 * Add computed attribute `table_serving_url` to `databricks_online_table` ([#4048](#4048)).
 * Add support for Identity Column in `databricks_sql_table` ([#4035](#4035)).

### Bug Fixes

 * Fix Permissions Dashboard Test ([#4071](#4071)).
 * Ignore presence or absence of `/Workspace` prefix for dashboard resource ([#4061](#4061)).
 * Refactor `databricks_permissions` and allow the current user to set their own permissions ([#3956](#3956)).
 * Set ID for online table resource if creation succeeds but it isn't available yet ([#4072](#4072)).

### Documentation

 * Add guide for OIDC authentication ([#4016](#4016)).
 * Correctly use native markdown callouts supported by TF Registry ([#4073](#4073)).
 * Fixing links to `databricks_service_principal` in TF guides ([#4020](#4020)).

### Internal Changes

 * Bump Go SDK to latest and generate TF structs  ([#4062](#4062)).
 * Skip Budget tests on GCP ([#4070](#4070)).
 * Update to latest OpenAPI spec and bump Go SDK ([#4069](#4069)).
parthban-db added a commit that referenced this pull request Oct 7, 2024
### New Features and Improvements

 * Add `databricks_budget` resource ([#3955](#3955)).
 * Add `databricks_mlflow_models` data source ([#3874](#3874)).
 * Add computed attribute `table_serving_url` to `databricks_online_table` ([#4048](#4048)).
 * Add support for Identity Column in `databricks_sql_table` ([#4035](#4035)).

### Bug Fixes

 * Fix Permissions Dashboard Test ([#4071](#4071)).
 * Ignore presence or absence of `/Workspace` prefix for dashboard resource ([#4061](#4061)).
 * Refactor `databricks_permissions` and allow the current user to set their own permissions ([#3956](#3956)).
 * Set ID for online table resource if creation succeeds but it isn't available yet ([#4072](#4072)).

### Documentation

 * Add guide for OIDC authentication ([#4016](#4016)).
 * Correctly use native markdown callouts supported by TF Registry ([#4073](#4073)).
 * Fixing links to `databricks_service_principal` in TF guides ([#4020](#4020)).

### Internal Changes

 * Bump Go SDK to latest and generate TF structs  ([#4062](#4062)).
 * Skip Budget tests on GCP ([#4070](#4070)).
 * Update to latest OpenAPI spec and bump Go SDK ([#4069](#4069)).
github-merge-queue bot pushed a commit that referenced this pull request Oct 7, 2024
### New Features and Improvements

* Add `databricks_budget` resource
([#3955](#3955)).
* Add `databricks_mlflow_models` data source
([#3874](#3874)).
* Add computed attribute `table_serving_url` to
`databricks_online_table`
([#4048](#4048)).
* Add support for Identity Column in `databricks_sql_table`
([#4035](#4035)).


### Bug Fixes

* Add Sufficient Network Privileges to the Databricks Default Cross
Account Policy
([#4027](#4027))
* Ignore presence or absence of `/Workspace` prefix for dashboard
resource
([#4061](#4061)).
* Refactor `databricks_permissions` and allow the current user to set
their own permissions
([#3956](#3956)).
* Set ID for online table resource if creation succeeds but it isn't
available yet
([#4072](#4072)).


### Documentation

* Update CONTRIBUTING guide for plugin framework resources
([#4078](#4078))
* Add guide for OIDC authentication
([#4016](#4016)).
* Correctly use native markdown callouts supported by TF Registry
([#4073](#4073)).
* Fixing links to `databricks_service_principal` in TF guides
([#4020](#4020)).


### Internal Changes

* Fix Permissions Dashboard Test
([#4071](#4071)).
* Bump Go SDK to latest and generate TF structs
([#4062](#4062)).
* Skip Budget tests on GCP
([#4070](#4070)).
* Update to latest OpenAPI spec and bump Go SDK
([#4069](#4069)).
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.

2 participants