Kubernetesインテグレーション: インストールおよび設定

Kubernetesインテグレーションをインストールする最も近道は、自動化されたインストーラを使用してマニフェストを生成することです。生成されたマニフェストは、インテグレーションDaemonSetsのみならず、Kubernetesイベント、Prometheus OpenMetrics、New Relicログモニタリングなど、その他のNew Relic Kubernetes製品の設定もバンドルします。

きめ細かなテレメトリデータ用に、PixieとNew Relic Oneインテグレーションをインストールしたいとお考えですか？1つのインストールコマンドで、Kubernetesクラスタとワークロードをより深く理解するには、Pixieを使用した自動テレメトリのインストール手順をご覧ください。言語エージェントは必要ありません。

当社のKubernetesインテグレーションをお試しになりますか？New Relicアカウントの作成は無料です。クレジットカードは不要です。

自動インストーラの使用

サーバー、VM、特権のない環境で、自動化されたインストーラを使用できます。インストーラを使用して、いくつかの予備メモを見直した後に、マネージドサービスまたはプラットフォームも使用できます。カスタムマニフェストが必要な場合や、手動で特権のないインストールをする場合には、別の手順もあります。

インストーラの起動

New RelicアカウントがEU地域にある場合は、one.eu.newrelic.comからインストーラにアクセスします。

マネージドサービスとプラットフォーム向けのインストール

自動化されたインストーラを起動する前に、次のマネージドサービスまたはプラットフォーム向けのメモを確認してください。

Kubernetesインテグレーションは、ワーカーノードを監視します。Amazon EKSでは、マスターノードはAmazonによって管理され、Kubernetesプラットフォームから抽出されます。

自動化されたインストーラを起動し、KubernetesインテグレーションをAmazon EKSにディプロイする前に、AWSが提供したkubectlのバージョンを使用していることを確認します。

Kubernetesインテグレーションは、ワーカーノードを監視します。GKEでは、マスターノードはGoogleによって管理され、Kubernetesプラットフォームから抽出されます。

自動化されたインストーラを起動し、GKEにKubernetesインテグレーションをディプロイする前に、十分な権限があることを確認してください。

console.cloud.google.com/iam-admin/iamに移動し、ユーザー名を見つけます。編集をクリックします。
ロールおよびClusterRolesを作成する権限があることを確認します。不確かな場合は、Kubernetes Engine Cluster Adminロールを追加します。ユーザーロールを編集できない場合は、必要なパーミッションを付与してもらうようGCPプロジェクトのオーナーに依頼してください。
ロールとClusterRoleを作成するためのものと同じパーミッションを付与するRoleBindingがあることを確認します。
```
kubectl create clusterrolebinding YOUR_USERNAME-cluster-admin-binding --clusterrole=cluster-admin --user=YOUR_GCP_EMAIL
```
RoleBindingを作成する必要があるのは、KubernetesとKubernetes Engineバージョン1.6以上に既知のRBAC問題があるためです。詳細については、ロールにおけるアクセス権限の定義に関するGoogle Cloudのドキュメントを参照してください。

OpenShiftでKubernetesインテグレーションをディプロイするには、

<>{'<release_name>'}</>-newrelic-infrastructureサービスアカウントを特権セキュリティコンテキスト制限に追加します。
```
oc adm policy add-scc-to-user privileged \
system:serviceaccount:<namespace>:<release_name>-newrelic-infrastructure
```
インストーラによって提供されるデフォルトの<>{'<release_name>'}</>はnri-bundleです。
自動化されたインストーラの手順を完了します。
署名入りの証明書を使用している場合は、マニフェスト内のDaemonSet部分で以下の変数を使用して.pemファイルを設定することで、証明書が適切に設定されていることを確認します。ファイル：
```
- name: NRIA_CA_BUNDLE_DIR
  value: YOUR_CA_BUNDLE_DIR
- name: NRIA_CA_BUNDLE_FILE
  value: YOUR_CA_BUNDLE_NAME
```
YAMLキーパス: spec.template.spec.containers.name.env
変更内容を保存します。

カスタムマニフェスト

Kubernetesの自動化されたインストーラに必要な設定がない場合は、マニフェストテンプレートをダウンロードし、インテグレーションに手動でインストールできます。

Kubernetes インテグレーションをアクティブ化するには、newrelic-infraエージェントをDaemonSetとしてKubernetesクラスタにデプロイする必要があります。

kube-state-metricsをインストールして、クラスタで実行します。例:

curl -L -o kube-state-metrics-1.9.5.zip https://github.com/kubernetes/kube-state-metrics/archive/v1.9.5.zip && unzip kube-state-metrics-1.9.5.zip && kubectl apply -f kube-state-metrics-1.9.5/examples/standard

マニフェストファイルのダウンロード：
```
curl -O https://download.newrelic.com/infrastructure_agent/integrations/kubernetes/newrelic-infrastructure-k8s-latest.yaml
```
マニフェストのDaemonSet部分に、New Relicライセンスキーとクラスタ名を追加し、Kubernetesクラスタを特定します。両方の値が必要です。
- 推奨: マニフェストのNRIA_PASSTHROUGH_ENVIRONMENTまたはNRIA_DISPLAY_NAMEの値は変更しないでください。
- YOUR_CLUSTER_NAMEは、New RelicエクスプローラーのクラスターのIDです。環境で実行されているクラスターの名前と一致する必要はありません。
- YAMLキーパス: spec.template.spec.containers.name.env
```
env:
  - name: NRIA_LICENSE_KEY
    value: YOUR_LICENSE_KEY
  - name: CLUSTER_NAME
    value: YOUR_CLUSTER_NAME
```
マニフェストを環境に合わせる必要がある場合、本ドキュメントの設定セクションを確認してください。
kube-state-metricsがインストールされていることを確認します。
```
kubectl get pods --all-namespaces | grep kube-state-metrics
```

DaemonSetの作成：

kubectl create -f newrelic-infrastructure-k8s-latest.yaml

このコマンドの出力結果で、newrelic-infraを見つけて、DaemonSetが正常に作成されたことを確認します。
```
kubectl get daemonsets
```

インテグレーションが動作していることの確認: 数分待ってから、New Relic Kubernetesクラスタエクスプローラーでデータを検索します。

データが見つからない場合は、設定手順をもう一度確認して、トラブルシューティング手順に従ってください。

重要

今後、Kubernetesオブジェクトで収集されるラベル数は、オブジェクトタイプ（コンテナ、ポッド、ノード等）ごとに制限されます。オブジェクトのラベル数が制限を超えると、New Relicに常に送信する必要がある重要なラベルを設定できるようになります。制限が実施されると、このドキュメンテーションはアップデートされます。

NewRelicポッドをスケジュールできることを確認します。

一部のNewRelicポッドは、マニフェストファイルでDaemonSetとして設定されているため、すべてのホストで実行できます。これらには、newrelic-infrastructureとnewrelic-loggingが含まれます。まれに、他のポッドが最初にスケジュールされ、New Relicポッドのリソースが不足する場合があります。これらの各ポッドは特定のホストで実行する必要があるため、他のホストが使用可能であっても、そのホストに十分なリソースが確保されるまで、ポッドは保留状態のままになります。これは最終的に長期間発生する可能性があるため、レポートにギャップが生じる場合があります。

この状況を防ぐために、Kubernetesスケジューラーを設定して、New Relicポッドの優先度を高くすることができます。デフォルトスケジューラーの使用：

kube-schedulerフラグdisablePreemptionがtrueに設定されていないことを確認します（デフォルトでは falseです）。
New Relic DaemonSetポッド用のPriorityClassを作成します。
- 適切な優先度の値を設定します。通常、この値は他のポッドよりも高くする必要があります。
- デフォルトでは、preemptionPolicyはPreemptLowerPriorityに設定されます。これにより、この優先度クラスが割り当てられたNew Relicポッドは、リソースを消費する優先度の低いポッドを削除できます。

マニフェストファイルを編集して、priorityClassNameを任意のDaemonSet仕様に追加します。以下の例では、強調表示された行がnewrelic-infrastructureの優先度クラスを設定しています。

apiVersion: apps/v1
kind: DaemonSet
metadata:
  namespace: default
  labels:
    app: newrelic-infrastructure
    chart: newrelic-infrastructure-1.0.0
    release: nri-bundle
    mode: privileged
  name: nri-bundle-newrelic-infrastructure
spec:
  priorityClassName: your-priority-class
  ...

New Relicポッドをすでにデプロイしている場合は、それらを再デプロイして、作成されていることを確認します。
```
kubectl delete -f newrelic-infrastructure-k8s-latest.yaml
kubectl create -f newrelic-infrastructure-k8s-latest.yaml
kubectl get daemonsets
```

