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

# Helm（v1.x）

> v1.x のインラインテンプレートの Helm チャートを使用した ClickStack のデプロイ

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

<Warning>
  **非推奨 — v1.x チャート**

  このページでは、メンテナンスモードとなっており、今後新機能が追加されない **v1.x** のインラインテンプレート Helm チャートについて説明します。新規デプロイには [v2.x チャート](/ja/clickstack/deployment/helm) を使用してください。既存の v1.x デプロイを移行する場合は、[アップグレードガイド](/ja/clickstack/deployment/helm-upgrade) を参照してください。
</Warning>

ClickStack の Helm チャートは [こちら](https://github.com/ClickHouse/ClickStack-helm-charts) で公開されており、本番環境へのデプロイに**推奨**される方法です。

デフォルトでは、Helm チャートは以下を含むすべての中核コンポーネントをプロビジョニングします。

* **ClickHouse**
* **HyperDX**
* **OpenTelemetry (OTel) collector**
* **MongoDB** (永続的なアプリケーション状態用)

ただし、既存の ClickHouse デプロイメントと連携できるよう、簡単にカスタマイズすることもできます。たとえば、**ClickHouse Cloud** でホストされている環境に接続できます。

このチャートは、以下を含む Kubernetes の標準的なベストプラクティスをサポートしています。

* `values.yaml` による環境ごとの設定
* リソース制限とポッドレベルのスケーリング
* TLS とイングレスの設定
* シークレット管理と認証の設定

<div id="suitable-for">
  ### 適した用途
</div>

* 概念実証
* 本番環境

<div id="deployment-steps">
  ## デプロイ手順
</div>

<br />

<Steps>
  <Step>
    ### 前提条件

    * [Helm](https://helm.sh/) v3+
    * Kubernetes クラスター (v1.20+ 推奨)
    * ご利用のクラスターとやり取りできるように `kubectl` が設定されていること
  </Step>

  <Step>
    ### ClickStack の Helm リポジトリを追加する

    ClickStack の Helm リポジトリを追加します：

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

  <Step>
    ### ClickStack のインストール

    デフォルト値で ClickStack チャートをインストールするには:

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

  <Step>
    ### インストールを確認する

    インストールを確認します。

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

    すべてのポッドの準備ができたら、次に進んでください。
  </Step>

  <Step>
    ### ポートフォワーディング

    ポートフォワーディングを使用すると、HyperDX にアクセスしてセットアップを行えます。本番環境にデプロイする場合は、適切なネットワークアクセス、TLS 終端、スケーラビリティを確保するため、代わりにイングレスまたはロードバランサー経由でサービスを公開してください。ポートフォワーディングは、ローカルでの開発や一時的な管理作業には適していますが、長期運用や高可用性が求められる環境には適していません。

    ```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>
      **本番環境のイングレス設定**

      本番環境にデプロイする場合は、ポートフォワーディングではなく、TLS を使用してイングレスを設定してください。詳しい設定手順については、[Ingress Configuration ガイド](/ja/clickstack/deployment/helm-configuration-v1#ingress-setup)を参照してください。
    </Tip>
  </Step>

  <Step>
    ### UI にアクセスする

    HyperDX UI にアクセスするには、[http://localhost:8080](http://localhost:8080) を開きます。

    要件を満たすユーザー名とパスワードを指定して、ユーザーを作成します。

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

    `Create` をクリックすると、Helm チャートでデプロイした ClickHouse インスタンス用のデータソースが作成されます。

    <Info>
      **デフォルト接続の上書き**

      統合された ClickHouse インスタンスへのデフォルトの接続は上書きできます。詳しくは、["Using ClickHouse Cloud"](#using-clickhouse-cloud) を参照してください。
    </Info>
  </Step>

  <Step>
    ### values のカスタマイズ (任意)

    `--set` フラグを使って設定をカスタマイズできます。たとえば、次のように指定します。

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

    または、`values.yaml` を編集します。デフォルト値を取得するには、

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

    設定例：

    ```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>
    ### シークレットの使用 (任意)

    API キーやデータベース認証情報などの機密データを扱うには、Kubernetes のシークレットを使用します。HyperDX の Helm チャートには、変更してクラスターに適用できるデフォルトのシークレットファイルが用意されています。

    #### 事前設定済みシークレットの使用

    Helm チャートには、[`charts/clickstack/templates/secrets.yaml`](https://github.com/ClickHouse/ClickStack-helm-charts/blob/main/charts/clickstack/templates/secrets.yaml) にあるデフォルトのシークレットテンプレートが含まれています。このファイルは、シークレットを管理するための基本構成を提供します。

    シークレットを手動で適用する必要がある場合は、提供されている `secrets.yaml` テンプレートを編集して適用します。

    ```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>
    ```

    シークレットをクラスターに適用します。

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

    #### カスタムシークレットの作成

    必要に応じて、カスタム Kubernetes シークレットを手動で作成することもできます：

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

    #### Secretを参照する

    `values.yaml` でSecretを参照するには:

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

    <Tip>
      **API キーの管理**

      複数の設定方法やポッドの再起動手順を含む、API キーの詳細な設定手順については、[API キーのセットアップガイド](/ja/clickstack/deployment/helm-configuration-v1#api-key-setup)を参照してください。
    </Tip>
  </Step>
</Steps>

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

ClickHouse Cloud を使用する場合は、Helm チャートでデプロイした ClickHouse インスタンスを無効にし、Cloud の認証情報を指定します。

```shell theme={null}
# ClickHouse Cloud の認証情報を指定する
export CLICKHOUSE_URL=<CLICKHOUSE_CLOUD_URL> # 完全な https URL
export CLICKHOUSE_USER=<CLICKHOUSE_USER>
export CLICKHOUSE_PASSWORD=<CLICKHOUSE_PASSWORD>

# デフォルト接続を上書きする方法
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}
```

または、`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
# すでにインストール済みの場合...
# helm upgrade my-clickstack clickstack/clickstack -f values.yaml
```

<Tip>
  **高度な外部構成**

  シークレットベースの設定、外部 OTel collector、または最小構成での本番デプロイについては、[デプロイメントオプションガイド](/ja/clickstack/deployment/helm-deployment-options-v1)を参照してください。
</Tip>

<div id="production-notes">
  ## 本番環境に関する注意
</div>

デフォルトでは、このチャートによって ClickHouse と OTel collector もインストールされます。ただし、本番環境では、ClickHouse と OTel collector は個別に管理することを推奨します。

ClickHouse と OTel collector を無効にするには、次の値を設定します。

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

<Tip>
  **本番環境のベストプラクティス**

  高可用性構成、リソース管理、イングレス/TLS の設定、クラウド固有の構成 (GKE、EKS、AKS) を含む本番環境向けデプロイについては、以下を参照してください。

  * [構成ガイド](/ja/clickstack/deployment/helm-configuration-v1) - イングレス、TLS、シークレットの管理
  * [Cloud デプロイメント](/ja/clickstack/deployment/helm-cloud-v1) - Cloud 固有の設定と本番環境向けチェックリスト
</Tip>

<div id="task-configuration">
  ## タスク設定
</div>

デフォルトでは、チャート設定には CronJob として 1 つのタスクが含まれており、アラートを発報する必要があるかどうかを確認します。設定オプションは以下のとおりです。

| パラメーター                        | 説明                                                                                                                   | デフォルト             |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ----------------- |
| `tasks.enabled`               | クラスター内の cron タスクの有効/無効を切り替えます。デフォルトでは、HyperDX イメージがプロセス内で cron タスクを実行します。クラスター内で別個の cron タスクを使用する場合は、true に変更してください。 | `false`           |
| `tasks.checkAlerts.schedule`  | check-alerts タスクの cron スケジュール                                                                                        | `*/1 * * * *`     |
| `tasks.checkAlerts.resources` | check-alerts タスクのリソース要求と上限                                                                                           | `values.yaml` を参照 |

<div id="upgrading-the-chart">
  ## チャートのアップグレード
</div>

新しいバージョンにアップグレードするには：

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

利用可能なチャートのバージョンを確認するには:

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

<Info>
  **v2.x へのアップグレード**

  v2.x のサブチャートベースのチャートに移行する場合は、移行手順について[アップグレードガイド](/ja/clickstack/deployment/helm-upgrade)を参照してください。これは破壊的変更であり、インプレースでの `helm upgrade` はサポートされていません。
</Info>

<div id="uninstalling-clickstack">
  ## ClickStack のアンインストール
</div>

デプロイメントを削除するには:

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

これにより、リリースに関連するすべてのリソースは削除されますが、永続データ (存在する場合) は残る可能性があります。

<div id="troubleshooting">
  ## トラブルシューティング
</div>

<div id="checking-logs">
  ### ログの確認
</div>

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

<div id="debugging-a-failed-install">
  ### インストールに失敗した場合のデバッグ
</div>

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

<div id="verifying-deployment">
  ### デプロイの確認
</div>

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

<Tip>
  **追加のトラブルシューティング リソース**

  イングレス固有の問題、TLS の問題、または Cloud デプロイメントのトラブルシューティングについては、次を参照してください。

  * [イングレス Troubleshooting](/ja/clickstack/deployment/helm-configuration-v1#troubleshooting-ingress) - アセットの配信、パスの書き換え、ブラウザーの問題
  * [Cloud Deployments](/ja/clickstack/deployment/helm-cloud-v1#loadbalancer-dns-resolution-issue) - GKE OpAMP の問題や Cloud 固有の問題
</Tip>

<div id="schema-choice-map-vs-json">
  ## スキーマの選択: Map と JSON
</div>

ClickStack は、デフォルトで属性を `Map(LowCardinality(String), String)` カラムとして保存します。これは、オブザーバビリティのワークロードに推奨されるスキーマです。[bucketed map serialization](/ja/reference/data-types/map#bucketed-map-serialization) と、Map のキーおよび値に対するテキスト索引を組み合わせることで、動的な JSON サブカラムのようにキーごとの取り込みオーバーヘッドを発生させることなく、必要なルックアップだけを効率的に実行できます。

`JSON` 型のスキーマは、属性キーの集合が小さく安定しているワークロードで評価するためのベータ機能として利用できます。これはデフォルトとしては**推奨されません**。詳しい比較と、JSON サポートを有効にするために必要な環境変数については、[Map と JSON 型の比較](/ja/clickstack/ingesting-data/schema/map-vs-json) を参照してください。

<div id="related-documentation">
  ## 関連ドキュメント
</div>

<div id="deployment-guides">
  ### v1.x デプロイガイド
</div>

* [デプロイオプション (v1.x)](/ja/clickstack/deployment/helm-deployment-options-v1) - 外部 ClickHouse、OTel collector、最小構成でのデプロイ
* [設定ガイド (v1.x)](/ja/clickstack/deployment/helm-configuration-v1) - APIキー、シークレット、イングレスの設定
* [Cloud デプロイ (v1.x)](/ja/clickstack/deployment/helm-cloud-v1) - GKE、EKS、AKS の構成と本番環境向けベストプラクティス

<div id="v2x-documentation">
  ### v2.x ドキュメント
</div>

* [Helm (v2.x)](/ja/clickstack/deployment/helm) - v2.x のデプロイガイド
* [アップグレードガイド](/ja/clickstack/deployment/helm-upgrade) - v1.x から v2.x への移行ガイド

<div id="additional-resources">
  ### 追加リソース
</div>

* [ClickStack 入門ガイド](/ja/clickstack/getting-started) - ClickStack の概要
* [ClickStack Helm チャートリポジトリ](https://github.com/ClickHouse/ClickStack-helm-charts) - チャートのソースコードと values のリファレンス
* [Kubernetes ドキュメント](https://kubernetes.io/docs/) - Kubernetes リファレンス
* [Helm ドキュメント](https://helm.sh/docs/) - Helm リファレンス