ClickhouseClusterClickhouseCluster is the Schema for the ClickhouseClusters API. Manages the yandex_mdb_clickhouse_cluster resource.
TypeMR
Providercrossplane-provider-yc
Groupmdb.yandex-cloud.m.jet.crossplane.io
Scopenamespaced
Versionv1alpha1

1apiVersion: mdb.yandex-cloud.m.jet.crossplane.io/v1alpha1

2kind: ClickhouseCluster

kind
string
metadata
object
spec
object

ClickhouseClusterSpec defines the desired state of ClickhouseCluster

forProvider
required
object

(No description available)

access
array

[Block]. Access policy to the ClickHouse cluster. Access policy to the ClickHouse cluster.

dataLens
boolean
metrika
boolean
serverless
boolean
webSql
boolean
object

(String). A password used to authorize as user admin when sql_user_management enabled. A password used to authorize as user admin when sql_user_management enabled.

key
required
string
name
required
string
object

only and is not stored in state. Requires admin_password_wo_version to trigger updates.11 or higher. A password used to authorize as user admin when sql_user_management enabled. This attribute is write-only and is not stored in state. Requires admin_password_wo_version to trigger updates.11 or higher.

key
required
string
name
required
string
array

[Block]. Time to start the daily backup, in the UTC timezone. Time to start the daily backup, in the UTC timezone.

hours
number
minutes
number
array

[Block]. Configuration of the ClickHouse subcluster. Configuration of the ClickHouse subcluster.

config
array

[Block]. ClickHouse server parameters. For more information, see the official documentation. ClickHouse server parameters. For more information, see the official documentation.

array

[Block]. Data compression configuration. Data compression configuration.

array

[Block]. Graphite rollup configuration. Graphite rollup configuration.

name
string
pattern
array

[Block]. Set of thinning rules. Set of thinning rules.

function
string
regexp
string
array

[Block]. Retain parameters. Retain parameters.

age
number
precision
number
array

[Block]. JDBC bridge configuration. JDBC bridge configuration.

host
string
port
number
kafka
array

[Block]. Kafka connection configuration. Kafka connection configuration.

debug
string
object

(String). User password on kafka server. User password on kafka server.

key
required
string
name
required
string
array

[Block]. Kafka topic connection configuration. Kafka topic connection configuration.

name
string
array

[Block]. Kafka connection settings. Kafka connection settings.

debug
string
object

(String). User password on kafka server. User password on kafka server.

key
required
string
name
required
string
logLevel
string
array

[Block]. Query cache configuration. Query cache configuration.

array

[Block]. Query masking rules configuration. Query masking rules configuration.

name
string
regexp
string
replace
string
array

[Block]. RabbitMQ connection configuration. RabbitMQ connection configuration.

object

(String). RabbitMQ user password. RabbitMQ user password.

key
required
string
name
required
string
username
string
vhost
string
timezone
string
array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to hosts of the ClickHouse subcluster.

array

[Block]. Cloud Storage settings. Cloud Storage settings.

clusterId
string
array

[Block]. A database of the ClickHouse cluster. A database of the ClickHouse cluster.

name
string
folderId
string
object

Reference to a Folder in resourcemanager to populate folderId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Folder in resourcemanager to populate folderId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

[Block]. A set of protobuf or capnproto format schemas. A set of protobuf or capnproto format schemas.

name
string
type
string
uri
string
host
array

(String). Host of jdbc bridge. A host of the ClickHouse cluster.

shardName
string
subnetId
string
object

Reference to a Subnet in vpc to populate subnetId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Subnet in vpc to populate subnetId.

namespace
string
policy
object

Policies for selection.

resolve
string
type
string
zone
string
labels
object
array

[Block].

day
string
hour
number
type
string
mlModel
array

[Block]. A group of machine learning models. A group of machine learning models.

name
string
type
string
uri
string
name
string
networkId
string
object

Reference to a Network in vpc to populate networkId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Network in vpc to populate networkId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

(Set Of String). The list of security groups applied to resource or their components. The list of security groups applied to resource or their components.

object

Reference to a ServiceAccount in iam to populate serviceAccountId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a ServiceAccount in iam to populate serviceAccountId.

namespace
string
policy
object

Policies for selection.

resolve
string
shard
array

[Block]. A shard of the ClickHouse cluster. A shard of the ClickHouse cluster.

name
string
array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to host of the shard. The resources specified for the shard takes precedence over the resources specified for the cluster.

weight
number
array

[Block]. A group of clickhouse shards. A group of clickhouse shards.

name
string
array

(List Of String). List of shards names that belong to the shard group. List of shards names that belong to the shard group.

user
array

[Block]. A user of the ClickHouse cluster. A user of the ClickHouse cluster.

name
string
object

(String). RabbitMQ user password. The password of the user.

key
required
string
name
required
string
array

[Block]. Set of permissions granted to the user. Set of permissions granted to the user.

quota
array

[Block]. Set of user quotas. Set of user quotas.

array

[Block]. Kafka connection settings. Custom settings for user.

allowDdl
boolean
compile
boolean
array

(List Of String). Specifies which JOIN algorithm is used. Possible values: Specifies which JOIN algorithm is used. Possible values:

  • hash - hash join algorithm is used. The most generic implementation that supports all combinations of kind and strictness and multiple join keys that are combined with OR in the JOIN ON section.
  • parallel_hash - a variation of hash join that splits the data into buckets and builds several hash tables instead of one concurrently to speed up this process.
  • partial_merge - a variation of the sort-merge algorithm, where only the right table is fully sorted.
  • direct - this algorithm can be applied when the storage for the right table supports key-value requests.
  • auto - when set to auto, hash join is tried first, and the algorithm is switched on the fly to another algorithm if the memory limit is violated.
  • full_sorting_merge - sort-merge algorithm with full sorting joined tables before joining.
  • prefer_partial_merge - clickHouse always tries to use partial_merge join if possible, otherwise, it uses hash. Deprecated, same as partial_merge,hash.
priority
number
quotaMode
string
readonly
number
version
string
array

[Block]. Configuration of the ZooKeeper subcluster. Configuration of the ZooKeeper subcluster.

array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to hosts of the ZooKeeper subcluster.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

access
array

[Block]. Access policy to the ClickHouse cluster. Access policy to the ClickHouse cluster.

dataLens
boolean
metrika
boolean
serverless
boolean
webSql
boolean
object

(String). A password used to authorize as user admin when sql_user_management enabled. A password used to authorize as user admin when sql_user_management enabled.

key
required
string
name
required
string
object

only and is not stored in state. Requires admin_password_wo_version to trigger updates.11 or higher. A password used to authorize as user admin when sql_user_management enabled. This attribute is write-only and is not stored in state. Requires admin_password_wo_version to trigger updates.11 or higher.

key
required
string
name
required
string
array

[Block]. Time to start the daily backup, in the UTC timezone. Time to start the daily backup, in the UTC timezone.

hours
number
minutes
number
array

[Block]. Configuration of the ClickHouse subcluster. Configuration of the ClickHouse subcluster.

config
array

[Block]. ClickHouse server parameters. For more information, see the official documentation. ClickHouse server parameters. For more information, see the official documentation.

array

[Block]. Data compression configuration. Data compression configuration.

array

[Block]. Graphite rollup configuration. Graphite rollup configuration.

name
string
pattern
array

[Block]. Set of thinning rules. Set of thinning rules.

function
string
regexp
string
array

[Block]. Retain parameters. Retain parameters.

age
number
precision
number
array

[Block]. JDBC bridge configuration. JDBC bridge configuration.

host
string
port
number
kafka
array

[Block]. Kafka connection configuration. Kafka connection configuration.

debug
string
object

(String). User password on kafka server. User password on kafka server.

key
required
string
name
required
string
array

[Block]. Kafka topic connection configuration. Kafka topic connection configuration.

name
string
array

[Block]. Kafka connection settings. Kafka connection settings.

debug
string
object

(String). User password on kafka server. User password on kafka server.

key
required
string
name
required
string
logLevel
string
array

[Block]. Query cache configuration. Query cache configuration.

array

[Block]. Query masking rules configuration. Query masking rules configuration.

name
string
regexp
string
replace
string
array

[Block]. RabbitMQ connection configuration. RabbitMQ connection configuration.

object

(String). RabbitMQ user password. RabbitMQ user password.

key
required
string
name
required
string
username
string
vhost
string
timezone
string
array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to hosts of the ClickHouse subcluster.

array

[Block]. Cloud Storage settings. Cloud Storage settings.

clusterId
string
array

[Block]. A database of the ClickHouse cluster. A database of the ClickHouse cluster.

name
string
folderId
string
object

Reference to a Folder in resourcemanager to populate folderId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Folder in resourcemanager to populate folderId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

[Block]. A set of protobuf or capnproto format schemas. A set of protobuf or capnproto format schemas.

name
string
type
string
uri
string
host
array

(String). Host of jdbc bridge. A host of the ClickHouse cluster.

shardName
string
subnetId
string
object

Reference to a Subnet in vpc to populate subnetId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Subnet in vpc to populate subnetId.

namespace
string
policy
object

Policies for selection.

resolve
string
type
string
zone
string
labels
object
array

[Block].

day
string
hour
number
type
string
mlModel
array

[Block]. A group of machine learning models. A group of machine learning models.

name
string
type
string
uri
string
name
string
networkId
string
object

Reference to a Network in vpc to populate networkId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Network in vpc to populate networkId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

(Set Of String). The list of security groups applied to resource or their components. The list of security groups applied to resource or their components.

object

Reference to a ServiceAccount in iam to populate serviceAccountId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a ServiceAccount in iam to populate serviceAccountId.

namespace
string
policy
object

Policies for selection.

resolve
string
shard
array

[Block]. A shard of the ClickHouse cluster. A shard of the ClickHouse cluster.

name
string
array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to host of the shard. The resources specified for the shard takes precedence over the resources specified for the cluster.

weight
number
array

[Block]. A group of clickhouse shards. A group of clickhouse shards.

name
string
array

(List Of String). List of shards names that belong to the shard group. List of shards names that belong to the shard group.

user
array

[Block]. A user of the ClickHouse cluster. A user of the ClickHouse cluster.

name
string
object

(String). RabbitMQ user password. The password of the user.

key
required
string
name
required
string
array

[Block]. Set of permissions granted to the user. Set of permissions granted to the user.

quota
array

[Block]. Set of user quotas. Set of user quotas.

array

[Block]. Kafka connection settings. Custom settings for user.

allowDdl
boolean
compile
boolean
array

(List Of String). Specifies which JOIN algorithm is used. Possible values: Specifies which JOIN algorithm is used. Possible values:

  • hash - hash join algorithm is used. The most generic implementation that supports all combinations of kind and strictness and multiple join keys that are combined with OR in the JOIN ON section.
  • parallel_hash - a variation of hash join that splits the data into buckets and builds several hash tables instead of one concurrently to speed up this process.
  • partial_merge - a variation of the sort-merge algorithm, where only the right table is fully sorted.
  • direct - this algorithm can be applied when the storage for the right table supports key-value requests.
  • auto - when set to auto, hash join is tried first, and the algorithm is switched on the fly to another algorithm if the memory limit is violated.
  • full_sorting_merge - sort-merge algorithm with full sorting joined tables before joining.
  • prefer_partial_merge - clickHouse always tries to use partial_merge join if possible, otherwise, it uses hash. Deprecated, same as partial_merge,hash.
priority
number
quotaMode
string
readonly
number
version
string
array

[Block]. Configuration of the ZooKeeper subcluster. Configuration of the ZooKeeper subcluster.

array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to hosts of the ZooKeeper subcluster.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

ClickhouseClusterStatus defines the observed state of ClickhouseCluster.

object

(No description available)

access
array

[Block]. Access policy to the ClickHouse cluster. Access policy to the ClickHouse cluster.

dataLens
boolean
metrika
boolean
serverless
boolean
webSql
boolean
array

[Block]. Time to start the daily backup, in the UTC timezone. Time to start the daily backup, in the UTC timezone.

hours
number
minutes
number
array

[Block]. Configuration of the ClickHouse subcluster. Configuration of the ClickHouse subcluster.

config
array

[Block]. ClickHouse server parameters. For more information, see the official documentation. ClickHouse server parameters. For more information, see the official documentation.

array

[Block]. Data compression configuration. Data compression configuration.

array

[Block]. Graphite rollup configuration. Graphite rollup configuration.

name
string
pattern
array

[Block]. Set of thinning rules. Set of thinning rules.

function
string
regexp
string
array

[Block]. Retain parameters. Retain parameters.

age
number
precision
number
array

[Block]. JDBC bridge configuration. JDBC bridge configuration.

host
string
port
number
kafka
array

[Block]. Kafka connection configuration. Kafka connection configuration.

array

[Block]. Kafka topic connection configuration. Kafka topic connection configuration.

name
string
array

[Block]. Kafka connection settings. Kafka connection settings.

logLevel
string
array

[Block]. Query cache configuration. Query cache configuration.

array

[Block]. Query masking rules configuration. Query masking rules configuration.

name
string
regexp
string
replace
string
array

[Block]. RabbitMQ connection configuration. RabbitMQ connection configuration.

username
string
vhost
string
timezone
string
array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to hosts of the ClickHouse subcluster.

array

[Block]. Cloud Storage settings. Cloud Storage settings.

clusterId
string
createdAt
string
array

[Block]. A database of the ClickHouse cluster. A database of the ClickHouse cluster.

name
string
folderId
string
array

[Block]. A set of protobuf or capnproto format schemas. A set of protobuf or capnproto format schemas.

name
string
type
string
uri
string
health
string
host
array

(String). Host of jdbc bridge. A host of the ClickHouse cluster.

fqdn
string
shardName
string
subnetId
string
type
string
zone
string
id
string
labels
object
array

[Block].

day
string
hour
number
type
string
mlModel
array

[Block]. A group of machine learning models. A group of machine learning models.

name
string
type
string
uri
string
name
string
networkId
string
array

(Set Of String). The list of security groups applied to resource or their components. The list of security groups applied to resource or their components.

shard
array

[Block]. A shard of the ClickHouse cluster. A shard of the ClickHouse cluster.

name
string
array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to host of the shard. The resources specified for the shard takes precedence over the resources specified for the cluster.

weight
number
array

[Block]. A group of clickhouse shards. A group of clickhouse shards.

name
string
array

(List Of String). List of shards names that belong to the shard group. List of shards names that belong to the shard group.

status
string
user
array

[Block]. A user of the ClickHouse cluster. A user of the ClickHouse cluster.

name
string
array

[Block]. Set of permissions granted to the user. Set of permissions granted to the user.

quota
array

[Block]. Set of user quotas. Set of user quotas.

array

[Block]. Kafka connection settings. Custom settings for user.

allowDdl
boolean
compile
boolean
array

(List Of String). Specifies which JOIN algorithm is used. Possible values: Specifies which JOIN algorithm is used. Possible values:

  • hash - hash join algorithm is used. The most generic implementation that supports all combinations of kind and strictness and multiple join keys that are combined with OR in the JOIN ON section.
  • parallel_hash - a variation of hash join that splits the data into buckets and builds several hash tables instead of one concurrently to speed up this process.
  • partial_merge - a variation of the sort-merge algorithm, where only the right table is fully sorted.
  • direct - this algorithm can be applied when the storage for the right table supports key-value requests.
  • auto - when set to auto, hash join is tried first, and the algorithm is switched on the fly to another algorithm if the memory limit is violated.
  • full_sorting_merge - sort-merge algorithm with full sorting joined tables before joining.
  • prefer_partial_merge - clickHouse always tries to use partial_merge join if possible, otherwise, it uses hash. Deprecated, same as partial_merge,hash.
priority
number
quotaMode
string
readonly
number
version
string
array

[Block]. Configuration of the ZooKeeper subcluster. Configuration of the ZooKeeper subcluster.

array

[Block]. Resources allocated to hosts of the ClickHouse subcluster. Resources allocated to hosts of the ZooKeeper subcluster.

array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string