diff --git a/Makefile b/Makefile index 70431818..a1023ccd 100644 --- a/Makefile +++ b/Makefile @@ -1,6 +1,6 @@ BIN_NAME=terraform-provider-instaclustr -VERSION=2.0.180 +VERSION=2.0.181 FULL_BIN_NAME="${BIN_NAME}_v${VERSION}" SHASUM_NAME="${BIN_NAME}_${VERSION}_SHA256SUMS" diff --git a/docs/data-sources/clickhouse_configuration_v2_instance.md b/docs/data-sources/clickhouse_configuration_v2_instance.md new file mode 100644 index 00000000..54b9ee62 --- /dev/null +++ b/docs/data-sources/clickhouse_configuration_v2_instance.md @@ -0,0 +1,40 @@ +--- +page_title: "instaclustr_clickhouse_configuration_v2_instance Data Source - terraform-provider-instaclustr" +subcategory: "" +description: |- +--- + +# instaclustr_clickhouse_configuration_v2_instance (Data Source) +ClickHouse configuration overrides +## Example Usage +``` +data "instaclustr_clickhouse_configuration_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 +*___id___*
+Type: string, read-only
+
ID of the cluster's configuration. This should be of the form: 'cfg-'.

+*___cluster_id___*
+Type: string, read-only
+
ID of the ClickHouse cluster

+*___override___*
+Type: list of objects, read-only
+Constraints: minimum items: 1

List of configuration overrides

+ +## Nested schema for `override` +List of configuration overrides
+### Read-only attributes +*___name___*
+Type: string, read-only
+Constraints: allowed values: [ `max_threads`, `max_insert_threads`, `use_skip_indexes`, `insert_quorum`, `insert_quorum_timeout`, `insert_quorum_parallel`, `distributed_ddl_task_timeout`, `log_queries`, `max_execution_time`, `max_bytes_before_external_group_by`, `max_bytes_before_external_sort`, `optimize_on_insert`, `max_partition_size_to_drop` ]

Name of the configuration property.

+*___value___*
+Type: string, read-only
+
Override value for the configuration property.

diff --git a/docs/resources/clickhouse_configuration_v2.md b/docs/resources/clickhouse_configuration_v2.md new file mode 100644 index 00000000..b4608fda --- /dev/null +++ b/docs/resources/clickhouse_configuration_v2.md @@ -0,0 +1,61 @@ +--- +page_title: "instaclustr_clickhouse_configuration_v2 Resource - terraform-provider-instaclustr" +subcategory: "" +description: |- +--- + +# instaclustr_clickhouse_configuration_v2 (Resource) +ClickHouse configuration overrides +## Example Usage +``` +resource "instaclustr_clickhouse_configuration_v2" "example" { + override { + name = "max_threads" + value = "16" + } + + override { + name = "log_queries" + value = "1" + } + + cluster_id = "b997a00d-5bd4-4774-9bd7-5c0ad6189246" +} +``` +## 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 - Optional +*___cluster_id___*
+Type: string, optional, immutable
+
ID of the ClickHouse cluster

+*___override___*
+Type: list of objects, optional, updatable
+Constraints: minimum items: 1

List of configuration overrides

+### Read-only attributes +*___id___*
+Type: string, read-only
+
ID of the cluster's configuration. This should be of the form: 'cfg-'.

+ +## Nested schema for `override` +List of configuration overrides
+### Input attributes - Required +*___name___*
+Type: string, required, updatable
+Constraints: allowed values: [ `max_threads`, `max_insert_threads`, `use_skip_indexes`, `insert_quorum`, `insert_quorum_timeout`, `insert_quorum_parallel`, `distributed_ddl_task_timeout`, `log_queries`, `max_execution_time`, `max_bytes_before_external_group_by`, `max_bytes_before_external_sort`, `optimize_on_insert`, `max_partition_size_to_drop` ]

Name of the configuration property.

+### Input attributes - Optional +*___value___*
+Type: string, optional, updatable
+
Override value for the configuration property.

+## Import +This resource can be imported using the `terraform import` command as follows: +``` +terraform import instaclustr_clickhouse_configuration_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.