Kubernetesインテグレーションの特権なしインストール

セキュリティ要件が非常に厳しいプラットフォームには、Kubernetesインテグレーションの特権なしバージョンを提供しています。標準のKubernetesインテグレーションからの変更点は、次のとおりです。

rootではなく標準ユーザーとして、InfrastructureエージェントとKubernetesインテグレーションを実行
基盤となるホストファイルシステムにアクセスせず
/var/run/docker.sockにアクセスせず
コンテナのrootファイルシステムは読み取り専用でマウント
allowPrivilegeEscalationはfalseに設定
hostnetworkはfalseに設定

トレードオフとして、ソリューションはKubernetesからのメトリクスのみを収集しますが、基盤となるホストから直接メトリックは収集しません。Kubernetesはノード（ホスト）についてデータ（メトリックスおよびメタデータ）を提供します。

ヒント

オプション: 基盤となるホストメトリクスを収集するため、コンテナ化されていないInfrastructureエージェントを基盤となるホストにデプロイできます。Infrastructureエージェントはすでに、root以外での実行をサポートしています。非特権バージョンでのKubernetesインテグレーションとホストで実行されるエージェントを組み合わせると、Kubernetes監視のための標準のソリューションが受信するすべてのメトリックスがレポートされます。

kube-state-metricsをインストールして、クラスタで実行します。例:

curl -L -o kube-state-metrics-1.9.5.zip https://github.com/kubernetes/kube-state-metrics/archive/v1.9.5.zip && unzip kube-state-metrics-1.9.5.zip && kubectl apply -f kube-state-metrics-1.9.5/examples/standard

インテグレーションマニフェストファイルのダウンロード：

curl -O https://download.newrelic.com/infrastructure_agent/integrations/kubernetes/newrelic-infrastructure-k8s-unprivileged-latest.yaml

マニフェストで、 New Relicライセンスキーとクラスタ名を追加し、Kubernetesクラスタを識別します。両方の値が必要です。
重要
YOUR_CLUSTER_NAMEは、New RelicエクスプローラーのクラスターのIDです。環境で実行されているクラスターの名前と一致する必要はありません。
```
env:
  - name: NRIA_LICENSE_KEY
    value: YOUR_LICENSE_KEY
  - name: CLUSTER_NAME
    value: YOUR_CLUSTER_NAME
```
YAMLキーパス: spec.template.spec.containers.name.env
kube-state-metricsがインストールされていることを確認します。
```
kubectl get pods --all-namespaces | grep kube-state-metrics
```

DaemonSetの作成：

kubectl create -f newrelic-infrastructure-k8s-unprivileged-latest.yaml

このコマンドの出力結果でnewrelic-infraを検索し、DaemonSetの作成が正常に完了したことを確認します。
```
kubectl get daemonsets
```
インテグレーションが正しく設定されたことを確認するには、数分待った後、このNRQLクエリを実行してデータが報告されたかどうかを確認してください。
```
SELECT * FROM K8sPodSample since 5 minutes ago
```

インテグレーションの設定

Kubernetesインテグレーションには、ほとんどの環境で動作するデフォルト設定が付随しています。設定を変更するには、マニフェストファイルを変更します。

これは、デフォルトのFQDNではなく、SSLを使用している場合に必要となります。Kubernetes API FQDNは、SSL証明書のFQDNに一致する必要があります。

両方の変数を指定する必要はありません。たとえば、HOSTのみを指定する場合は、デフォルトのPORTが使用されます。

- name: "KUBERNETES_SERVICE_HOST" 
  value: "KUBERNETES_API_HOST"
- name: "KUBERNETES_SERVICE_PORT" 
  value: "KUBERNETES_API_TCP_PORT"

Kubernetesバージョン1.6～1.7.5の場合、マニフェストファイルの次の2行のコメントを外します。

- name: "CADVISOR_PORT" # Enable direct connection to cAdvisor by specifying the port.  Needed for Kubernetes versions prior to 1.7.6.
  value: "4194"

次の設定を使用して、DaemonSetのkube-state-metricsパーシングを無効化できます。

- name: "DISABLE_KUBE_STATE_METRICS"
   value: "true"

注意

kube-state-metricsを無効化すると、以下のデータ収集も無効化されます。

