Datadog Admission Controller

Datadog Admission Controller

このドキュメントは最新ではありません。最新版はこちらをクリックして英語版をご覧ください。

概要

Datadog Admission Controller は Datadog Cluster Agent のコンポーネントで、ユーザーが利用するアプリケーションポッドのコンフィギュレーションを簡略化できる便利なツールです。Admission Controller には以下の 2 つの機能が備わっています。

  • 環境変数 (DD_AGENT_HOST and DD_ENTITY_ID) をユーザーのアプリケーションコンテナに挿入し、DogStatsD および APM トレーサーライブラリを構成する。
  • アプリケーションラベルから取得した Datadog の標準タグ (env、service、version) をコンテナ環境変数に挿入する。

Datadog Admission Controller は MutatingAdmissionWebhook 型に属します。Admission Controller について詳しくは、Kubernetes ガイドを参照してください。

要件

  • Datadog Cluster Agent v1.7.0+

コンフィギュレーション

Helm チャート

Admission Controller で Helm チャートを有効にするには、パラメーター clusterAgent.admissionController.enabled を true に設定してください。

values.yaml

[...]
 clusterAgent:
[...]
  ## @param admissionController - オブジェクト - 必須
  ## admissionController での自動 APM 挿入を有効化
  ## DogStatsD config および標準タグ (env、service、version) を
  ## ポッドに挿入
  #
  admissionController:
    enabled: true

    ## @param mutateUnlabelled - boolean - optional
    ## ポッドラベルなしで config の挿入を有効化:
    ## admission.datadoghq.com/enabled="true"
    #
    mutateUnlabelled: false
[...]

Datadog 演算子

Admission Controller で Datadog 演算子を有効にするには、カスタムリソースでパラメーター clusterAgent.config.admissionController.enabled を true に設定します。

[...]
 clusterAgent:
[...]
    config:
      admissionController:
        enabled: true
        mutateUnlabelled: false
[...]

手動セットアップ

Helm または Datadog 演算子を使用せずに Admission Controller を有効にするには、コンフィギュレーションに以下を追加します。

まず、Cluster Agent RBAC アクセス許可のマニフェストをダウンロードし、rules の下に以下を追加します。

cluster-agent-rbac.yaml

- apiGroups:
  - admissionregistration.k8s.io
  resources:
  - mutatingwebhookconfigurations
  verbs: ["get", "list", "watch", "update", "create"]
- apiGroups: [""]
  resources: ["secrets"]
  verbs: ["get", "list", "watch", "update", "create"]
- apiGroups: ["batch"]
  resources: ["jobs", "cronjobs"]
  verbs: ["get"]
- apiGroups: ["apps"]
  resources: ["statefulsets", "replicasets", "deployments"]
  verbs: ["get"]

agent-services.yaml の下に以下を追加します。

agent-services.yaml

apiVersion: v1
kind: Service
metadata:
  name: datadog-cluster-agent-admission-controller
  labels:
    app: "datadog"
    app.kubernetes.io/name: "datadog"
spec:
  selector:
    app: datadog-cluster-agent
  ports:
  - port: 443
    targetPort: 8000

Cluster Agent のデプロイに環境変数を追加し、Admission Controller を有効にします。

cluster-agent-deployment.yaml

- name: DD_ADMISSION_CONTROLLER_ENABLED
  value: "true"
- name: DD_ADMISSION_CONTROLLER_SERVICE_NAME
  value: "datadog-cluster-agent-admission-controller"

# このコメントを解除して自動的に APM トレーサーを構成します (以下を参照)
# - name: DD_ADMISSION_CONTROLLER_MUTATE_UNLABELLED
#   value: "true"

最期に、次のコマンドを実行します。

  • kubectl apply -f cluster-agent-rbac.yaml
  • kubectl apply -f agent-services.yaml
  • kubectl apply -f cluster-agent-deployment.yaml

APM および DogStatsD

DogStatsD クライアントと APM トレーサーを自動で構成するには、以下のいずれかの方法で環境変数 DD_AGENT_HOST および DD_ENTITY_ID を挿入します。

  • ラベル admission.datadoghq.com/enabled: "true" をポッドに追加する。
  • mutateUnlabelled (コンフィギュレーションメソッドによっては DD_ADMISSION_CONTROLLER_MUTATE_UNLABELLED) を true に設定して Cluster Agent の Admission Controller を構成します。

ポッドで環境変数を受信しないようにするには、ラベル admission.datadoghq.com/enabled: "false" を追加します。これは mutateUnlabelled: true を設定している場合でも機能します。

利用可能なオプション:

mutateUnlabelled ポッドラベル 挿入可否
true ラベルなし 〇
true admission.datadoghq.com/enabled=true 〇
true admission.datadoghq.com/enabled=false ✕
false ラベルなし ✕
false admission.datadoghq.com/enabled=true 〇
false admission.datadoghq.com/enabled=false ✕

注

  • 新しいアプリケーションポッドを作成する前に、Admission Controller のデプロイと構成が必要です。既に存在するポッドは更新できません。
  • Admission Controller は環境変数 DD_VERSION, DD_ENV および DD_SERVICE が既に存在する場合は挿入を行いません。
  • Admission Controller の挿入機能を無効化するには、Cluster Agent のコンフィギュレーション: DD_ADMISSION_CONTROLLER_INJECT_CONFIG_ENABLED=false を使用します。
  • Datadog Admission Controller を使用すれば、ユーザーは Downward API (Kubernetes トレースコレクション設定のステップ 2 ) を利用してアプリケーションポッドの構成をスキップすることができます。
  • プライベートクラスターを使用していて、コンフィギュレーションがポッドに挿入されない場合は、Control Plane のファイアウォールルールを開き Datadog Webhook と通信します、

その他の参考資料

お役に立つドキュメント、リンクや記事:

Autodiscovery によるクラスターチェックの実行DOCUMENTATION more more Datadog Cluster Agent のトラブルシューティングDOCUMENTATION more more