From 8cbe89d4c7a63a01354e53d4ccb810aaf9b91254 Mon Sep 17 00:00:00 2001 From: jenkins Date: Thu, 29 Aug 2024 10:24:46 +0000 Subject: [PATCH] Committing changes from release-terraform-provider-auto-pr --- Makefile | 2 +- .../clickhouse_cluster_v2_instance.md | 275 +++++++++++++++ docs/resources/clickhouse_cluster_v2.md | 316 ++++++++++++++++++ 3 files changed, 592 insertions(+), 1 deletion(-) create mode 100644 docs/data-sources/clickhouse_cluster_v2_instance.md create mode 100644 docs/resources/clickhouse_cluster_v2.md diff --git a/Makefile b/Makefile index 4f07c610..d3b5d20e 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ BIN_NAME=terraform-provider-instaclustr -VERSION=2.0.149 +VERSION=2.0.150 FULL_BIN_NAME="${BIN_NAME}_v${VERSION}" SHASUM_NAME="${BIN_NAME}_${VERSION}_SHA256SUMS" diff --git a/docs/data-sources/clickhouse_cluster_v2_instance.md b/docs/data-sources/clickhouse_cluster_v2_instance.md new file mode 100644 index 00000000..e20cbb39 --- /dev/null +++ b/docs/data-sources/clickhouse_cluster_v2_instance.md @@ -0,0 +1,275 @@ +--- +page_title: "instaclustr_clickhouse_cluster_v2_instance Data Source - terraform-provider-instaclustr" +subcategory: "" +description: |- +--- + +# instaclustr_clickhouse_cluster_v2_instance (Data Source) +Definition of a managed ClickHouse cluster that can be provisioned in Instaclustr. +## Example Usage +``` +data "instaclustr_clickhouse_cluster_v2_instance" "example" { + id = "" // the value of the `id` attribute defined in the root schema below +} +``` +## Glossary +The following terms are used to describe attributes in the schema of this data source: +- **_read-only_** - These are attributes that can only be read and not provided as an input to the data source. +- **_required_** - These attributes must be provided for the data source's information to be queried. +- **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. +## Root Level Schema +### Read-only attributes +*___data_centre___*
+Type: nested block, read-only, see [data_centre](#nested--data_centre) for nested schema
+Constraints: minimum items: 1

List of data centre settings.

+*___description___*
+Type: string, read-only
+
A description of the cluster

+*___sla_tier___*
+Type: string, read-only
+Constraints: allowed values: [ `PRODUCTION`, `NON_PRODUCTION` ]

SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See [SLA Tier](https://www.instaclustr.com/support/documentation/useful-information/sla-tier/) for more information.

+*___status___*
+Type: string, read-only
+
Status of the cluster.

+*___clickhouse_version___*
+Type: string, read-only
+Constraints: pattern: `[0-9]+\.[0-9]+\.[0-9]+`

Version of ClickHouse to run on the cluster. Available versions:

+*___id___*
+Type: string, read-only
+
ID of the cluster.

+*___name___*
+Type: string, read-only
+Constraints: pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`

Name of the cluster.

+*___resize_settings___*
+Type: nested block, read-only, see [resize_settings](#nested--resize_settings) for nested schema
+
Settings to determine how resize requests will be performed for the cluster.

+*___private_network_cluster___*
+Type: boolean, read-only
+
Creates the cluster with private network only, see [Private Network Clusters](https://www.instaclustr.com/support/documentation/useful-information/private-network-clusters/).

+*___two_factor_delete___*
+Type: nested block, read-only, see [two_factor_delete](#nested--two_factor_delete) for nested schema
+
+*___current_cluster_operation_status___*
+Type: string, read-only
+Constraints: allowed values: [ `NO_OPERATION`, `OPERATION_IN_PROGRESS`, `OPERATION_FAILED` ]

Indicates if the cluster is currently performing any restructuring operation such as being created or resized

+ +## Nested schema for `data_centre` +List of data centre settings.
+### Read-only attributes +*___cloud_provider___*
+Type: string, read-only
+Constraints: allowed values: [ `AWS_VPC`, `GCP`, `AZURE`, `AZURE_AZ`, `ONPREMISES` ]

Name of a cloud provider service.

+*___load_balancer_domain___*
+Type: string, read-only
+
Domain of the Network Load Balancer if enabled. Balances requests against nodes.

+*___region___*
+Type: string, read-only
+
Region of the Data Centre. See the description for node size for a compatible Data Centre for a given node size.

+*___shards___*
+Type: integer, read-only
+Constraints: minimum: 1, maximum: 1E+2

Total number of shards in the Data Centre.

+*___status___*
+Type: string, read-only
+
Status of the Data Centre.

+*___azure_settings___*
+Type: nested block, read-only, see [azure_settings](#nested--azure_settings) for nested schema
+
Azure specific settings for the Data Centre. Cannot be provided with AWS or GCP settings.

+*___deleted_nodes___*
+Type: repeatable nested block, read-only, see [deleted_nodes](#nested--deleted_nodes) for nested schema
+
List of deleted nodes in the data centre

+*___replicas___*
+Type: integer, read-only
+Constraints: minimum: 1, maximum: 3

Total number of replicas of data in the Data Centre

+*___gcp_settings___*
+Type: nested block, read-only, see [gcp_settings](#nested--gcp_settings) for nested schema
+
GCP specific settings for the Data Centre. Cannot be provided with AWS or Azure settings.

+*___tiered_storage___*
+Type: nested block, read-only, see [tiered_storage](#nested--tiered_storage) for nested schema
+
Enable Tiered Storage for ClickHouse

+*___load_balancer_enabled___*
+Type: boolean, read-only
+
Enable Load Balancer for ClickHouse

+*___id___*
+Type: string, read-only
+
ID of the Cluster Data Centre.

+*___tag___*
+Type: repeatable nested block, read-only, see [tag](#nested--tag) for nested schema
+
List of tags to apply to the Data Centre. Tags are metadata labels which allow you to identify, categorize and filter clusters. This can be useful for grouping together clusters into applications, environments, or any category that you require. Note `tag` is not supported in terraform lifecycle `ignore_changes`.

+*___name___*
+Type: string, read-only
+
A logical name for the data centre within a cluster. These names must be unique in the cluster.

+*___nodes___*
+Type: repeatable nested block, read-only, see [nodes](#nested--nodes) for nested schema
+
List of non-deleted nodes in the data centre

+*___node_size___*
+Type: string, read-only
+
Size of the nodes provisioned in the Data Centre. Available node sizes:
*Amazon Web Services* [__AWS_VPC__]
*Africa (Cape Town)* [__AF_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Hong Kong)* [__AP_EAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Hyderabad)* [__AP_SOUTH_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Jakarta)* [__AP_SOUTHEAST_3__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Melbourne)* [__AP_SOUTHEAST_4__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Mumbai)* [__AP_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Osaka)* [__AP_NORTHEAST_3__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Seoul)* [__AP_NORTHEAST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Singapore)* [__AP_SOUTHEAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Sydney)* [__AP_SOUTHEAST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Tokyo)* [__AP_NORTHEAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Canada (Central)* [__CA_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Canada West (Calgary)* [__CA_WEST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*EU Central (Frankfurt)* [__EU_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU Central (Zurich)* [__EU_CENTRAL_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*EU North (Stockholm)* [__EU_NORTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU South (Milan)* [__EU_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*EU South (Spain)* [__EU_SOUTH_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU West (Ireland)* [__EU_WEST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU West (London)* [__EU_WEST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU West (Paris)* [__EU_WEST_3__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Isreal (Tel Aviv)* [__IL_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Middle East (Bahrain)* [__ME_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Middle East (UAE)* [__ME_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*South America (São Paulo)* [__SA_EAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US East (Northern Virginia)* [__US_EAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US East (Ohio)* [__US_EAST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US West (Northern California)* [__US_WEST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US West (Oregon)* [__US_WEST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability




+*___aws_settings___*
+Type: nested block, read-only, see [aws_settings](#nested--aws_settings) for nested schema
+
AWS specific settings for the Data Centre. Cannot be provided with GCP or Azure settings.

+*___network___*
+Type: string, read-only
+
The private network address block for the Data Centre specified using CIDR address notation. The network must have a prefix length between `/12` and `/22` and must be part of a private address space.

+*___dedicated_click_house_keeper___*
+Type: nested block, read-only, see [dedicated_click_house_keeper](#nested--dedicated_click_house_keeper) for nested schema
+
Provision additional dedicated nodes for ClickHouse Keeper to run on. ClickHouse Keeper will be co-located with ClickHouse Server if this is not provided

+*___provider_account_name___*
+Type: string, read-only
+
For customers running in their own account. Your provider account can be found on the Create Cluster page on the Instaclustr Console, or the "Provider Account" property on any existing cluster. For customers provisioning on Instaclustr's cloud provider accounts, this property may be omitted.

+ +## Nested schema for `azure_settings` +Azure specific settings for the Data Centre. Cannot be provided with AWS or GCP settings.
+### Read-only attributes +*___storage_network___*
+Type: string, read-only
+
The private network address block to be used for the storage network. This is only used for certain node sizes, currently limited to those which use Azure NetApp Files: for all other node sizes, this field should not be provided. The network must have a prefix length between /16 and /28, and must be part of a private address range.

+*___custom_virtual_network_id___*
+Type: string, read-only
+
VNet ID into which the Data Centre will be provisioned. The VNet must have an available address space for the Data Centre's network allocation to be appended to the VNet. Currently supported for PostgreSQL clusters only.

+*___resource_group___*
+Type: string, read-only
+
The name of the Azure Resource Group into which the Data Centre will be provisioned.

+ +## Nested schema for `deleted_nodes` +List of deleted nodes in the data centre
+### Read-only attributes +*___start_time___*
+Type: string, read-only
+
Start time of the node as a UTC timestamp

+*___status___*
+Type: string, read-only
+
Provisioning status of the node.

+*___deletion_time___*
+Type: string, read-only
+
Deletion time of the node as a UTC timestamp

+*___id___*
+Type: string, read-only
+
ID of the node.

+*___rack___*
+Type: string, read-only
+
Rack name in which the node is located.

+*___node_size___*
+Type: string, read-only
+
Size of the node.

+*___private_address___*
+Type: string, read-only
+
Private IP address of the node.

+*___node_roles___*
+Type: list of strings, read-only
+Constraints: allowed values: [ `CASSANDRA`, `SPARK_MASTER`, `SPARK_JOBSERVER`, `KAFKA_BROKER`, `KAFKA_DEDICATED_ZOOKEEPER`, `KAFKA_DEDICATED_KRAFT_CONTROLLER`, `KAFKA_ZOOKEEPER`, `KAFKA_SCHEMA_REGISTRY`, `KAFKA_REST_PROXY`, `APACHE_ZOOKEEPER`, `POSTGRESQL`, `PGBOUNCER`, `KAFKA_CONNECT`, `KAFKA_KARAPACE_SCHEMA_REGISTRY`, `KAFKA_KARAPACE_REST_PROXY`, `CADENCE`, `CLICKHOUSE_SERVER`, `CLICKHOUSE_KEEPER`, `CLICKHOUSE_SERVER_AND_KEEPER`, `REDIS_MASTER`, `REDIS_REPLICA`, `OPENSEARCH_DASHBOARDS`, `OPENSEARCH_COORDINATOR`, `OPENSEARCH_MASTER`, `OPENSEARCH_DATA`, `OPENSEARCH_INGEST`, `OPENSEARCH_DATA_AND_INGEST`, `KAFKA_SHOTOVER_PROXY` ]

The roles or purposes of the node. Useful for filtering for nodes that have a specific role.

+*___public_address___*
+Type: string, read-only
+
Public IP address of the node.

+ +## Nested schema for `gcp_settings` +GCP specific settings for the Data Centre. Cannot be provided with AWS or Azure settings.
+### Read-only attributes +*___custom_virtual_network_id___*
+Type: string, read-only
+
Network name or a relative Network or Subnetwork URI. +The Data Centre's network allocation must match the IPv4 CIDR block of the specified subnet. + +Examples: +- Network URI: projects/{riyoa-gcp-project-name}/global/networks/{network-name}. +- Network name: {network-name}, equivalent to projects/{riyoa-gcp-project-name}/global/networks/{network-name}. +- Same-project subnetwork URI: projects/{riyoa-gcp-project-name}/regions/{region-id}/subnetworks/{subnetwork-name}. +- Shared VPC subnetwork URI: projects/{riyoa-gcp-host-project-name}/regions/{region-id}/subnetworks/{subnetwork-name}. +

+ +## Nested schema for `s3_settings` +Defines information about the S3 bucket to be used for remote storage.
+### Read-only attributes +*___prefix___*
+Type: string, read-only
+
S3 prefix to use when storing data in the S3 bucket. The default prefix format is `-data/`

+*___s3_bucket_name___*
+Type: string, read-only
+
S3 bucket name for ClickHouse remote storage

+ +## Nested schema for `tiered_storage` +Enable Tiered Storage for ClickHouse
+### Read-only attributes +*___s3_settings___*
+Type: nested block, read-only, see [s3_settings](#nested--s3_settings) for nested schema
+
Defines information about the S3 bucket to be used for remote storage.

+ +## Nested schema for `tag` +List of tags to apply to the Data Centre. Tags are metadata labels which allow you to identify, categorize and filter clusters. This can be useful for grouping together clusters into applications, environments, or any category that you require. Note `tag` is not supported in terraform lifecycle `ignore_changes`.
+### Read-only attributes +*___key___*
+Type: string, read-only
+
Key of the tag to be added to the Data Centre.

+*___value___*
+Type: string, read-only
+
Value of the tag to be added to the Data Centre.

+ +## Nested schema for `nodes` +List of non-deleted nodes in the data centre
+### Read-only attributes +*___start_time___*
+Type: string, read-only
+
Start time of the node as a UTC timestamp

+*___status___*
+Type: string, read-only
+
Provisioning status of the node.

+*___deletion_time___*
+Type: string, read-only
+
Deletion time of the node as a UTC timestamp

+*___id___*
+Type: string, read-only
+
ID of the node.

+*___rack___*
+Type: string, read-only
+
Rack name in which the node is located.

+*___node_size___*
+Type: string, read-only
+
Size of the node.

+*___private_address___*
+Type: string, read-only
+
Private IP address of the node.

+*___node_roles___*
+Type: list of strings, read-only
+Constraints: allowed values: [ `CASSANDRA`, `SPARK_MASTER`, `SPARK_JOBSERVER`, `KAFKA_BROKER`, `KAFKA_DEDICATED_ZOOKEEPER`, `KAFKA_DEDICATED_KRAFT_CONTROLLER`, `KAFKA_ZOOKEEPER`, `KAFKA_SCHEMA_REGISTRY`, `KAFKA_REST_PROXY`, `APACHE_ZOOKEEPER`, `POSTGRESQL`, `PGBOUNCER`, `KAFKA_CONNECT`, `KAFKA_KARAPACE_SCHEMA_REGISTRY`, `KAFKA_KARAPACE_REST_PROXY`, `CADENCE`, `CLICKHOUSE_SERVER`, `CLICKHOUSE_KEEPER`, `CLICKHOUSE_SERVER_AND_KEEPER`, `REDIS_MASTER`, `REDIS_REPLICA`, `OPENSEARCH_DASHBOARDS`, `OPENSEARCH_COORDINATOR`, `OPENSEARCH_MASTER`, `OPENSEARCH_DATA`, `OPENSEARCH_INGEST`, `OPENSEARCH_DATA_AND_INGEST`, `KAFKA_SHOTOVER_PROXY` ]

The roles or purposes of the node. Useful for filtering for nodes that have a specific role.

+*___public_address___*
+Type: string, read-only
+
Public IP address of the node.

+ +## Nested schema for `resize_settings` +Settings to determine how resize requests will be performed for the cluster.
+### Read-only attributes +*___concurrency___*
+Type: integer, read-only
+
Number of concurrent nodes to resize during a resize operation.

+*___notify_support_contacts___*
+Type: boolean, read-only
+
Setting this property to `true` will notify the Instaclustr Account's designated support contacts on resize completion.

+ +## Nested schema for `aws_settings` +AWS specific settings for the Data Centre. Cannot be provided with GCP or Azure settings.
+### Read-only attributes +*___custom_virtual_network_id___*
+Type: string, read-only
+
VPC ID into which the Data Centre will be provisioned. The Data Centre's network allocation must match the IPv4 CIDR block of the specified VPC.

+*___ebs_encryption_key___*
+Type: string (uuid), read-only
+
ID of a KMS encryption key to encrypt data on nodes. KMS encryption key must be set in Cluster Resources through the Instaclustr Console before provisioning an encrypted Data Centre.

+ +## Nested schema for `two_factor_delete` + +### Read-only attributes +*___confirmation_phone_number___*
+Type: string, read-only
+
The phone number which will be contacted when the cluster is requested to be delete.

+*___confirmation_email___*
+Type: string, read-only
+
The email address which will be contacted when the cluster is requested to be deleted.

+ +## Nested schema for `dedicated_click_house_keeper` +Provision additional dedicated nodes for ClickHouse Keeper to run on. ClickHouse Keeper will be co-located with ClickHouse Server if this is not provided
+### Read-only attributes +*___node_size___*
+Type: string, read-only
+
Size of the nodes provisioned as dedicated ClickHouse Keeper nodes.

+*___node_count___*
+Type: integer, read-only
+Constraints: minimum: 3, maximum: 3

Dedicated ClickHouse Keeper node count, it must be 3.

diff --git a/docs/resources/clickhouse_cluster_v2.md b/docs/resources/clickhouse_cluster_v2.md new file mode 100644 index 00000000..ec8ee3f9 --- /dev/null +++ b/docs/resources/clickhouse_cluster_v2.md @@ -0,0 +1,316 @@ +--- +page_title: "instaclustr_clickhouse_cluster_v2 Resource - terraform-provider-instaclustr" +subcategory: "" +description: |- +--- + +# instaclustr_clickhouse_cluster_v2 (Resource) +Definition of a managed ClickHouse cluster that can be provisioned in Instaclustr. +## Example Usage +``` +resource "instaclustr_clickhouse_cluster_v2" "example" { + data_centre { + cloud_provider = "AWS_VPC" + dedicated_click_house_keeper { + node_count = 3 + node_size = "CLK-DEV-t3.medium-50" + } + + load_balancer_enabled = false + name = "AWS_VPC_US_EAST_1" + network = "10.0.0.0/16" + node_size = "CLK-DEV-t3.medium-50" + region = "US_EAST_1" + replicas = 3 + shards = 1 + tiered_storage { + s3_settings { + s3_bucket_name = "sample-s3-bucket" + } + + } + + } + + private_network_cluster = false + name = "MyClickHouseCluster" + clickhouse_version = "[x.y.z]" + sla_tier = "NON_PRODUCTION" +} +``` +## Glossary +The following terms are used to describe attributes in the schema of this resource: +- **_read-only_** - These are attributes that can only be read and not provided as an input to the resource. +- **_required_** - These attributes must be provided for the resource to be created. +- **_optional_** - These input attributes can be omitted, and doing so may result in a default value being used. +- **_immutable_** - These are input attributes that cannot be changed after the resource is created. +- **_updatable_** - These input attributes can be updated to a different value if needed, and doing so will trigger an update operation. +- **_nested block_** - These attributes use the [Terraform block syntax](https://www.terraform.io/language/attr-as-blocks) when defined as an input in the Terraform code. Attributes with the type **_repeatable nested block_** are the same except that the nested block can be defined multiple times with varying nested attributes. When reading nested block attributes, an index must be provided when accessing the contents of the nested block, example - `my_resource.nested_block_attribute[0].nested_attribute`. +## Root Level Schema +### Input attributes - Required +*___data_centre___*
+Type: nested block, required, updatable, see [data_centre](#nested--data_centre) for nested schema
+Constraints: minimum items: 1

List of data centre settings.

+*___sla_tier___*
+Type: string, required, immutable
+Constraints: allowed values: [ `PRODUCTION`, `NON_PRODUCTION` ]

SLA Tier of the cluster. Non-production clusters may receive lower priority support and reduced SLAs. Production tier is not available when using Developer class nodes. See [SLA Tier](https://www.instaclustr.com/support/documentation/useful-information/sla-tier/) for more information.

+*___clickhouse_version___*
+Type: string, required, immutable
+Constraints: pattern: `[0-9]+\.[0-9]+\.[0-9]+`

Version of ClickHouse to run on the cluster. Available versions:
  • `23.8.14`


+*___name___*
+Type: string, required, immutable
+Constraints: pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`

Name of the cluster.

+*___private_network_cluster___*
+Type: boolean, required, immutable
+
Creates the cluster with private network only, see [Private Network Clusters](https://www.instaclustr.com/support/documentation/useful-information/private-network-clusters/).

+### Input attributes - Optional +*___description___*
+Type: string, optional, updatable
+
A description of the cluster

+*___resize_settings___*
+Type: nested block, optional, updatable, see [resize_settings](#nested--resize_settings) for nested schema
+
Settings to determine how resize requests will be performed for the cluster.

+*___two_factor_delete___*
+Type: nested block, optional, updatable, see [two_factor_delete](#nested--two_factor_delete) for nested schema
+
+### Read-only attributes +*___status___*
+Type: string, read-only
+
Status of the cluster.

+*___id___*
+Type: string, read-only
+
ID of the cluster.

+*___current_cluster_operation_status___*
+Type: string, read-only
+Constraints: allowed values: [ `NO_OPERATION`, `OPERATION_IN_PROGRESS`, `OPERATION_FAILED` ]

Indicates if the cluster is currently performing any restructuring operation such as being created or resized

+ +## Nested schema for `data_centre` +List of data centre settings.
+### Input attributes - Required +*___cloud_provider___*
+Type: string, required, immutable
+Constraints: allowed values: [ `AWS_VPC`, `GCP`, `AZURE`, `AZURE_AZ`, `ONPREMISES` ]

Name of a cloud provider service.

+*___region___*
+Type: string, required, immutable
+
Region of the Data Centre. See the description for node size for a compatible Data Centre for a given node size.

+*___shards___*
+Type: integer, required, updatable
+Constraints: minimum: 1, maximum: 1E+2

Total number of shards in the Data Centre.

+*___replicas___*
+Type: integer, required, updatable
+Constraints: minimum: 1, maximum: 3

Total number of replicas of data in the Data Centre

+*___name___*
+Type: string, required, immutable
+
A logical name for the data centre within a cluster. These names must be unique in the cluster.

+*___node_size___*
+Type: string, required, updatable
+
Size of the nodes provisioned in the Data Centre. Available node sizes:
*Amazon Web Services* [__AWS_VPC__]
*Africa (Cape Town)* [__AF_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Hong Kong)* [__AP_EAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Hyderabad)* [__AP_SOUTH_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Jakarta)* [__AP_SOUTHEAST_3__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Melbourne)* [__AP_SOUTHEAST_4__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Mumbai)* [__AP_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Osaka)* [__AP_NORTHEAST_3__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Asia Pacific (Seoul)* [__AP_NORTHEAST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Singapore)* [__AP_SOUTHEAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Sydney)* [__AP_SOUTHEAST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Asia Pacific (Tokyo)* [__AP_NORTHEAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Canada (Central)* [__CA_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Canada West (Calgary)* [__CA_WEST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*EU Central (Frankfurt)* [__EU_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU Central (Zurich)* [__EU_CENTRAL_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*EU North (Stockholm)* [__EU_NORTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU South (Milan)* [__EU_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*EU South (Spain)* [__EU_SOUTH_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU West (Ireland)* [__EU_WEST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU West (London)* [__EU_WEST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*EU West (Paris)* [__EU_WEST_3__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*Isreal (Tel Aviv)* [__IL_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Middle East (Bahrain)* [__ME_SOUTH_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*Middle East (UAE)* [__ME_CENTRAL_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
DCK-DEV-t3.small-30 General Availability

*South America (São Paulo)* [__SA_EAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US East (Northern Virginia)* [__US_EAST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US East (Ohio)* [__US_EAST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US West (Northern California)* [__US_WEST_1__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability

*US West (Oregon)* [__US_WEST_2__]
Node Size Lifecycle State
CLK-DEV-t3.medium-100 General Availability
CLK-DEV-t3.medium-50 General Availability
CLK-PRD-m7i.2xlarge-250 General Availability
CLK-PRD-m7i.2xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-500 General Availability
CLK-PRD-m7i.4xlarge-750 General Availability
CLK-PRD-m7i.8xlarge-1000 General Availability
CLK-PRD-m7i.8xlarge-750 General Availability
CLK-PRD-m7i.large-100 General Availability
CLK-PRD-m7i.large-250 General Availability
CLK-PRD-m7i.large-500 General Availability
CLK-PRD-m7i.xlarge-250 General Availability
CLK-PRD-m7i.xlarge-500 General Availability
DCK-DEV-t3.small-30 General Availability
DCK-PRD-m7i.large-100 General Availability
DCK-PRD-m7i.large-50 General Availability




+*___network___*
+Type: string, required, immutable
+
The private network address block for the Data Centre specified using CIDR address notation. The network must have a prefix length between `/12` and `/22` and must be part of a private address space.

+### Input attributes - Optional +*___azure_settings___*
+Type: nested block, optional, immutable, see [azure_settings](#nested--azure_settings) for nested schema
+
Azure specific settings for the Data Centre. Cannot be provided with AWS or GCP settings.

+*___gcp_settings___*
+Type: nested block, optional, immutable, see [gcp_settings](#nested--gcp_settings) for nested schema
+
GCP specific settings for the Data Centre. Cannot be provided with AWS or Azure settings.

+*___tiered_storage___*
+Type: nested block, optional, updatable, see [tiered_storage](#nested--tiered_storage) for nested schema
+
Enable Tiered Storage for ClickHouse

+*___load_balancer_enabled___*
+Type: boolean, optional, immutable
+
Enable Load Balancer for ClickHouse

+*___tag___*
+Type: repeatable nested block, optional, immutable, see [tag](#nested--tag) for nested schema
+
List of tags to apply to the Data Centre. Tags are metadata labels which allow you to identify, categorize and filter clusters. This can be useful for grouping together clusters into applications, environments, or any category that you require. Note `tag` is not supported in terraform lifecycle `ignore_changes`.

+*___aws_settings___*
+Type: nested block, optional, immutable, see [aws_settings](#nested--aws_settings) for nested schema
+
AWS specific settings for the Data Centre. Cannot be provided with GCP or Azure settings.

+*___dedicated_click_house_keeper___*
+Type: nested block, optional, updatable, see [dedicated_click_house_keeper](#nested--dedicated_click_house_keeper) for nested schema
+
Provision additional dedicated nodes for ClickHouse Keeper to run on. ClickHouse Keeper will be co-located with ClickHouse Server if this is not provided

+*___provider_account_name___*
+Type: string, optional, immutable
+
For customers running in their own account. Your provider account can be found on the Create Cluster page on the Instaclustr Console, or the "Provider Account" property on any existing cluster. For customers provisioning on Instaclustr's cloud provider accounts, this property may be omitted.

+### Read-only attributes +*___load_balancer_domain___*
+Type: string, read-only
+
Domain of the Network Load Balancer if enabled. Balances requests against nodes.

+*___status___*
+Type: string, read-only
+
Status of the Data Centre.

+*___deleted_nodes___*
+Type: repeatable nested block, read-only, see [deleted_nodes](#nested--deleted_nodes) for nested schema
+
List of deleted nodes in the data centre

+*___id___*
+Type: string, read-only
+
ID of the Cluster Data Centre.

+*___nodes___*
+Type: repeatable nested block, read-only, see [nodes](#nested--nodes) for nested schema
+
List of non-deleted nodes in the data centre

+ +## Nested schema for `azure_settings` +Azure specific settings for the Data Centre. Cannot be provided with AWS or GCP settings.
+### Input attributes - Optional +*___storage_network___*
+Type: string, optional, immutable
+
The private network address block to be used for the storage network. This is only used for certain node sizes, currently limited to those which use Azure NetApp Files: for all other node sizes, this field should not be provided. The network must have a prefix length between /16 and /28, and must be part of a private address range.

+*___custom_virtual_network_id___*
+Type: string, optional, immutable
+
VNet ID into which the Data Centre will be provisioned. The VNet must have an available address space for the Data Centre's network allocation to be appended to the VNet. Currently supported for PostgreSQL clusters only.

+*___resource_group___*
+Type: string, optional, immutable
+
The name of the Azure Resource Group into which the Data Centre will be provisioned.

+ +## Nested schema for `deleted_nodes` +List of deleted nodes in the data centre
+### Read-only attributes +*___start_time___*
+Type: string, read-only
+
Start time of the node as a UTC timestamp

+*___status___*
+Type: string, read-only
+
Provisioning status of the node.

+*___deletion_time___*
+Type: string, read-only
+
Deletion time of the node as a UTC timestamp

+*___id___*
+Type: string, read-only
+
ID of the node.

+*___rack___*
+Type: string, read-only
+
Rack name in which the node is located.

+*___node_size___*
+Type: string, read-only
+
Size of the node.

+*___private_address___*
+Type: string, read-only
+
Private IP address of the node.

+*___node_roles___*
+Type: list of strings, read-only
+Constraints: allowed values: [ `CASSANDRA`, `SPARK_MASTER`, `SPARK_JOBSERVER`, `KAFKA_BROKER`, `KAFKA_DEDICATED_ZOOKEEPER`, `KAFKA_DEDICATED_KRAFT_CONTROLLER`, `KAFKA_ZOOKEEPER`, `KAFKA_SCHEMA_REGISTRY`, `KAFKA_REST_PROXY`, `APACHE_ZOOKEEPER`, `POSTGRESQL`, `PGBOUNCER`, `KAFKA_CONNECT`, `KAFKA_KARAPACE_SCHEMA_REGISTRY`, `KAFKA_KARAPACE_REST_PROXY`, `CADENCE`, `CLICKHOUSE_SERVER`, `CLICKHOUSE_KEEPER`, `CLICKHOUSE_SERVER_AND_KEEPER`, `REDIS_MASTER`, `REDIS_REPLICA`, `OPENSEARCH_DASHBOARDS`, `OPENSEARCH_COORDINATOR`, `OPENSEARCH_MASTER`, `OPENSEARCH_DATA`, `OPENSEARCH_INGEST`, `OPENSEARCH_DATA_AND_INGEST`, `KAFKA_SHOTOVER_PROXY` ]

The roles or purposes of the node. Useful for filtering for nodes that have a specific role.

+*___public_address___*
+Type: string, read-only
+
Public IP address of the node.

+ +## Nested schema for `gcp_settings` +GCP specific settings for the Data Centre. Cannot be provided with AWS or Azure settings.
+### Input attributes - Optional +*___custom_virtual_network_id___*
+Type: string, optional, immutable
+
Network name or a relative Network or Subnetwork URI. +The Data Centre's network allocation must match the IPv4 CIDR block of the specified subnet. + +Examples: +- Network URI: projects/{riyoa-gcp-project-name}/global/networks/{network-name}. +- Network name: {network-name}, equivalent to projects/{riyoa-gcp-project-name}/global/networks/{network-name}. +- Same-project subnetwork URI: projects/{riyoa-gcp-project-name}/regions/{region-id}/subnetworks/{subnetwork-name}. +- Shared VPC subnetwork URI: projects/{riyoa-gcp-host-project-name}/regions/{region-id}/subnetworks/{subnetwork-name}. +

+ +## Nested schema for `s3_settings` +Defines information about the S3 bucket to be used for remote storage.
+### Input attributes - Required +*___s3_bucket_name___*
+Type: string, required, immutable
+
S3 bucket name for ClickHouse remote storage

+### Input attributes - Optional +*___prefix___*
+Type: string, optional, immutable
+
S3 prefix to use when storing data in the S3 bucket. The default prefix format is `-data/`

+ +## Nested schema for `tiered_storage` +Enable Tiered Storage for ClickHouse
+### Input attributes - Optional +*___s3_settings___*
+Type: nested block, optional, updatable, see [s3_settings](#nested--s3_settings) for nested schema
+
Defines information about the S3 bucket to be used for remote storage.

+ +## Nested schema for `tag` +List of tags to apply to the Data Centre. Tags are metadata labels which allow you to identify, categorize and filter clusters. This can be useful for grouping together clusters into applications, environments, or any category that you require. Note `tag` is not supported in terraform lifecycle `ignore_changes`.
+### Input attributes - Required +*___key___*
+Type: string, required, immutable
+
Key of the tag to be added to the Data Centre.

+*___value___*
+Type: string, required, immutable
+
Value of the tag to be added to the Data Centre.

+ +## Nested schema for `nodes` +List of non-deleted nodes in the data centre
+### Read-only attributes +*___start_time___*
+Type: string, read-only
+
Start time of the node as a UTC timestamp

+*___status___*
+Type: string, read-only
+
Provisioning status of the node.

+*___deletion_time___*
+Type: string, read-only
+
Deletion time of the node as a UTC timestamp

+*___id___*
+Type: string, read-only
+
ID of the node.

+*___rack___*
+Type: string, read-only
+
Rack name in which the node is located.

+*___node_size___*
+Type: string, read-only
+
Size of the node.

+*___private_address___*
+Type: string, read-only
+
Private IP address of the node.

+*___node_roles___*
+Type: list of strings, read-only
+Constraints: allowed values: [ `CASSANDRA`, `SPARK_MASTER`, `SPARK_JOBSERVER`, `KAFKA_BROKER`, `KAFKA_DEDICATED_ZOOKEEPER`, `KAFKA_DEDICATED_KRAFT_CONTROLLER`, `KAFKA_ZOOKEEPER`, `KAFKA_SCHEMA_REGISTRY`, `KAFKA_REST_PROXY`, `APACHE_ZOOKEEPER`, `POSTGRESQL`, `PGBOUNCER`, `KAFKA_CONNECT`, `KAFKA_KARAPACE_SCHEMA_REGISTRY`, `KAFKA_KARAPACE_REST_PROXY`, `CADENCE`, `CLICKHOUSE_SERVER`, `CLICKHOUSE_KEEPER`, `CLICKHOUSE_SERVER_AND_KEEPER`, `REDIS_MASTER`, `REDIS_REPLICA`, `OPENSEARCH_DASHBOARDS`, `OPENSEARCH_COORDINATOR`, `OPENSEARCH_MASTER`, `OPENSEARCH_DATA`, `OPENSEARCH_INGEST`, `OPENSEARCH_DATA_AND_INGEST`, `KAFKA_SHOTOVER_PROXY` ]

The roles or purposes of the node. Useful for filtering for nodes that have a specific role.

+*___public_address___*
+Type: string, read-only
+
Public IP address of the node.

+ +## Nested schema for `resize_settings` +Settings to determine how resize requests will be performed for the cluster.
+### Input attributes - Optional +*___concurrency___*
+Type: integer, optional, updatable
+
Number of concurrent nodes to resize during a resize operation.

+*___notify_support_contacts___*
+Type: boolean, optional, updatable
+
Setting this property to `true` will notify the Instaclustr Account's designated support contacts on resize completion.

+ +## Nested schema for `aws_settings` +AWS specific settings for the Data Centre. Cannot be provided with GCP or Azure settings.
+### Input attributes - Optional +*___custom_virtual_network_id___*
+Type: string, optional, immutable
+
VPC ID into which the Data Centre will be provisioned. The Data Centre's network allocation must match the IPv4 CIDR block of the specified VPC.

+*___ebs_encryption_key___*
+Type: string (uuid), optional, immutable
+
ID of a KMS encryption key to encrypt data on nodes. KMS encryption key must be set in Cluster Resources through the Instaclustr Console before provisioning an encrypted Data Centre.

+ +## Nested schema for `two_factor_delete` + +### Input attributes - Required +*___confirmation_email___*
+Type: string, required, updatable
+
The email address which will be contacted when the cluster is requested to be deleted.

+### Input attributes - Optional +*___confirmation_phone_number___*
+Type: string, optional, updatable
+
The phone number which will be contacted when the cluster is requested to be delete.

+ +## Nested schema for `dedicated_click_house_keeper` +Provision additional dedicated nodes for ClickHouse Keeper to run on. ClickHouse Keeper will be co-located with ClickHouse Server if this is not provided
+### Input attributes - Required +*___node_size___*
+Type: string, required, updatable
+
Size of the nodes provisioned as dedicated ClickHouse Keeper nodes.

+*___node_count___*
+Type: integer, required, immutable
+Constraints: minimum: 3, maximum: 3

Dedicated ClickHouse Keeper node count, it must be 3.

+## Import +This resource can be imported using the `terraform import` command as follows: +``` +terraform import instaclustr_clickhouse_cluster_v2.[resource-name] "[resource-id]" +``` +`[resource-id]` is the unique identifier for this resource matching the value of the `id` attribute defined in the root schema above.