ReplicaSets
DaemonSets
StatefulSets
Namespaces
デプロイメント
サービス
エンドポイント
ポッド（保留中のもの)
また、これを無効化すると、次のようにKubernetesクラスターエクスプローラーに影響が生じます。
保留中のポッドは表示されません。
サービスに基づくフィルタリングは行われません。

kube-state-metricsの複数のインスタンスがクラスタにある場合は、コメントを外して次の行を設定し、どの行を使用するかを指定します。

- name: "KUBE_STATE_METRICS_URL"
   value: "http://KUBE_STATE_METRICS_IP_OR_FQDN:PORT"

重要

KUBE_STATE_METRICS_URLが定義されている場合でも、KSMサービスは自動発見プロセスに次のラベルの1つを含める必要があります。

k8s-app=kube-state-metrics
または
app=kube-state-metrics
または
app.kubernetes.io/name=kube-state-metrics

重要

この設定オプションは、KUBE_STATE_METRICS_POD_LABEL. をオーバーライドします。両方を定義した場合、KUBE_STATE_METRICS_POD_LABELは無効です。

kube-state-metricsのインスタンスがクラスタに複数ある場合は、Kubernetes インテグレーションによりこれらのインスタンスの1つを簡単にターゲットにする別のオプションは、ラベルベースの発見を使用するものです。

- name: "KUBE_STATE_METRICS_POD_LABEL"
   value: "LABEL_NAME"

重要

KUBE_STATE_METRICS_POD_LABELは定義されている場合、このラベルの値はtrueと等しくなります。たとえば、ラベル名がmy-ksmの場合は、my-ksm=trueであることを確認します。

重要

この設定オプションは、KUBE_STATE_METRICS_URLと互換性はありません。両方を定義した場合は、KUBE_STATE_METRICS_URLが使用されます。

kube-state-metricsのインスタンスがkube-rbac-proxyの背後にある場合、ラベルベースの発見とその他の2つの環境変数を組み合わせて使用するという互換性のある方法で、インテグレーションを設定できます。

- name: "KUBE_STATE_METRICS_SCHEME"
   value: "https"
 - name: "KUBE_STATE_METRICS_PORT"
   value: "KSM_RBAC_PROXY_PORT"

どのポートをKUBE_STATE_METRICS_PORTの値として使用するかを確認するため、kube-state-metricsポッドでdescribeコマンドを実行し、kube-rbac-proxy-mainという名前のコンテナで公開されるポートを検索することを推奨しています。

重要

これらの2つの設定オプションは、上記のKUBE_STATE_METRICS_POD_LABEL設定を使用する際にのみ機能します。

kube-state-metricsのクライアントタイムアウトを増やすには、新しい環境変数TIMEOUTをマニフェストファイル追加します。

env:
  - name: TIMEOUT
    value: 5000 # The default client timeout when calling kube-state-metrics, in milliseconds

その後、この新しい環境変数をNRIA_PASSTHROUGH_ENVIRONMENTに追加します。

デフォルトで、このインテグレーションによってKubernetes APIから取得されたすべての情報が5分間キャッシュされます。

APIサーバーからの応答のキャッシュ期間をカスタム設定するには、API_SERVER_CACHE_TTL環境変数を使用します。有効な時間単位値は、以下のとおりです。ns、us、ms、s、m、およびh。キャッシングを無効化するには、0sに設定します。

env: 
  - name: API_SERVER_CACHE_TTL 
    value: "1m"

Kubernetesコントロールプレーンのコンポーネントが、デフォルトと異なる基本URLにあるメトリックスをエクスポートする場合は、次の環境変数を使用します。これは、コントロールプレーンコンポーネントのメトリックスのエンドポイントがSSLまたは代替ポートを使用している場合に、OpenShiftなどの環境で必要です。

これらの環境変数の値は、[scheme]://[host]:[port]からの基本URLである必要があります。URLにパスコンポーネントを含めることはできません。例:

- name: "SCHEDULER_ENDPOINT_URL"
  value: "https://localhost:10259"
- name: "ETCD_ENDPOINT_URL"
  value: "https://localhost:9979"
- name: "CONTROLLER_MANAGER_ENDPOINT_URL"
  value: "https://localhost:10257"
- name: "API_SERVER_ENDPOINT_URL"
  value: "https://localhost:6443"

