From dcfa8922b291bbfa0657b2ea442b1488c4a49bb7 Mon Sep 17 00:00:00 2001 From: Alex Ott Date: Tue, 27 Aug 2024 10:47:41 +0200 Subject: [PATCH] [Doc] Document TF 1.0 as minimum version Remove mentions of Terraform versions earlier than 1.0 --- CONTRIBUTING.md | 13 ++----------- Makefile | 7 +------ README.md | 10 ++++++---- 3 files changed, 9 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bd1bdef44b..753594307f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,6 @@ - [Issues for new contributors](#issues-for-new-contributors) - [Contribution Workflow](#contribution-workflow) - [Contributing to Databricks Terraform Provider](#contributing-to-databricks-terraform-provider) -- [Installing for Terraform 0.12](#installing-for-terraform-012) - [Installing from source](#installing-from-source) - [Contributing documentation](#contributing-documentation) - [Developing provider](#developing-provider) @@ -20,13 +19,13 @@ We happily welcome contributions to the Databricks Terraform Provider. We use Gi ## Issues for new contributors -New contributors should look for the following tags when searching for a first contribution to the Databricks code base. We strongly recommend that new contributors tackle “good first issue” projects first; this helps the contributor become familiar with the contribution workflow, and for the core devs to become acquainted with the contributor. +New contributors should look for the following tags when searching for a first contribution to the Databricks code base. We strongly recommend that new contributors tackle "good first issue" projects first; this helps the contributor become familiar with the contribution workflow, and for the core devs to become acquainted with the contributor. [good first issue](https://github.com/databricks/terraform-provider-databricks/labels/good%20first%20issue) ## Contribution Workflow -Code contributions—bug fixes, new development, test improvement—all follow a GitHub-centered workflow. To participate in Databricks Terraform provider development, set up a GitHub account. Then: +Code contributions—bug fixes, new development, test improvement — all follow a GitHub-centered workflow. To participate in Databricks Terraform provider development, set up a GitHub account. Then: 1. Fork the repo you plan to work on. Go to the project repo page and use the Fork button. This will create a copy of the repo, under your username. (For more details on how to fork a repository see [this guide](https://help.github.com/articles/fork-a-repo/).) @@ -68,14 +67,6 @@ Additional git and GitHub resources: [Git development workflow](https://docs.scipy.org/doc/numpy/dev/development_workflow.html) [Resolving merge conflicts](https://help.github.com/articles/resolving-a-merge-conflict-using-the-command-line/) -## Installing for Terraform 0.12 - -If you use Terraform 0.12, please execute the following curl command in your shell: - -```bash -curl https://raw.githubusercontent.com/databricks/terraform-provider-databricks/main/godownloader-databricks-provider.sh | bash -s -- -b $HOME/.terraform.d/plugins -``` - ## Installing from source On MacOS X, you can install GoLang through `brew install go`, on Debian-based Linux, you can install it by `sudo apt-get install golang -y`. diff --git a/Makefile b/Makefile index a85182d5b3..d79850fa1e 100644 --- a/Makefile +++ b/Makefile @@ -26,13 +26,8 @@ build: vendor @echo "✓ Building source code with go build ..." @go build -mod vendor -v -o terraform-provider-databricks -install12: build - @echo "✓ Installing provider for Terraform 0.12 into ~/.terraform.d/plugins ..." - @test -d $(HOME)/.terraform.d/plugins && rm $(HOME)/.terraform.d/plugins/terraform-provider-databricks* || mkdir -p $(HOME)/.terraform.d/plugins - @cp terraform-provider-databricks $(HOME)/.terraform.d/plugins - install: build - @echo "✓ Installing provider for Terraform 0.13+ into ~/.terraform.d/plugins ..." + @echo "✓ Installing provider for Terraform 1.0+ into ~/.terraform.d/plugins ..." @mkdir -p '$(HOME)/.terraform.d/plugins/registry.terraform.io/databricks/databricks/$(shell ./terraform-provider-databricks version)/$(shell go version | awk '{print $$4}' | sed 's#/#_#')' @cp terraform-provider-databricks '$(HOME)/.terraform.d/plugins/registry.terraform.io/databricks/databricks/$(shell ./terraform-provider-databricks version)/$(shell go version | awk '{print $$4}' | sed 's#/#_#')/terraform-provider-databricks' @echo "✓ Use the following configuration to enable the version you've built" diff --git a/README.md b/README.md index 7b97782cf4..ab1c11575e 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ [![build](https://github.com/databricks/terraform-provider-databricks/workflows/build/badge.svg?branch=master)](https://github.com/databricks/terraform-provider-databricks/actions?query=workflow%3Abuild+branch%3Amaster) [![codecov](https://codecov.io/gh/databricks/terraform-provider-databricks/branch/main/graph/badge.svg)](https://codecov.io/gh/databricks/terraform-provider-databricks) ![lines](https://img.shields.io/tokei/lines/github/databricks/terraform-provider-databricks) [![downloads](https://img.shields.io/github/downloads/databricks/terraform-provider-databricks/total.svg)](https://hanadigital.github.io/grev/?user=databricks&repo=terraform-provider-databricks) -If you use Terraform 0.13 or newer, please refer to instructions specified at [registry page](https://registry.terraform.io/providers/databricks/databricks/latest). If you use older versions of Terraform or want to build it from sources, please refer to [contributing guidelines](CONTRIBUTING.md) page. +Databricks Terraform provider works with Terraform 1.0, or newer. To use it please refer to instructions specified at [registry page](https://registry.terraform.io/providers/databricks/databricks/latest): ```hcl terraform { @@ -110,6 +110,8 @@ terraform { } ``` +If you want to build it from sources, please refer to [contributing guidelines](CONTRIBUTING.md). + Then create a small sample file, named `main.tf` with approximately following contents. Replace `` with newly created [PAT Token](https://docs.databricks.com/dev-tools/api/latest/authentication.html). ```terraform @@ -180,6 +182,6 @@ After you replace `databrickslabs/databricks` with `databricks/databricks` in th If you didn't check-in [`.terraform.lock.hcl`](https://www.terraform.io/language/files/dependency-lock#lock-file-location) to the source code version control, you may you may see `Failed to install provider` error. Please follow the simple steps described in the [troubleshooting guide](docs/guides/troubleshooting.md). -```text -Warning: Exporter is experimental and provided as is. It has an evolving interface, which may change or be removed in future versions of the provider. -``` +## Use of Terraform exporter + +The exporter functionality is experimental and provided as is. It has an evolving interface, which may change or be removed in future versions of the provider.