AWS Distro for OpenTelemetry Operator を管理する - Amazon EKS

AWS Distro for OpenTelemetry Operator を管理する

AWS Distro for OpenTelemetry (ADOT) Operator は Amazon EKS のアドオンとして提供されています。ADOT Operator をインストールした後、ADOT Collector を設定してデプロイのタイプを指定し、さらにアプリケーションのメトリックまたはトレースデータを受信するとサービスを指定します。このトピックでは、ADOT のアドオンを管理する方法について説明します。

ADOT Collector をインストールするには、「AWS Distro for OpenTelemetry Collector をデプロイする」を参照してください。または、Amazon EKS アドオンの詳細設定機能を使用すると、アドオンの作成中またはアドオンの更新中に ADOT Collector をインストールできます。詳細については、「高度な設定を使用して、OpenTelemetry Collector 用 AWS Distro をデプロイします。」を参照してください。

AWS Distro for OpenTelemetry (ADOT) Operator をインストールする

ADOT のアドオンのインストールには、ADOT Operator が含まれており、これにより ADOT Collector がデプロイされます。ADOT Operator は、OpenTelemetryCollector と呼ばれる新しいオブジェクトタイプを、CustomResourceDefinition (CRD) を介して導入するカスタムコントローラです。ADOT Operator は、OpenTelemetryCollector リソースの存在を検出すると ADOT Collector をインストールします。

前提条件
AWS Management Console

以下の手順に従い、ADOT Amazon EKS アドオンを Amazon EKS クラスターにインストールします。

  1. https://console.aws.amazon.com/eks/home#/clusters で Amazon EKS コンソール を開きます。

  2. 左側ペインで、[Clusters] (クラスター) を選択し、[Clusters] (クラスター) ページでご自身のクラスターの名前を選択します。

  3. [アドオン] タブを選択します。

  4. [Add New] (新規追加) をクリックして、ドロップダウンリストから [AWS Distro for OpenTelemetry] を選択します。

  5. デフォルトバージョンは、[Version] (バージョン) ドロップダウンから選択します。ADOT Collector をデプロイする場合は、バージョンが v0.62.1-eksbuild.1 以上であることを確認してください。

  6. IAM ロールを使用しないサービスアカウントが既にクラスター内に作成されている場合は、[Override existing configuration for this add-on on the cluster] (クラスターにあるこのアドオンの既存の設定を上書きする) を選択します。

  7. (オプション) ADOT Collector をデプロイする場合は、Collector デプロイのユースケースに合った設定値を指定します。これは、[Configuration values] (設定値) フィールドの [Optional configuration settings] (オプション構成設定) ドロップダウンで行います。[Add-on configuration schema] (アドオン設定スキーマ) には、設定値に使用できるオプションが用意されています。

  8. [Add] (追加) をクリックします。

AWS CLI
  1. ADOT Amazon EKS のアドオンを Amazon EKS クラスターにインストールします。オプションで、--configuration-values フラグを追加して、アドオンのインストール中に ADOT Collector をデプロイできます。このフラグを使用して他の使用可能な値を設定することもできます。

    aws eks create-addon --addon-name adot --cluster-name my-cluster --configuration-values my-configuration-values

    完了するまでの間 status フィールドの値は CREATING です。

  2. ADOT がインストールされ、実行中であることを確認します。

    aws eks describe-addon --addon-name adot --cluster-name my-cluster

    作成が完了すると "status": "ACTIVE" が表示されます。

AWS Distro for OpenTelemetry (ADOT) Operator を更新する

Amazon EKS は、クラスター上にある ADOT を自動的に更新しません。ユーザーが更新を開始すると、その後 Amazon EKS が自動で Amazon EKS アドオンを更新します。

AWS CLI を使用して ADOT Amazon EKS アドオンを更新するには
  1. 現在使用している ADOT アドオンのバージョンを確認します。my-cluster をクラスター名に置き換えます。

    aws eks describe-addon --cluster-name my-cluster --addon-name adot --query "addon.addonVersion" --output text
  2. ADOT のバージョンが、クラスターのバージョンでサポートされた利用可能なバージョンであることを確認します。

    aws eks describe-addon-versions --addon-name adot --kubernetes-version 1.23 \ --query "addons[].addonVersions[].[addonVersion, compatibilities[].defaultVersion]" --output text

    出力例を次に示します。

    v0.58.0-eksbuild.1 True v0.56.0-eksbuild.2 False

    下に True と表示されているバージョンは、アドオンの作成時にデプロイされたデフォルトのバージョンです。アドオン作成時にデプロイされたバージョンは、利用可能な最新バージョンではない場合があります。先ほどの出力では、アドオンの作成時に最新バージョンがデプロイされます。

  3. ADOT バージョンを更新します。my-cluster をクラスターの名前に、v0.58.0-eksbuild.1 を目的のバージョンに置き換えます。オプションで、--configuration-values フラグを追加して、アドオンのインストール中に ADOT Collector をデプロイできます。このフラグを使用して他の使用可能な値を設定することもできます。

    aws eks update-addon --cluster-name my-cluster --addon-name adot --addon-version v0.58.0-eksbuild.1 --resolve-conflicts PRESERVE --configuration-values my-configuration-values

    [PRESERVE] (保持) オプションは、アドオンに設定したカスタム設定を保持します。この設定のその他のオプションの詳細については、「Amazon EKS コマンドラインリファレンス」の「更新アドオン」を参照してください。Amazon EKS アドオン設定管理の詳細については、「 Kubernetes フィールド管理」を参照してください。

AWS Distro for OpenTelemetry (ADOT) Operator を削除する

  • ADOT Collector のリソースは、ADOT Collector とは別に削除する必要があります。このコマンドでは、ADOT Collector のデプロイに使用した YAML ファイルを指定します。

    kubectl delete -f collector-config-(amp|cloudwatch|xray|advanced).yaml
  • ADOT Operator は、AWS CLI または eksctl のどちらからでも削除できます。削除した ADOT Operator を再インストールするには、インストール手順に従う必要があります。

    CLI

    aws eks delete-addon --addon-name adot --cluster-name my-cluster

    eksctl

    eksctl delete addon --cluster my-cluster --name adot