/metricsパスセグメントは、自動的に追加されます。また、httpsスキームを使用している場合、コントロールプレーンコンポーネントのポッドの認証は、サービスアカウントを通じて行われます。

注意

FQDN（完全修飾ドメイン名）をマルチマスタークラスタで使用している場合、一貫しない結果が返される場合があるため、localhostのみの使用を推奨します。

重要

カスタム基本URLを所定のコントロールプレーンコンポーネントに定義しても、コントロールプレーンコンポーネントのポッドに、自動発見プロセスでサポートされているラベルの1つを含める必要があります。

重要

カスタムETCD_ENDPOINT_URLを定義できますが、ETCDでは常にhttpsとmTLS認証を設定する必要があります。

考慮する追加設定は、次のとおりです。

Infrastructureエージェントの設定

Kubernetesインテグレーションイメージは、必要に応じて変更できるエージェントのデフォルト設定がされています。マニフェストでインストールする場合は、マニフェストを編集し、newrelic-infrastructure DaemonSetの環境変数としてとして、必要なエージェントの設定オプションを追加することで、infrastructureエージェント設定を変更できます。

Helmでインストールする場合は、GitHubの例に示されているように、values.yamlで必要なinfrastructureエージェント設定オプションを指定できます。

configオブジェクトを使用して、configMapを入力します。これは、newrelic-infrastructure DaemonSetによって作成されたポッド内のinfrastructureエージェント設定ファイルの場所に自動的に組み込まれます。

Kubernetesインテグレーションのアンインストール

以下の手順に従い、Kubernetesインテグレーションをインストールします。

newrelic-infrastructure-k8s-latest.yamlが、保存したマニフェストのファイル名に対応していることを確認します。
例: 特権なしバージョンのインテグレーションを使用している場合、デフォルトのファイル名はnewrelic-infrastructure-k8s-unprivileged-latest.yamlとなります。
ファイル名を確認した後、以下のコマンドを使用します。
```
kubectl delete -f newrelic-infrastructure-k8s-latest.yaml
```

クラスタ内のノード数にかかわらず、このコマンドを1回実行すれば十分です。

その他のヘルプ

さらに支援が必要な場合は、これらのサポートと学習リソースを確認してください：

Explorers Hubでは、コミュニティからのサポートを受けたり、ディスカッションに参加したりすることができます。
当社サイトで答えを見つけて、サポートポータルの使用方法を確認してください。
Linux、Windows、およびmacOS向けトラブルシューティングツールであるNew Relic Diagnosticsを実行してください。
New Relicのとandドキュメント

Kubernetesインテグレーション: インストールおよび設定

自動インストーラの使用

マネージドサービスとプラットフォーム向けのインストール

Amazon EKS Fargate

Google Kubernetes Engine （GKE）

OpenShiftコンテナプラットフォーム

Azure Kubernetes Service (AKS)

Pivotal Container Service (PKS / VMware Tanzu)

カスタムマニフェスト

重要

NewRelicポッドをスケジュールできることを確認します。

Kubernetesインテグレーションの特権なしインストール

ヒント

特権のないインストールを完了する手順

インテグレーションの設定

どのプロセスがデータをNew Relicに送信するかの選択

Kubernetes APIホストとポートの指定

Kubernetesバージョン1.6～1.7.5：マニフェストファイルの編集

環境変数の使用

kube-state-metricsパーシングの無効化

kube-state-metrics URLの指定

ラベルを使用したkube-state-metricsポッドの発見

RBACの背後のクエリkube-state-metrics

kube-state-metricsタイムアウト: クライアントタイムアウトの増加

デフォルト以外のネームスペースのデプロイメント: 設定ファイルの編集

Kubernetes API応答キャッシュのTTLの設定

コントロールプレーンコンポーネントのエンドポイントの基本URLの指定

Infrastructureエージェントの設定

最新バージョンにアップデート

自動インストーラの使用

Helmの使用

カスタムマニフェスト

Kubernetesインテグレーションのアンインストール

.css-3u3y73{fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}.css-1bvd50p{width:1rem;height:1rem;fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}その他のヘルプ

`kube-state-metrics`パーシングの無効化

`kube-state-metrics` URLの指定

ラベルを使用した`kube-state-metrics`ポッドの発見

RBACの背後のクエリ`kube-state-metrics`

`kube-state-metrics`タイムアウト: クライアントタイムアウトの増加

その他のヘルプ