This template repository is built on the Terraform Plugin SDK. The template repository built on the Terraform Plugin Framework can be found at terraform-provider-scaffolding-framework. See Which SDK Should I Use? in the Terraform documentation for additional information.
This is a terraform provider plugin for managing Clickhouse databases and tables in a simple way.
Note: This provider it's in a very early state so only few table engines are allowed for replicated tables so far.
- Clone the repository
- Enter the repository directory
- Build the provider using the Go
installcommand:
$ go installThis provider uses Go modules. Please see the Go documentation for the most up to date information about using Go modules.
To add a new dependency github.com/author/dependency to your Terraform provider:
go get github.com/author/dependency
go mod tidyThen commit the changes to go.mod and go.sum.
Definining provider. The port should be the Clickhouse native protocol port (9000 by default, and 9440 for Clickhouse Cloud)
provider "clickhouse" {
port = 9000 # Clickhouse native protocol port
host = "127.0.0.1"
username = "default"
password = ""
}In order to definte url, username and password in a safety way it is possible to define them using env vars:
TF_CLICKHOUSE_USERNAME=default
TF_CLICKHOUSE_PASSWORD=""
TF_CLICKHOUSE_HOST="127.0.0.1"
TF_CLICKHOUSE_PORT=9000
resource "clickhouse_db" "test_db_clusterd" {
name = "database_test_clustered"
comment = "This is a test database"
}Configuring provider
provider "clickhouse" {
port = 9000
host = "127.0.0.1"
username = "default"
password = ""
default_cluster ="cluster"
}Creating a Database
resource "clickhouse_db" "test_db_clusterd" {
name = "database_test_clustered"
comment = "This is a test database"
cluster = "cluster"
}I is possible to use macros defined for cluster, databases, installation names in Altinity operator when creating resources.
provider "clickhouse" {
port = 9000
host = "127.0.0.1"
username = "default"
password = ""
default_cluster ="'{cluster}'"
}resource "clickhouse_db" "test_db_cluster" {
name = "database_test_clustered"
comment = "This is a test database"
cluster = "'{cluster}'"
}Creating tables
resource "clickhouse_table" "replicated_table" {
database = clickhouse_db.test_db_clustered.name
name = "replicated_table"
cluster = clickhouse_db.test_db_clustered.cluster
engine = "ReplicatedMergeTree"
engine_params = ["'/clickhouse/{installation}/clickhouse_db.test_db_clustered.cluster/tables/{shard}/{database}/{table}'", "'{replica}'"]
order_by = ["event_date", "event_type"]
columns {
name = "event_date"
type = "Date"
}
columns {
name = "event_type"
type = "Int32"
}
columns {
name = "article_id"
type = "Int32"
}
columns {
name = "title"
type = "String"
}
partition_by {
by = "event_type"
}
partition_by {
by = "event_date"
partition_function = "toYYYYMM"
}
}
resource "clickhouse_table" "distributed_table" {
database = clickhouse_db.test_db_clustered.name
name = "distributed_table"
cluster = clickhouse_db.test_db_clustered.cluster
engine = "Distributed"
engine_params = [clickhouse_db.test_db_clustered.cluster, clickhouse_db.test_db_clustered.name, clickhouse_table.replicated_table.name, "rand()"]
}Creating roles
resource "clickhouse_role" "my_database_rw" {
name = "my_database_rw"
database = clickhouse_db.test_db_cluster.name
privileges = ["SELECT", "INSERT"]
}Creating users
resource "clickhouse_user" "my_database_rw_user" {
name = "my_database_rw_user"
password = "awesome_user_password"
roles = [clickhouse_role.my_database_rw.name]
}If you wish to work on the provider, you'll first need Go installed on your machine (see Requirements above).
To compile the provider, run go install. This will build the provider and put the provider binary in the $GOPATH/bin directory.
To generate or update documentation, run go generate.
In order to run the full suite of Acceptance tests, run make testacc.
Note: Acceptance tests create real resources, and often cost money to run.
$ make testacc
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent