> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-mintlify-fbfa8bee.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Helm (v1.x)

> Déploiement de ClickStack à l’aide du chart Helm inline-template v1.x

export const Image = ({img, alt, size}) => {
  return <Frame>
      <img src={img} alt={alt} />
    </Frame>;
};

<Warning>
  **Obsolète — chart v1.x**

  Cette page documente le chart Helm **v1.x** inline-template, qui est en mode maintenance et ne recevra plus de nouvelles fonctionnalités. Pour les nouveaux déploiements, utilisez le [chart v2.x](/fr/clickstack/deployment/helm). Pour migrer un déploiement v1.x existant, consultez le [guide de mise à niveau](/fr/clickstack/deployment/helm-upgrade).
</Warning>

Le chart Helm de ClickStack est disponible [ici](https://github.com/ClickHouse/ClickStack-helm-charts) et constitue la méthode **recommandée** pour les déploiements en production.

Par défaut, le chart Helm déploie tous les composants principaux, notamment :

* **ClickHouse**
* **HyperDX**
* **collecteur OpenTelemetry (OTel)**
* **MongoDB** (pour l’état persistant de l’application)

Il peut toutefois être facilement personnalisé pour s’intégrer à un déploiement ClickHouse existant, par exemple hébergé dans **ClickHouse Cloud**.

Le chart prend en charge les bonnes pratiques Kubernetes standard, notamment :

* Configuration spécifique à l’environnement via `values.yaml`
* Limites de ressources et mise à l’échelle au niveau des pods
* Configuration de TLS et de l’Ingress
* Gestion des secrets et configuration de l’authentification

<div id="suitable-for">
  ### Convient pour
</div>

* Preuves de concept
* Production

<div id="deployment-steps">
  ## Étapes de déploiement
</div>

<br />

<Steps>
  <Step>
    ### Prérequis

    * [Helm](https://helm.sh/) v3+
    * cluster Kubernetes (v1.20+ recommandé)
    * `kubectl` configuré pour communiquer avec votre cluster
  </Step>

  <Step>
    ### Ajouter le dépôt Helm de ClickStack

    Ajoutez le dépôt Helm de ClickStack :

    ```shell theme={null}
    helm repo add clickstack https://clickhouse.github.io/ClickStack-helm-charts
    helm repo update
    ```
  </Step>

  <Step>
    ### Installation de ClickStack

    Pour installer le chart ClickStack avec les valeurs par défaut :

    ```shell theme={null}
    helm install my-clickstack clickstack/clickstack
    ```
  </Step>

  <Step>
    ### Vérifier l’installation

    Vérifiez l’installation :

    ```shell theme={null}
    kubectl get pods -l "app.kubernetes.io/name=clickstack"
    ```

    Une fois que tous les pods sont prêts, poursuivez.
  </Step>

  <Step>
    ### Redirection de ports

    La redirection de ports permet d’accéder à HyperDX et de le configurer. Pour un déploiement en production, il est préférable d’exposer le service via un Ingress ou un répartiteur de charge afin de garantir un accès réseau approprié, la terminaison TLS et une bonne montée en charge. La redirection de ports convient surtout au développement local ou à des tâches administratives ponctuelles, et non à des environnements durables ou à haute disponibilité.

    ```shell theme={null}
    kubectl port-forward \
      pod/$(kubectl get pod -l app.kubernetes.io/name=clickstack -o jsonpath='{.items[0].metadata.name}') \
      8080:3000
    ```

    <Tip>
      **Configuration d’Ingress en production**

      Pour les déploiements en production, configurez l’Ingress avec TLS plutôt que d’utiliser la redirection de port. Consultez le [guide de configuration de l’Ingress](/fr/clickstack/deployment/helm-configuration-v1#ingress-setup) pour des instructions détaillées.
    </Tip>
  </Step>

  <Step>
    ### Accéder à l’interface

    Rendez-vous sur [http://localhost:8080](http://localhost:8080) pour accéder à l’HyperDX UI.

    Créez un utilisateur en indiquant un nom d’utilisateur et un mot de passe conformes aux exigences.

    <Image img="https://mintcdn.com/private-7c7dfe99-mintlify-fbfa8bee/Y4vFHGANad_GoFVH/images/use-cases/observability/hyperdx-login.png?fit=max&auto=format&n=Y4vFHGANad_GoFVH&q=85&s=c991ac28df1abc86034ca2b9d3cb3cc2" alt="HyperDX UI" size="lg" width="3600" height="1900" data-path="images/use-cases/observability/hyperdx-login.png" />

    Lorsque vous cliquez sur `Create`, des sources de données sont créées pour l’instance ClickHouse déployée avec le package Helm.

    <Info>
      **Remplacer la connexion par défaut**

      Vous pouvez remplacer la connexion par défaut de l’instance ClickHouse intégrée. Pour plus de détails, consultez ["Using ClickHouse Cloud"](#using-clickhouse-cloud).
    </Info>
  </Step>

  <Step>
    ### Personnaliser les valeurs (facultatif)

    Vous pouvez personnaliser la configuration à l’aide des options `--set`. Par exemple :

    ```shell theme={null}
    helm install my-clickstack clickstack/clickstack --set key=value
    ```

    Vous pouvez aussi modifier le `values.yaml`. Pour obtenir les valeurs par défaut :

    ```shell theme={null}
    helm show values clickstack/clickstack > values.yaml
    ```

    Exemple de configuration :

    ```yaml theme={null}
    replicaCount: 2
    resources:
      limits:
        cpu: 500m
        memory: 512Mi
      requests:
        cpu: 250m
        memory: 256Mi
    ingress:
      enabled: true
      annotations:
        kubernetes.io/ingress.class: nginx
      hosts:
        - host: hyperdx.example.com
          paths:
            - path: /
              pathType: ImplementationSpecific
    ```

    ```shell theme={null}
    helm install my-clickstack clickstack/clickstack -f values.yaml
    ```
  </Step>

  <Step>
    ### Utilisation des secrets (facultatif)

    Pour gérer des données sensibles telles que des clés API ou des identifiants de base de données, utilisez des secrets Kubernetes. Les charts Helm de HyperDX fournissent des fichiers de secrets par défaut que vous pouvez modifier et appliquer à votre cluster.

    #### Utilisation de secrets préconfigurés

    Le chart Helm inclut un modèle de secret par défaut situé dans [`charts/clickstack/templates/secrets.yaml`](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/charts/clickstack/templates/secrets.yaml). Ce fichier fournit une structure de base pour la gestion des secrets.

    Si vous devez appliquer manuellement un secret, modifiez et appliquez le modèle `secrets.yaml` fourni :

    ```yaml theme={null}
    apiVersion: v1
    kind: Secret
    metadata:
      name: hyperdx-secret
      annotations:
        "helm.sh/resource-policy": keep
    type: Opaque
    data:
      API_KEY: <base64-encoded-api-key>
    ```

    Appliquez le secret à votre cluster :

    ```shell theme={null}
    kubectl apply -f secrets.yaml
    ```

    #### Créer un secret personnalisé

    Si vous le souhaitez, vous pouvez créer manuellement un secret Kubernetes personnalisé :

    ```shell theme={null}
    kubectl create secret generic hyperdx-secret \
      --from-literal=API_KEY=my-secret-api-key
    ```

    #### Référencer un secret

    Pour référencer un secret dans `values.yaml` :

    ```yaml theme={null}
    hyperdx:
      apiKey:
        valueFrom:
          secretKeyRef:
            name: hyperdx-secret
            key: API_KEY
    ```

    <Tip>
      **Gestion des clés API**

      Pour des instructions détaillées sur la configuration des clés API, y compris les différentes méthodes de configuration et les procédures de redémarrage des pods, consultez le [guide de configuration des clés API](/fr/clickstack/deployment/helm-configuration-v1#api-key-setup).
    </Tip>
  </Step>
</Steps>

<div id="using-clickhouse-cloud">
  ## Utilisation de ClickHouse Cloud
</div>

Si vous utilisez ClickHouse Cloud, désactivez l’instance ClickHouse déployée par le chart Helm et renseignez les identifiants Cloud :

```shell theme={null}
# specify ClickHouse Cloud credentials
export CLICKHOUSE_URL=<CLICKHOUSE_CLOUD_URL> # full https url
export CLICKHOUSE_USER=<CLICKHOUSE_USER>
export CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>

# how to overwrite default connection
helm install my-clickstack clickstack/clickstack \
  --set clickhouse.enabled=false \
  --set clickhouse.persistence.enabled=false \
  --set otel.clickhouseEndpoint=${CLICKHOUSE_URL} \
  --set clickhouse.config.users.otelUser=${CLICKHOUSE_USER} \
  --set clickhouse.config.users.otelUserPassword=${CLICKHOUSE_PASSWORD}
```

Vous pouvez également utiliser un fichier `values.yaml` :

```yaml theme={null}
clickhouse:
  enabled: false
  persistence:
    enabled: false
  config:
    users:
      otelUser: ${CLICKHOUSE_USER}
      otelUserPassword: ${CLICKHOUSE_PASSWORD}

otel:
  clickhouseEndpoint: ${CLICKHOUSE_URL}

hyperdx:
  defaultConnections: |
    [
      {
        "name": "External ClickHouse",
        "host": "http://your-clickhouse-server:8123",
        "port": 8123,
        "username": "your-username",
        "password": "your-password"
      }
    ]
```

```shell theme={null}
helm install my-clickstack clickstack/clickstack -f values.yaml
# or if installed...
# helm upgrade my-clickstack clickstack/clickstack -f values.yaml
```

<Tip>
  **Configurations externes avancées**

  Pour les déploiements en production avec une configuration via des secrets, des collecteurs OpenTelemetry (OTel) externes ou des configurations minimales, consultez le [guide des options de déploiement](/fr/clickstack/deployment/helm-deployment-options-v1).
</Tip>

<div id="production-notes">
  ## Remarques pour la production
</div>

Par défaut, ce chart installe également ClickHouse et le collecteur OpenTelemetry (OTel). Toutefois, en production, il est recommandé de gérer ClickHouse et le collecteur OpenTelemetry (OTel) séparément.

Pour désactiver ClickHouse et le collecteur OpenTelemetry (OTel), définissez les valeurs suivantes :

```shell theme={null}
helm install my-clickstack clickstack/clickstack \
  --set clickhouse.enabled=false \
  --set clickhouse.persistence.enabled=false \
  --set otel.enabled=false
```

<Tip>
  **Bonnes pratiques en production**

  Pour les déploiements en production, y compris la configuration de la haute disponibilité, la gestion des ressources, la configuration de l’Ingress/TLS et les configurations spécifiques au Cloud (GKE, EKS, AKS), consultez :

  * [Guide de configuration](/fr/clickstack/deployment/helm-configuration-v1) - Gestion de l’Ingress, du TLS et des secrets
  * [Déploiements Cloud](/fr/clickstack/deployment/helm-cloud-v1) - Paramètres spécifiques au Cloud et liste de contrôle pour la production
</Tip>

<div id="task-configuration">
  ## Configuration des tâches
</div>

Par défaut, la configuration du chart inclut une tâche sous forme de cronjob, chargée de vérifier si des alertes doivent se déclencher. Voici ses options de configuration :

| Paramètre                     | Description                                                                                                                                                                                                             | Par défaut         |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| `tasks.enabled`               | Active/désactive les tâches cron dans le cluster. Par défaut, l’image HyperDX exécute les tâches cron dans le processus. Passez cette valeur à true si vous préférez utiliser une tâche cron distincte dans le cluster. | `false`            |
| `tasks.checkAlerts.schedule`  | Planification cron de la tâche check-alerts                                                                                                                                                                             | `*/1 * * * *`      |
| `tasks.checkAlerts.resources` | Requêtes et limites de ressources pour la tâche check-alerts                                                                                                                                                            | Voir `values.yaml` |

<div id="upgrading-the-chart">
  ## Mise à niveau du chart
</div>

Pour passer à une version plus récente :

```shell theme={null}
helm upgrade my-clickstack clickstack/clickstack -f values.yaml
```

Pour vérifier les versions disponibles du chart :

```shell theme={null}
helm search repo clickstack
```

<Info>
  **Passer à la version 2.x**

  Si vous souhaitez migrer vers le chart v2.x basé sur des sous-charts, consultez le [Guide de mise à niveau](/fr/clickstack/deployment/helm-upgrade) pour obtenir les instructions de migration. Il s'agit d'une modification incompatible : une commande `helm upgrade` sur place n'est pas prise en charge.
</Info>

<div id="uninstalling-clickstack">
  ## Désinstallation de ClickStack
</div>

Pour supprimer le déploiement :

```shell theme={null}
helm uninstall my-clickstack
```

Cela supprimera toutes les ressources associées à la release, mais les données persistantes (le cas échéant) pourront subsister.

<div id="troubleshooting">
  ## Dépannage
</div>

<div id="checking-logs">
  ### Vérification des logs
</div>

```shell theme={null}
kubectl logs -l app.kubernetes.io/name=clickstack
```

<div id="debugging-a-failed-install">
  ### Débogage d’une installation en échec
</div>

```shell theme={null}
helm install my-clickstack clickstack/clickstack --debug --dry-run
```

<div id="verifying-deployment">
  ### Vérifier le déploiement
</div>

```shell theme={null}
kubectl get pods -l app.kubernetes.io/name=clickstack
```

<Tip>
  **Ressources de dépannage supplémentaires**

  Pour les problèmes liés à l’Ingress, les problèmes de TLS ou le dépannage des déploiements Cloud, voir :

  * [Dépannage d’Ingress](/fr/clickstack/deployment/helm-configuration-v1#troubleshooting-ingress) - Chargement des ressources, réécritures de chemins, problèmes de navigateur
  * [Déploiements Cloud](/fr/clickstack/deployment/helm-cloud-v1#loadbalancer-dns-resolution-issue) - Problèmes GKE OpAMP et problèmes spécifiques au cloud
</Tip>

<div id="schema-choice-map-vs-json">
  ## Choix du schéma : Map vs JSON
</div>

Par défaut, ClickStack stocke les attributs dans des colonnes `Map(LowCardinality(String), String)`. Il s’agit du schéma recommandé pour les charges de travail d’observabilité. Associé à la [sérialisation de map compartimentée](/fr/reference/data-types/map#bucketed-map-serialization) et à des index textuels sur les clés et les valeurs de la map, il permet des recherches sélectives sans la surcharge d’ingestion par clé propre aux sous-colonnes JSON dynamiques.

Un schéma de type `JSON` est disponible en bêta pour évaluation sur des charges de travail avec un ensemble réduit et stable de clés d’attributs. Il n’est **pas recommandé** par défaut. Consultez [Map vs JSON type](/fr/clickstack/ingesting-data/schema/map-vs-json) pour la comparaison complète et les variables d’environnement requises pour activer la prise en charge de JSON.

<div id="related-documentation">
  ## Documentation connexe
</div>

<div id="deployment-guides">
  ### Guides de déploiement v1.x
</div>

* [Options de déploiement (v1.x)](/fr/clickstack/deployment/helm-deployment-options-v1) - ClickHouse externe, collecteur OpenTelemetry (OTel) et déploiement minimal
* [Guide de configuration (v1.x)](/fr/clickstack/deployment/helm-configuration-v1) - Clés API, secrets et configuration de l’ingress
* [Déploiements Cloud (v1.x)](/fr/clickstack/deployment/helm-cloud-v1) - Configurations GKE, EKS et AKS, et bonnes pratiques pour la production

<div id="v2x-documentation">
  ### Documentation v2.x
</div>

* [Helm (v2.x)](/fr/clickstack/deployment/helm) - Guide de déploiement pour v2.x
* [Guide de mise à niveau](/fr/clickstack/deployment/helm-upgrade) - Migration de v1.x vers v2.x

<div id="additional-resources">
  ### Ressources supplémentaires
</div>

* [Guide de démarrage de ClickStack](/fr/clickstack/getting-started/index) - Introduction à ClickStack
* [Dépôt des charts Helm de ClickStack](https://github.com/ClickHouse/ClickStack-helm-charts) - Code source du chart et référence des valeurs
* [Documentation Kubernetes](https://kubernetes.io/docs/) - Référence Kubernetes
* [Documentation Helm](https://helm.sh/docs/) - Référence Helm
