https://github.com/speakeasy-sdks/terraform-provider-clickhouse

Terraform provider for Clickhouse
https://github.com/speakeasy-sdks/terraform-provider-clickhouse

clickhouse golang provider sdk terraform

Last synced: 1 day ago
JSON representation

Terraform provider for Clickhouse

• Host: GitHub
• URL: https://github.com/speakeasy-sdks/terraform-provider-clickhouse
• Owner: speakeasy-sdks
• Created: 2023-06-26T09:58:30.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-06-26T13:10:43.000Z (over 1 year ago)
• Last Synced: 2024-04-28T05:14:53.186Z (6 months ago)
• Topics: clickhouse, golang, provider, sdk, terraform
• Language: Makefile
• Homepage: https://clickhouse.com/docs/en/cloud/manage/api/api-overview
• Size: 134 KB
• Stars: 1
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Clickhouse

## SDK Installation

To install this provider, copy and paste this code into your Terraform configuration. Then, run `terraform init`.

```hcl

terraform {

  required_providers {

    clickhouse = {

      source  = "speakeasy/clickhouse"

      version = "0.0.1"

    }

  }

}

provider "clickhouse" {

  # Configuration options

}

```

## Testing the provider locally

Should you want to validate a change locally, the `--debug` flag allows you to execute the provider against a terraform instance locally.

This also allows for debuggers (e.g. delve) to be attached to the provider.

```sh

go run main.go --debug

# Copy the TF_REATTACH_PROVIDERS env var

# In a new terminal

cd examples/your-example

TF_REATTACH_PROVIDERS=... terraform init

TF_REATTACH_PROVIDERS=... terraform apply

```

Terraform allows you to use local provider builds by setting a `dev_overrides` block in a configuration file called `.terraformrc`. This block overrides all other configured installation methods.

Terraform searches for the `.terraformrc` file in your home directory and applies any configuration settings you set.

```

provider_installation {

  dev_overrides {

      "registry.terraform.io/terraform/scaffolding" = ""

  }

  # 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 {}

}

```

Your `` may vary depending on how your Go environment variables are configured. Execute `go env GOBIN` to set it, then set the `` to the value returned. If nothing is returned, set it to the default location, `$HOME/go/bin`.

### Contributions

While we value open-source contributions to this SDK, this library is generated programmatically.

Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release !

### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)