topic Re: Can Terraform be used to set configurations in Admin / workspace settings? in Data Engineering

Can Terraform be used to set configurations in Admin / workspace settings?

nicole_wong — Wed, 22 Sep 2021 22:46:34 GMT

I am posting this on behalf of my customer. They are currently working on the deployment & config of their workspace on AWS via Terraform.

Is it possible to set some configs in the Admin/workspace settings via TF? According to the Terraform module, it isn’t.

https://registry.terraform.io/providers/databrickslabs/databricks/latest/docs/resources/workspace_conf#custom_config

The config settings we would like to automate are:

Access Control
- enable Table access control
Configure Personal Access Tokens to grant all users Can use access
Cluster
- enable Cluster Container Services
- enable EBS SSD gp3
Advanced
- enable Web terminal
- enable DBFS file browser

Re: Can Terraform be used to set configurations in Admin / workspace settings?

nicole_wong — Mon, 27 Sep 2021 17:08:07 GMT

Hi @Kaniz Fatma ! Following up on this question for my customer. I just recently learned that all of the config settings mentioned above can be accessed via our APIs. I'm not very familiar with Terraform, what additional information would be needed to enable TF to set those configurations via the APIs? Is this possible?

Thanks!

Re: Can Terraform be used to set configurations in Admin / workspace settings?

Ravi — Wed, 06 Oct 2021 22:39:18 GMT

Hi @Nicole Wong , can you try below options:

Access Control
- enable Table access control could not find a feature flag to enable this config via TF. Will update if I could find one.
Configure Personal Access Tokens to grant all users Can use access we can achieve this using https://registry.terraform.io/providers/databrickslabs/databricks/latest/docs/resources/permissions#token-usage

resource "databricks_permissions" "token_usage" {
    authorization = "tokens"
 
    access_control {
        group_name = "<groupname>"
        permission_level = "CAN_USE"
    }
}

Cluster
- enable Cluster Container Services can be enabled via "enableDcs" custom_config
- enable EBS SSD gp3 can be enabled via "enableGp3" custom_config
Advanced
- enable Web terminal can be enabled via "enableWebTerminal" custom_config
- enable DBFS file browser can be enabled via "enableDbfsFileBrowser" custom_config

resource "databricks_workspace_conf" "this" {
  custom_config = {
    "enableWebTerminal" : true,
    "enableGp3" : true,
    "enableDbfsFileBrowser" : true,
    "enableDcs" : true
  }
}

To achieve the same via API we can use below curl:

curl --location --request PATCH 'https://test.cloud.databricks.com/api/2.0/workspace-conf' \
--header 'Authorization: Bearer REPLACE_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enableWebTerminal": "true",
    "enableGp3": "true",
    "enableDbfsFileBrowser": "true",
    "enableDcs": "true"
}'

Re: Can Terraform be used to set configurations in Admin / workspace settings?

Ricardo_Gaspar — Mon, 11 Oct 2021 16:13:29 GMT

Thanks @Ravirahul Padmanabhan we are going to try it out and come back to you if there are any questions.

Re: Can Terraform be used to set configurations in Admin / workspace settings?

jose_gonzalez — Fri, 29 Oct 2021 22:44:21 GMT

Hi @Ricardo Gaspar ,

Did Ravi's fully answered your question, would you be happy to mark their answer as best so that others can quickly find the solution?

Re: Can Terraform be used to set configurations in Admin / workspace settings?

Ricardo_Gaspar — Thu, 11 Nov 2021 19:32:58 GMT

@Jose Gonzalez @Ravirahul Padmanabhan

It doesn't solve all the requested permissions. But this already helps for now.

Would you be able to add that example terraform to the terraform provider documentation? or is there any webpage that lists all the existing customizable configs?

It certainly would be better to be able to control this via Terraform.

Re: Can Terraform be used to set configurations in Admin / workspace settings?

Vaaceph — Tue, 28 Jun 2022 04:45:02 GMT

Any update for "enable Table access control" from TF?

Re: Can Terraform be used to set configurations in Admin / workspace settings?

Ravi — Thu, 30 Jun 2022 17:56:07 GMT

"Table access control" workspace config is not supported via Databricks Terraform provider.

Re: Can Terraform be used to set configurations in Admin / workspace settings?

Vaaceph — Wed, 06 Jul 2022 04:26:08 GMT

okay. that is sad 😞

Re: Can Terraform be used to set configurations in Admin / workspace settings?

francly — Thu, 11 Aug 2022 05:13:53 GMT

Hi, can I get a full list of the latest configurable supported workspace_conf on tf, I can't find the list on tf registry site.

Re: Can Terraform be used to set configurations in Admin / workspace settings?

maiconbaum — Thu, 13 Apr 2023 11:17:27 GMT

I had the same problem and couldn't find this anywhere, except in the source code for databricks-cli at PowerShell:

https://www.powershellgallery.com/packages/DatabricksPS/1.11.0.8/Content/Public%5CWorkspaceConfig.ps1

Hope this helps someone else too.