Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 4 KB

repo.md

File metadata and controls

63 lines (41 loc) · 4 KB
Raw
subcategory
Workspace

databricks_repo Resource

This resource allows you to manage Databricks Repos.

-> Note To create a Repo from a private repository you need to configure Git token as described in the documentation. Right now this is possible only via Databricks UI due lack of corresponding REST API. For the same reason, it also doesn't work for Service Principals.

Example Usage

You can declare Terraform-managed Repo by specifying url attribute of Git repository. In addition to that you may need to specify git_provider attribute if Git provider doesn't belong to cloud Git providers (Github, GitLab, ...). If path attribute isn't provided, then repo will be created in the user's repo directory (/Repos/<username>/...):

resource "databricks_repo" "nutter_in_home" {
  url = "https://github.com/user/demo.git"
}

Argument Reference

-> Note Repo in Databricks workspace would only be changed, if Terraform stage did change. This means that any manual changes to managed repository won't be overwritten by Terraform, if there's no local changes to configuration. If Repo in Databricks workspace is modifying, application of configuration changes will fail.

The following arguments are supported:

  • url - (Required) The URL of the Git Repository to clone from. If value changes, repo is re-created
  • git_provider - (Optional, if it's possible to detect Git provider by host name) case insensitive name of the Git provider. Following values are supported right now (maybe a subject for change, consult Repos API documentation): gitHub, gitHubEnterprise, bitbucketCloud, bitbucketServer, azureDevOpsServices, gitLab, gitLabEnterpriseEdition
  • path - (Optional) path to put the checked out Repo. If not specified, then repo will be created in the user's repo directory (/Repos/<username>/...). If value changes, repo is re-created
  • branch - (Optional) name of the branch for initial checkout. If not specified, the default branch of the repository will be used. Conflicts with tag. If branch is removed, and tag isn't specified, then the repository will stay at the previously checked out state.
  • tag - (Optional) name of the tag for initial checkout. Conflicts with branch

Attribute Reference

In addition to all arguments above, the following attributes are exported:

  • id - Repo identifier
  • commit_hash - Hash of the HEAD commit at time of the last executed operation. It won't change if you manually perform pull operation via UI or API

Access Control

Import

The resource Repo can be imported using the Repo ID (obtained via UI or using API)

$ terraform import databricks_repo.this repo_id

Related Resources

The following resources are often used in the same context: