> ## Documentation Index > Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-8c05c8a2.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Référence de l’API du ClickHouse Operator > Ce document fournit une référence détaillée de l’API pour les ressources personnalisées du ClickHouse Operator. Ce document fournit une référence détaillée de l’API pour les ressources personnalisées du ClickHouse Operator.
## AdditionalPort
AdditionalPort déclare un port TCP supplémentaire à exposer sur le pod ClickHouse et le Service headless géré par l'opérateur. | Champ | Type | Description | Obligatoire | Par défaut | | ------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | ---------- | | `name` | string | Le nom identifie de façon unique le port dans la liste. Il est utilisé à la fois comme nom de port du conteneur et comme nom de port du Service.
Doit être un DNS\_LABEL. | true | | | `port` | integer | `port` est le numéro de port TCP à exposer. | true | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec)
## CABundleSelector
CABundleSelector sélectionne une clé contenant un bundle de CA à partir d'un Secret dans l'espace de noms du cluster. | Champ | Type | Description | Obligatoire | Défaut | | ------ | ------ | ----------------------------------------------------------------------------------------- | ----------- | ------ | | `name` | string | Le nom du Secret dans l'espace de noms du cluster à partir duquel effectuer la sélection. | true | | | `key` | string | La clé du Secret à sélectionner. Doit être une clé de Secret valide. | false | ca.crt | Apparaît dans : * [ClusterTLSSpec](#clustertlsspec)
## ClickHouseCluster
ClickHouseCluster est le schéma de l’API `clickhouseclusters`.
### Version de l’API et Kind
```yaml theme={null} apiVersion: clickhouse.com/v1alpha1 kind: ClickHouseCluster ``` | Champ | Type | Description | Obligatoire | Par défaut | | -------- | --------------------------------------------------- | ----------- | ----------- | ---------- | | `spec` | [ClickHouseClusterSpec](#clickhouseclusterspec) | | true | | | `status` | [ClickHouseClusterStatus](#clickhouseclusterstatus) | | true | | Apparaît dans : * [ClickHouseClusterList](#clickhouseclusterlist)
## ClickHouseClusterList
ClickHouseClusterList contient une liste de ClickHouseCluster.
### Version de l’API et Kind
```yaml theme={null} apiVersion: clickhouse.com/v1alpha1 kind: ClickHouseClusterList ``` | Champ | Type | Description | Obligatoire | Par défaut | | ------- | ----------------------------------------------- | ----------- | ----------- | ---------- | | `items` | [ClickHouseCluster](#clickhousecluster) tableau | | true | |
## ClickHouseClusterSpec
ClickHouseClusterSpec définit l’état souhaité de ClickHouseCluster. | Champ | Type | Description | Obligatoire | Par défaut | | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------- | | `replicas` | integer | Nombre de répliques dans l’unique shard. | false | 3 | | `shards` | integer | Nombre de shards dans le cluster. | false | 1 | | `keeperClusterRef` | [KeeperClusterReference](#keeperclusterreference) | Référence au KeeperCluster utilisé pour la coordination de ClickHouse.
Lorsque l’espace de noms est omis, celui de ClickHouseCluster est utilisé. | true | | | `podTemplate` | [PodTemplateSpec](#podtemplatespec) | Paramètres transmis à la spécification du pod ClickHouse. | false | | | `containerTemplate` | [ContainerTemplateSpec](#containertemplatespec) | Paramètres transmis à la spécification du conteneur ClickHouse. | false | | | `dataVolumeClaimSpec` | [PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaimspec-v1-core) | Spécification du stockage persistant pour les données ClickHouse. | false | | | `additionalVolumeClaimTemplates` | [PersistentVolumeClaimTemplate](#persistentvolumeclaimtemplate) array | Modèles PVC supplémentaires par pod pour le stockage JBOD / multi-disque.
Chaque entrée est propagée dans le volumeClaimTemplate du StatefulSet, montée dans `/var/lib/clickhouse/disks/` et
ajoutée à la politique de stockage JBOD générée.
L’ensemble des disques est figé à la création. | false | | | `labels` | object (keys:string, values:string) | Labels supplémentaires ajoutés aux ressources. | false | | | `annotations` | object (keys:string, values:string) | Annotations supplémentaires ajoutées aux ressources. | false | | | `podDisruptionBudget` | [PodDisruptionBudgetSpec](#poddisruptionbudgetspec) | PodDisruptionBudget configure le PDB créé pour chaque shard.
S’il n’est pas défini, l’opérateur utilise par défaut maxUnavailable=1 pour les
shards à réplique unique et minAvailable=1 pour les shards à plusieurs répliques. | false | | | `settings` | [ClickHouseSettings](#clickhousesettings) | Paramètres de configuration du serveur ClickHouse. | false | | | `clusterDomain` | string | ClusterDomain est le suffixe de domaine du cluster Kubernetes utilisé pour la résolution DNS. | false | cluster.local | | `upgradeChannel` | string | UpgradeChannel indique le canal de publication utilisé pour les vérifications de mise à niveau majeure.
Lorsqu’il est vide, seules les mises à jour mineures seront proposées. Les valeurs autorisées sont : stable, lts ou une version majeure.mineure spécifique (par ex. 25.8). | false | | | `versionProbeTemplate` | [VersionProbeTemplate](#versionprobetemplate) | Surcharges de VersionProbeTemplate pour le Job de détection de version. | false | | | `externalSecret` | [ExternalSecret](#externalsecret) | ExternalSecret est une référence facultative à un Secret géré en externe contenant les secrets du cluster.
Le secret doit se trouver dans le même espace de noms que le cluster. | false | | | `additionalPorts` | [AdditionalPort](#additionalport) array | AdditionalPorts déclare des ports TCP supplémentaires à exposer sur le ClickHouse Pod et le Service headless géré par l’opérateur.
L’opérateur ajoute uniquement ces ports aux ressources Kubernetes ; il ne configure pas le serveur ClickHouse pour écouter sur ces ports. | false | | Apparaît dans : * [ClickHouseCluster](#clickhousecluster)
## ClickHouseClusterStatus
ClickHouseClusterStatus définit l’état observé de ClickHouseCluster. | Field | Type | Description | Required | Default | | ----------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | | `conditions` | [Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array | | false | | | `readyReplicas` | integer | ReadyReplicas indique le nombre total de répliques prêtes à traiter des requêtes. | false | | | `configurationRevision` | string | ConfigurationRevision indique la révision de configuration cible pour chaque réplique. | true | | | `statefulSetRevision` | string | StatefulSetRevision indique la révision cible du StatefulSet pour chaque réplique. | true | | | `currentRevision` | string | CurrentRevision indique la dernière révision de la spécification ClickHouseCluster appliquée. | true | | | `updateRevision` | string | UpdateRevision indique la dernière révision demandée de la spécification ClickHouseCluster. | true | | | `observedGeneration` | integer | ObservedGeneration indique la dernière génération observée par le contrôleur. | true | | | `version` | string | Version indique la version renvoyée par l’image de conteneur. | false | | | `versionProbeRevision` | string | VersionProbeRevision correspond au hash de l’image issu de la dernière vérification de version réussie.
Lorsqu’il correspond au hash actuel de l’image, la Version mise en cache est utilisée directement. | false | | Apparaît dans : * [ClickHouseCluster](#clickhousecluster)
## ClickHouseSettings
ClickHouseSettings définit les options de configuration du serveur ClickHouse. | Champ | Type | Description | Obligatoire | Par défaut | | --------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | | `defaultUserPassword` | [DefaultPasswordSelector](#defaultpasswordselector) | Indique la source et le type du mot de passe de l'utilisateur ClickHouse `default`. | false | | | `logger` | [LoggerConfig](#loggerconfig) | Configuration de la journalisation du serveur ClickHouse. | false | | | `tls` | [ClusterTLSSpec](#clustertlsspec) | Paramètres TLS permettant de configurer des endpoints sécurisés et la vérification des certificats pour le serveur ClickHouse. | false | | | `enableDatabaseSync` | booléen | Active la synchronisation des bases de données ClickHouse vers les répliques nouvellement créées, ainsi que le nettoyage des répliques obsolètes
après une réduction du nombre de répliques.
Prend uniquement en charge les bases de données Replicated et d’intégration. | false | true | | `extraConfig` | [RawExtension](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#rawextension-runtime-pkg) | Configuration ClickHouse supplémentaire qui sera fusionnée avec la configuration par défaut. | false | | | `extraUsersConfig` | [RawExtension](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#rawextension-runtime-pkg) | Configuration supplémentaire des utilisateurs ClickHouse qui sera fusionnée avec la configuration par défaut. | false | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec)
## ClusterTLSSpec
ClusterTLSSpec définit la configuration TLS du cluster. | Field | Type | Description | Required | Default | | ------------------ | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | | `enabled` | boolean | Enabled indique si TLS est activé, ce qui détermine si des ports sécurisés doivent être ouverts. | false | false | | `required` | boolean | Required précise si TLS doit être imposé pour toutes les connexions. Désactive les ports non sécurisés. | false | false | | `serverCertSecret` | [LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core) | ServerCertSecret est une référence à un Secret TLS contenant le certificat du serveur.
Le Secret doit avoir la même structure que les certificats générés par cert-manager,
le certificat et la clé privée étant stockés respectivement sous les clés "tls.crt" et "tls.key". | false | | | `caBundle` | [CABundleSelector](#cabundleselector) | CABundle est une référence à une clé de Secret contenant un bundle de CA utilisé pour vérifier les certificats des pairs.
S'il est vide, le bundle de CA approuvé par le système est utilisé.
La clé prend par défaut la valeur "ca.crt" si elle n'est pas spécifiée. | false | | Apparaît dans : * [ClickHouseSettings](#clickhousesettings) * [KeeperSettings](#keepersettings)
## ConfigMapKeySelector
ConfigMapKeySelector sélectionne une clé d'une ConfigMap. | Champ | Type | Description | Obligatoire | Par défaut | | ------ | -------- | ----------------------------------------------------------------------- | ----------- | ---------- | | `name` | `string` | Le nom de la ConfigMap dans l'espace de noms du cluster à sélectionner. | true | | | `key` | `string` | La clé de la ConfigMap à sélectionner. Doit être une clé valide. | true | | Apparaît dans : * [DefaultPasswordSelector](#defaultpasswordselector)
## ContainerImage
ContainerImage définit une image de conteneur avec un dépôt, un tag ou un hash. | Champ | Type | Description | Obligatoire | Par défaut | | ------------ | ------ | -------------------------------------------------------------------------------------- | ----------- | ---------- | | `repository` | string | Dépôt de l'image de conteneur
Exemple : docker.io/clickhouse/clickhouse | false | | | `tag` | string | Tag de l'image de conteneur, ne peut pas être utilisé avec `hash`.
Exemple : 25.3 | false | | | `hash` | string | Hash de l'image de conteneur, ne peut pas être utilisé avec `tag`. | false | | Apparaît dans : * [ContainerTemplateSpec](#containertemplatespec)
## ContainerTemplateSpec
ContainerTemplateSpec décrit les surcharges de configuration des conteneurs du cluster. | Champ | Type | Description | Obligatoire | Par défaut | | ----------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | | `image` | [ContainerImage](#containerimage) | Image correspond à l’image de conteneur à déployer. | true | | | `imagePullPolicy` | [PullPolicy](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#pullpolicy-v1-core) | ImagePullPolicy de l’image, qui prend par défaut la valeur IfNotPresent. | false | | | `resources` | [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core) | Resources correspond aux ressources requises pour le conteneur serveur.
S’applique dans son ensemble : les valeurs par défaut de l’opérateur ne sont utilisées que lorsque tous les champs de ressources sont vides. | false | | | `volumeMounts` | [VolumeMount](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#volumemount-v1-core) array | VolumeMounts est la liste des montages de volumes du conteneur.
Concaténée avec les montages générés par l’opérateur. Les entrées qui partagent un `mountPath` avec un
montage de l’opérateur sont fusionnées dans un volume projeté. | false | | | `env` | [EnvVar](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#envvar-v1-core) array | Env est la liste des variables d’environnement à définir dans le conteneur.
Fusionnée par nom avec les valeurs par défaut de l’opérateur. | false | | | `securityContext` | [SecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#securitycontext-v1-core) | SecurityContext définit les options de sécurité avec lesquelles le conteneur doit être exécuté.
Un SecurityContext non nul remplace intégralement les valeurs par défaut de l’opérateur ; l’utilisateur prend en charge l’ensemble de la
structure. Lorsqu’il est nul, les valeurs par défaut de l’opérateur sont conservées.
Plus d’informations : [https://kubernetes.io/docs/tasks/configure-pod-container/security-context/](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/) | false | | | `livenessProbe` | [Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#probe-v1-core) | LivenessProbe remplace la sonde de liveness par défaut de l’opérateur. | false | | | `readinessProbe` | [Probe](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#probe-v1-core) | ReadinessProbe remplace la sonde de readiness par défaut de l’opérateur. | false | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec) * [KeeperClusterSpec](#keeperclusterspec)
## DefaultPasswordSelector
DefaultPasswordSelector sélectionne la source du mot de passe de l’utilisateur `default`. | Champ | Type | Description | Requis | Défaut | | -------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- | | `passwordType` | string | Type du mot de passe fourni. Consultez la documentation pour connaître les valeurs possibles [https://clickhouse.com/docs/operations/settings/settings-users#user-namepassword](https://clickhouse.com/docs/operations/settings/settings-users#user-namepassword) | true | password | | `secret` | [SecretKeySelector](#secretkeyselector) | Sélectionne la valeur du mot de passe depuis une clé de Secret | false | | | `configMap` | [ConfigMapKeySelector](#configmapkeyselector) | Sélectionne la valeur du mot de passe depuis une clé de ConfigMap | false | | Apparaît dans : * [ClickHouseSettings](#clickhousesettings)
## ExternalSecret
ExternalSecret est une référence à un Secret dans le même espace de noms. | Champ | Type | Description | Requis | Par défaut | | -------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ---------- | | `name` | string | Nom du Secret. | true | | | `policy` | [ExternalSecretPolicy](#externalsecretpolicy) | La politique contrôle la manière dont l’opérateur traite le contenu du secret.
Observe (par défaut) : bloque la réconciliation si une clé requise est manquante.
Manage : génère les clés requises manquantes dans le secret existant. | false | Observe | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec)
## ExternalSecretPolicy
ExternalSecretPolicy contrôle la façon dont l'opérateur traite le contenu du secret externe. | Champ | Description | | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Observe` | ExternalSecretPolicyObserve est la politique par défaut : l'opérateur lit et valide le secret;
la réconciliation est bloquée si une clé requise est absente.
Les clés requises manquantes et leurs formats attendus sont signalés via la condition d'état ExternalSecretValid au moment de l'exécution.
| | `Manage` | ExternalSecretPolicyManage est la politique dans laquelle l'opérateur complète les clés requises manquantes en générant des
valeurs pour celles-ci. Le secret est mis à jour, mais n'est jamais détenu ni supprimé par l'opérateur.
| Apparaît dans : * [ExternalSecret](#externalsecret)
## KeeperCluster
KeeperCluster est le schéma de l’API `keeperclusters`.
### Version de l’API et Kind
```yaml theme={null} apiVersion: clickhouse.com/v1alpha1 kind: KeeperCluster ``` | Champ | Type | Description | Obligatoire | Par défaut | | -------- | ------------------------------------------- | ----------- | ----------- | ---------- | | `spec` | [KeeperClusterSpec](#keeperclusterspec) | | true | | | `status` | [KeeperClusterStatus](#keeperclusterstatus) | | true | | Apparaît dans : * [KeeperClusterList](#keeperclusterlist)
## KeeperClusterList
KeeperClusterList contient une liste de KeeperCluster.
### Version de l’API et Kind
```yaml theme={null} apiVersion: clickhouse.com/v1alpha1 kind: KeeperClusterList ``` | Champ | Type | Description | Obligatoire | Par défaut | | ------- | --------------------------------------- | ----------- | ----------- | ---------- | | `items` | [KeeperCluster](#keepercluster) tableau | | true | |
## Référence de KeeperCluster
KeeperClusterReference identifie le KeeperCluster utilisé par un ClickHouseCluster. | Champ | Type | Description | Obligatoire | Par défaut | | ----------- | ------ | ----------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | | `name` | string | Nom de la ressource KeeperCluster. | true | | | `namespace` | string | Espace de noms de la ressource KeeperCluster.
S'il n'est pas indiqué, l'espace de noms du ClickHouseCluster est utilisé. | false | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec)
## KeeperClusterSpec
KeeperClusterSpec définit l’état souhaité de KeeperCluster. | Champ | Type | Description | Obligatoire | Par défaut | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------- | | `replicas` | integer | Nombre de répliques dans le cluster | false | 3 | | `podTemplate` | [PodTemplateSpec](#podtemplatespec) | Paramètres transmis à la spécification du pod Keeper. | false | | | `containerTemplate` | [ContainerTemplateSpec](#containertemplatespec) | Paramètres transmis à la spécification du conteneur Keeper. | false | | | `dataVolumeClaimSpec` | [PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaimspec-v1-core) | Spécification du stockage persistant pour les données de ClickHouse Keeper. | false | | | `labels` | object (keys:string, values:string) | Labels supplémentaires ajoutés aux ressources. | false | | | `annotations` | object (keys:string, values:string) | Annotations supplémentaires ajoutées aux ressources. | false | | | `podDisruptionBudget` | [PodDisruptionBudgetSpec](#poddisruptionbudgetspec) | PodDisruptionBudget configure le PDB créé pour le cluster Keeper.
S’il n’est pas défini, l’opérateur utilise par défaut maxUnavailable=replicas/2
(en préservant le quorum pour un cluster 2F+1) ; les clusters à réplique unique utilisent maxUnavailable=1. | false | | | `settings` | [KeeperSettings](#keepersettings) | Paramètres de configuration du serveur ClickHouse Keeper. | false | | | `clusterDomain` | string | ClusterDomain est le suffixe de domaine du cluster Kubernetes utilisé pour la résolution DNS. | false | cluster.local | | `upgradeChannel` | string | UpgradeChannel spécifie le canal de publication utilisé pour les vérifications de mise à niveau majeure.
Lorsqu’il est vide, seules les mises à jour mineures sont proposées. Les valeurs autorisées sont : stable, lts ou une version major.minor spécifique (par ex. 25.8). | false | | | `versionProbeTemplate` | [VersionProbeTemplate](#versionprobetemplate) | Surcharges de VersionProbeTemplate pour le Job de détection de version.
Obsolète : les Jobs de sonde de version de Keeper ne sont pas utilisés ; ce champ est conservé pour la rétrocompatibilité. | false | | Apparaît dans : * [KeeperCluster](#keepercluster)
## KeeperClusterStatus
KeeperClusterStatus définit l’état observé de KeeperCluster. | Champ | Type | Description | Requis | Par défaut | | ----------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------- | | `conditions` | [Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#condition-v1-meta) array | | false | | | `readyReplicas` | integer | ReadyReplicas Nombre total de répliques prêtes à traiter les requêtes. | false | | | `configurationRevision` | string | ConfigurationRevision indique la révision de configuration cible pour chaque réplique. | true | | | `statefulSetRevision` | string | StatefulSetRevision indique la révision cible du StatefulSet pour chaque réplique. | true | | | `currentRevision` | string | CurrentRevision indique la dernière révision de la spécification KeeperCluster appliquée. | true | | | `updateRevision` | string | UpdateRevision indique la dernière révision demandée de la spécification KeeperCluster. | true | | | `observedGeneration` | integer | ObservedGeneration indique la dernière génération observée par le contrôleur. | true | | | `version` | string | Version indique la version signalée par le serveur Keeper. | false | | | `versionProbeRevision` | string | VersionProbeRevision est le hash de l’image de la dernière sonde de version réussie.
Deprecated: les Jobs de sonde de version de Keeper ne sont pas utilisés ; ce champ est conservé pour assurer la rétrocompatibilité. | false | | Apparaît dans : * [KeeperCluster](#keepercluster)
## KeeperSettings
KeeperSettings définit la configuration du serveur ClickHouse Keeper. | Champ | Type | Description | Obligatoire | Par défaut | | ------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | | `logger` | [LoggerConfig](#loggerconfig) | Configuration de la journalisation du serveur ClickHouse Keeper. | false | | | `tls` | [ClusterTLSSpec](#clustertlsspec) | Paramètres TLS permettant de configurer des endpoints sécurisés et la vérification des certificats pour le serveur ClickHouse Keeper. | false | | | `extraConfig` | [RawExtension](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#rawextension-runtime-pkg) | Configuration supplémentaire de ClickHouse Keeper qui sera fusionnée avec la configuration par défaut. | false | | Apparaît dans : * [KeeperClusterSpec](#keeperclusterspec)
## LoggerConfig
LoggerConfig définit la configuration de journalisation du serveur. | Champ | Type | Description | Obligatoire | Par défaut | | ----------- | ------- | --------------------------------------------------------- | ----------- | ---------- | | `logToFile` | booléen | Si false, désactive toute journalisation dans un fichier. | false | true | | `jsonLogs` | booléen | Si true, les logs sont au format JSON. | false | false | | `level` | chaîne | Niveau de verbosité du logger du serveur. | false | trace | | `size` | chaîne | Taille maximale du fichier de log. | false | 1000M | | `count` | entier | Nombre maximal de fichiers de log à conserver. | false | 50 | Apparaît dans : * [ClickHouseSettings](#clickhousesettings) * [KeeperSettings](#keepersettings)
## NamedTemplateMeta
NamedTemplateMeta définit les paramètres de métadonnées pris en charge pour les objets de modèle qui nécessitent un nom. | Champ | Type | Description | Obligatoire | Par défaut | | ------------- | ----------------------------------- | ----------------------------------------------------- | ----------- | ---------- | | `name` | string | Le nom est l’identifiant de la ressource. | true | | | `labels` | object (keys:string, values:string) | Les labels sont appliqués aux objets de modèle. | false | | | `annotations` | object (keys:string, values:string) | Les annotations sont appliquées aux objets de modèle. | false | | Apparaît dans : * [PersistentVolumeClaimTemplate](#persistentvolumeclaimtemplate)
## PDBPolicy
PDBPolicy détermine si des PodDisruptionBudgets sont créés. | Champ | Description | | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | | `Enabled` | PDBPolicyEnabled active la création de PodDisruptionBudgets par l’opérateur.
| | `Disabled` | PDBPolicyDisabled désactive les PodDisruptionBudgets ; l’opérateur supprimera la ressource portant les étiquettes correspondantes.
| | `Ignored` | PDBPolicyIgnored ignore les PodDisruptionBudgets ; l’opérateur ne créera ni ne supprimera aucun PDB, et les PDB existants resteront inchangés.
| Apparaît dans : * [PodDisruptionBudgetSpec](#poddisruptionbudgetspec)
## PersistentVolumeClaimTemplate
PersistentVolumeClaimTemplate est un modèle nommé pour un PersistentVolumeClaim propre à chaque réplique. | Champ | Type | Description | Obligatoire | Par défaut | | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | | `metadata` | [NamedTemplateMeta](#namedtemplatemeta) | Consultez la documentation de l'API Kubernetes pour les champs de `metadata`. | true | | | `spec` | [PersistentVolumeClaimSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#persistentvolumeclaimspec-v1-core) | Spec définit les caractéristiques souhaitées d'un volume demandé par l'auteur d'un pod.
Plus d'informations : [https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims](https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims) | true | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec)
## PodDisruptionBudgetSpec
PodDisruptionBudgetSpec configure le PDB créé pour le cluster. Une seule des valeurs MinAvailable ou MaxUnavailable peut être définie. Si aucune des deux n’est définie, l’opérateur choisit une valeur par défaut sûre en fonction du nombre de répliques. | Champ | Type | Description | Obligatoire | Par défaut | | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | | `policy` | [PDBPolicy](#pdbpolicy) | La politique détermine si l’opérateur crée des PodDisruptionBudgets.
Par défaut, sa valeur est "Enabled" si elle n’est pas définie. Définissez-la sur "Disabled" pour ne pas créer de PDB (par ex. pour les environnements de développement). | false | Enabled | | `minAvailable` | [IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#intorstring-intstr-util) | MinAvailable est le nombre minimal de pods qui doivent rester disponibles pendant une perturbation. | false | | | `maxUnavailable` | [IntOrString](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#intorstring-intstr-util) | MaxUnavailable est le nombre maximal de pods qui peuvent être indisponibles pendant une perturbation. | false | | | `unhealthyPodEvictionPolicy` | [UnhealthyPodEvictionPolicyType](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#unhealthypodevictionpolicytype-v1-policy) | UnhealthyPodEvictionPolicy définit les critères selon lesquels des pods non sains
doivent être pris en compte pour l’éviction.
Les valeurs valides sont "IfReady" et "AlwaysAllow". | false | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec) * [KeeperClusterSpec](#keeperclusterspec)
## PodTemplateSpec
PodTemplateSpec décrit les surcharges de configuration appliquées aux pods du cluster. | Champ | Type | Description | Obligatoire | Valeur par défaut | | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ----------------- | | `terminationGracePeriodSeconds` | entier | Durée facultative, en secondes, nécessaire au pod pour s'arrêter proprement. Elle peut être réduite dans une requête de suppression.
La valeur doit être un entier non négatif. La valeur zéro indique un arrêt immédiat via
le signal `kill` (sans possibilité d'arrêt propre).
Si cette valeur est nil, la période de grâce par défaut sera utilisée.
La période de grâce correspond à la durée, en secondes, entre l'envoi d'un signal de terminaison aux processus en cours d'exécution dans le pod
et le moment où ces processus sont arrêtés de force avec un signal `kill`.
Définissez une valeur supérieure au temps de nettoyage attendu pour votre processus.
La valeur par défaut est de 30 secondes. | false | | | `topologySpreadConstraints` | [TopologySpreadConstraint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#topologyspreadconstraint-v1-core) tableau | TopologySpreadConstraints décrit comment un groupe de pods doit être réparti sur des domaines
de topologie. L’ordonnanceur planifiera les pods de manière à respecter les contraintes.
Tous les topologySpreadConstraints sont combinés par un ET logique.
Fusionné avec les valeurs par défaut de l’opérateur via `topologyKey`. | false | | | `imagePullSecrets` | [LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#localobjectreference-v1-core) liste | ImagePullSecrets est une liste facultative de références à des secrets dans le même espace de noms, à utiliser pour récupérer les images utilisées par ce PodSpec.
S'ils sont spécifiés, ces secrets seront transmis aux implémentations de récupération d'images afin qu'elles puissent les utiliser.
Plus d'informations : [https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod](https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod)
Fusionné avec les valeurs par défaut de l'opérateur par nom. | false | | | `nodeSelector` | objet (clés:string, valeurs:string) | NodeSelector est un sélecteur qui doit être satisfait pour que le pod puisse être exécuté sur un nœud.
Sélecteur qui doit correspondre aux labels d’un nœud pour que le pod soit planifié sur ce nœud.
Plus d’informations : [https://kubernetes.io/docs/concepts/configuration/assign-pod-node/](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) | false | | | `affinity` | [Affinité](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#affinity-v1-core) | Le cas échéant, les contraintes de planification du pod.
S’ajoute aux valeurs par défaut de l’opérateur : les listes de termes de planification sont concaténées. | false | | | `tolerations` | [Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core)\[] | Tolérances du pod, si elles sont spécifiées. | false | | | `schedulerName` | string | S'il est spécifié, le pod sera planifié par l'ordonnanceur indiqué.
S'il ne l'est pas, le pod sera planifié par l'ordonnanceur par défaut. | false | | | `serviceAccountName` | string | ServiceAccountName est le nom du ServiceAccount à utiliser pour exécuter ce pod.
Pour en savoir plus : [https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/) | false | | | `priorityClassName` | string | PriorityClassName désigne le nom de la PriorityClass à utiliser pour le pod. | false | | | `runtimeClassName` | string | RuntimeClassName désigne le nom de la RuntimeClass à utiliser pour le pod. | false | | | `volumes` | [Volume](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#volume-v1-core) liste | Volumes définit la liste des volumes pouvant être montés par les conteneurs du pod.
Plus d’informations : [https://kubernetes.io/docs/concepts/storage/volumes](https://kubernetes.io/docs/concepts/storage/volumes)
Fusionné par nom avec les valeurs par défaut de l’opérateur ; un volume utilisateur remplace tout volume de l’opérateur portant le même nom. | false | | | `securityContext` | [PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podsecuritycontext-v1-core) | SecurityContext contient les attributs de sécurité au niveau du pod ainsi que les paramètres communs des conteneurs.
Un SecurityContext non nul remplace intégralement les valeurs par défaut de l’opérateur ; l’utilisateur est responsable de la
struct entière. Lorsqu’il est nul, les valeurs par défaut de l’opérateur sont conservées. | false | | | `topologyZoneKey` | string | TopologyZoneKey est la clé des labels du nœud.
Les nœuds qui possèdent un label avec cette clé et des valeurs identiques sont considérés comme appartenant à la même zone de topologie.
Définissez-la pour activer les règles TopologySpreadConstraints et Affinity par défaut afin de répartir les pods entre les zones.
Il est recommandé de la définir sur "topology.kubernetes.io/zone" | false | | | `nodeHostnameKey` | string | NodeHostnameKey est la clé des labels du nœud.
Les nœuds qui portent un label avec cette clé et des valeurs identiques sont considérés comme étant sur le même nœud.
Définissez-la pour activer les règles d’anti-affinité par défaut afin de répartir les répliques des différents shards entre les nœuds.
Il est recommandé de la définir sur "kubernetes.io/hostname" | false | | | `initContainers` | [Container](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#container-v1-core) tableau | InitContainers est la liste des conteneurs d’initialisation à exécuter avant le démarrage du conteneur serveur principal.
Fusionnée avec les valeurs par défaut de l’opérateur portant
le même nom. | false | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec) * [KeeperClusterSpec](#keeperclusterspec)
## SecretKeySelector
SecretKeySelector sélectionne une clé dans un Secret. | Champ | Type | Description | Obligatoire | Défaut | | ------ | ------ | ------------------------------------------------------------------------------- | ----------- | ------ | | `name` | chaîne | Le nom du secret dans l’espace de noms du cluster à partir duquel sélectionner. | true | | | `key` | chaîne | La clé du secret à sélectionner. Doit être une clé de secret valide. | true | | Apparaît dans : * [DefaultPasswordSelector](#defaultpasswordselector)
## TemplateMeta
TemplateMeta définit les paramètres de métadonnées pris en charge pour les objets de modèle. | Field | Type | Description | Required | Default | | ------------- | ----------------------------------- | -------------------------------------------- | -------- | ------- | | `labels` | object (keys:string, values:string) | Labels appliqués aux objets de modèle. | false | | | `annotations` | object (keys:string, values:string) | Annotations appliquées aux objets de modèle. | false | | Apparaît dans : * [VersionProbePodTemplate](#versionprobepodtemplate) * [VersionProbeTemplate](#versionprobetemplate)
## VersionProbeContainer
VersionProbeContainer définit des surcharges au niveau du conteneur pour la sonde de version. Les noms de champ et les balises JSON correspondent à corev1.Container afin que les fusions SMP s'effectuent par nom. | Champ | Type | Description | Obligatoire | Par défaut | | ----------------- | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | ------------- | | `name` | string | Nom du conteneur. S'il est vide, l'opérateur le définit sur le nom du conteneur de la sonde de version. | true | version-probe | | `resources` | [ResourceRequirements](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#resourcerequirements-v1-core) | Ressources de calcul requises pour le conteneur de la sonde de version.
Fusionnées de manière récursive avec les valeurs par défaut de l'opérateur via SMP. | false | | | `securityContext` | [SecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#securitycontext-v1-core) | SecurityContext définit les options de sécurité du conteneur de la sonde de version.
Fusionné de manière récursive avec les valeurs par défaut de l'opérateur via SMP. | false | | Apparaît dans : * [VersionProbePodSpec](#versionprobepodspec)
## VersionProbeJobSpec
VersionProbeJobSpec définit des surcharges au niveau du Job pour la sonde de version. | Champ | Type | Description | Obligatoire | Par défaut | | ------------------------- | --------------------------------------------------- | ---------------------------------------------------------------------- | ----------- | ---------- | | `ttlSecondsAfterFinished` | integer | TTLSecondsAfterFinished limite la durée de vie d’un Job terminé. | false | | | `template` | [VersionProbePodTemplate](#versionprobepodtemplate) | Le modèle décrit le pod qui sera créé pour le Job de sonde de version. | false | | Apparaît dans : * [VersionProbeTemplate](#versionprobetemplate)
## VersionProbePodSpec
VersionProbePodSpec définit des surcharges au niveau du pod pour la sonde de version. Les noms des champs et les balises JSON correspondent à corev1.PodSpec pour assurer la compatibilité avec les patchs de fusion stratégique. | Champ | Type | Description | Requis | Par défaut | | ----------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------- | | `nodeSelector` | objet (clés:string, valeurs:string) | NodeSelector limite le pod de la sonde de version aux nœuds dont les labels correspondent. | false | | | `tolerations` | tableau de [Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#toleration-v1-core) | Tolérances pour le pod de la sonde de version. | false | | | `securityContext` | [PodSecurityContext](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#podsecuritycontext-v1-core) | SecurityContext contient les attributs de sécurité au niveau du pod pour le pod de la sonde de version. | false | | | `containers` | tableau de [VersionProbeContainer](#versionprobecontainer) | Surcharges des conteneurs pour le pod de la sonde de version.
Le champ name est facultatif — l'opérateur le renseigne avec le conteneur par défaut.
Il est possible de spécifier un conteneur supplémentaire avec un nom différent. | false | | Apparaît dans : * [VersionProbePodTemplate](#versionprobepodtemplate)
## VersionProbePodTemplate
VersionProbePodTemplate décrit les surcharges du pod de la sonde de version. | Champ | Type | Description | Obligatoire | Par défaut | | ---------- | ------------------------------------------- | ----------------------------------------------------------------------------- | ----------- | ---------- | | `metadata` | [TemplateMeta](#templatemeta) | Consultez la documentation de l’API Kubernetes pour les champs de `metadata`. | false | | | `spec` | [VersionProbePodSpec](#versionprobepodspec) | Spécification du comportement souhaité du pod de la sonde de version. | false | | Apparaît dans : * [VersionProbeJobSpec](#versionprobejobspec)
## VersionProbeTemplate
VersionProbeTemplate définit des surcharges pour le Job de détection de version. La structure reproduit batchv1.JobTemplateSpec et n’expose que les champs pris en charge. | Champ | Type | Description | Obligatoire | Par défaut | | ---------- | ------------------------------------------- | ----------------------------------------------------------------------------- | ----------- | ---------- | | `metadata` | [TemplateMeta](#templatemeta) | Consultez la documentation de l’API Kubernetes pour les champs de `metadata`. | false | | | `spec` | [VersionProbeJobSpec](#versionprobejobspec) | Spécification du comportement attendu du Job de détection de version. | false | | Apparaît dans : * [ClickHouseClusterSpec](#clickhouseclusterspec) * [KeeperClusterSpec](#keeperclusterspec)