https://github.com/tidbcloud/terraform-provider-tidbcloud

Terraform TiDB Cloud Provider: Manage TiDB Cloud configurations as code through HashiCorp Terraform
https://github.com/tidbcloud/terraform-provider-tidbcloud

terraform terraform-provider tidb tidbcloud tidbcloud-provider

Last synced: about 2 months ago
JSON representation

Terraform TiDB Cloud Provider: Manage TiDB Cloud configurations as code through HashiCorp Terraform

Host: GitHub
URL: https://github.com/tidbcloud/terraform-provider-tidbcloud
Owner: tidbcloud
License: apache-2.0
Created: 2022-08-23T06:45:28.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2025-03-25T03:33:13.000Z (3 months ago)
Last Synced: 2025-03-28T02:38:46.611Z (2 months ago)
Topics: terraform, terraform-provider, tidb, tidbcloud, tidbcloud-provider
Language: Go
Homepage: https://tidb.cloud/
Size: 632 KB
Stars: 7
Watchers: 10
Forks: 3
Open Issues: 12
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        


  

  



# Terraform TiDB Cloud Provider

[![License](https://img.shields.io/github/license/tidbcloud/terraform-provider-tidbcloud.svg)](https://github.com/tidbcloud/terraform-provider-tidbcloud/blob/master/LICENSE)

[![Release](https://img.shields.io/github/v/release/tidbcloud/terraform-provider-tidbcloud?display_name=release)](https://github.com/tidbcloud/terraform-provider-tidbcloud/releases)

This is the repository for the terraform-provider-tidbcloud, which allows one to use Terraform with TiDB Cloud. Learn more about [TiDB Cloud](https://en.pingcap.com/tidb-cloud/)

For general information about Terraform, visit the [official website](https://www.terraform.io) and the [GitHub project page](https://github.com/hashicorp/terraform).

# TOC

- [Requirements](#requirements)

- [Support](#support)

- [Quick Start](#quick-start)

- [User Guide](#user-guide)

- [Developing the Provider](#developing-the-provider)

  * [Environment](#environment)

  * [Building the provider from source](#building-the-provider-from-source)

  * [Generate or update documentation in docs file](#generate-or-update-documentation-in-docs-file)

  * [Running the acceptance test](#running-the-acceptance-test)

  * [Debug the provider](#debug-the-provider)

- [Follow us](#follow-us)

- [License](#license)

## Requirements

- [Terraform](https://www.terraform.io/downloads.html) >= 1.0

- [Go](https://golang.org/doc/install) >= 1.18 (if you want to build the provider plugin)

## Support

Resources

- [cluster](./docs/resources/cluster.md)

- [backup](./docs/resources/backup.md) (not support update)

- [restore](./docs/resources/restore.md) (not support update and delete)

- [import](./docs/resources/import.md) (not support update)

DataSource

- [projects](./docs/data-sources/projects.md)

- [cluster specs](./docs/data-sources/cluster_specs.md)

- [restores](./docs/data-sources/restores.md)

- [backups](./docs/data-sources/backups.md)

- [clusters](./docs/data-sources/clusters.md)

## Quick Start

### Install terraform

Install terraform in Mac. See [official doc](https://learn.hashicorp.com/tutorials/terraform/install-cli?in=terraform/aws-get-started) for other OS.

```

brew tap hashicorp/tap

brew install hashicorp/tap/terraform

```

### Run the serverless example

1. In a terminal clone the terraform-provider-tidbcloud repository.

  ```

  git clone [email protected]:tidbcloud/terraform-provider-tidbcloud.git

  ```

2. Go to the examples/workflows/tidbcloud_serverless_cluster directory.

  ```

  cd examples/workflows/tidbcloud_serverless_cluster

  ```

3. The provider requires an API key set in an environment variable. Copy the [API key](https://docs.pingcap.com/tidbcloud/api/v1beta#section/Authentication/API-Key-Management) from the TiDB Cloud console and create the environment variables.

  ```

  export TIDBCLOUD_PUBLIC_KEY=fake_public_key

  export TIDBCLOUD_PRIVATE_KEY=fake_private_key

  ```

4. Rename the `terraform.tfvars.templates` to `terraform.tfvars` and change the variables as you wish. You can also pass them by environment variables.

  ```

  export TF_VAR_password=fake_password

  export TF_VAR_cluster_name=fake_cluster_name

  ```

5. Execute the following commands to create a serverless tier

  ```

  terraform init

  terraform apply --auto-approve

  ```

6. The example will output the `connection_strings` for you.

  ```

  connection_strings = {

    "default_user" = "3ybfFe46ZdoSR3b.root"

    "standard" = {

      "host" = "gateway01.us-west-2.prod.aws.tidbcloud.com"

      "port" = 4000

    }

    "vpc_peering" = {

      "host" = ""

      "port" = 0

    }

  }

  ```

  The `connection_strings` will be generated after the cluster is available. If you find the output is empty, you can execute the `terraform refersh` to refresh the state of cluster.

## User Guide

See [TiDB Cloud Terraform Integration Overview](https://docs.pingcap.com/tidbcloud/terraform-tidbcloud-provider-overview) for more details.

## Developing the Provider

### Environment

If you wish to work on the provider, you'll first need [Go](http://www.golang.org) installed on your machine (see [Requirements](#requirements) above).

### Building the provider from source

1. Clone the repository

```shell

git clone [email protected]:tidbcloud/terraform-provider-tidbcloud

```

2. Enter the repository directory

```shell

cd terraform-provider-tidbcloud

```

3. Build the provider using the Go `install` command. This will build the provider and put the provider binary in the `$GOPATH/bin` directory.

```shell

go install

```

### Generate or update documentation in docs file

run `go generate`

### Running the acceptance test

see [here](./internal/README.md) for more detail.

### Debug the provider

I will introduce how to debug with Terraform CLI development overrides. About other ways to debug the provider, see [terraform official doc](https://www.terraform.io/plugin/debugging) for more detail

Development overrides is a method of using a specified local filesystem Terraform provider binary with Terraform CLI, such as one locally built with updated code, rather than a released binary.

1. create `.terraformrc` in your operating system user directory

```

provider_installation {

  dev_overrides {

      "tidbcloud/tidbcloud" = ""

  }

  # For all other providers, install them directly from their origin provider

  # registries as normal. If you omit this, Terraform will _only_ use

  # the dev_overrides block, and so no other providers will be available.

  direct {}

}

```

2. run go install in the terraform-provider-tidbcloud, you will find the `terraform-provider-tidbcloud` will be installed under the `$GOPATH/bin` 

```

go install

```

3. Terraform CLI commands, such as terraform apply, will now use the specified provider binary if you follow the below config:

```

terraform {

  required_providers {

    tidbcloud = {

      source = "tidbcloud/tidbcloud"

    }

  }

}

```

## Follow us

Twitter [@PingCAP](https://twitter.com/PingCAP)

## License

terraform-provider-tidbcloud is under the Apache 2.0 license. See the [LICENSE](./LICENSE) file for details.

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/tidbcloud/terraform-provider-tidbcloud

Awesome Lists containing this project

README