GKE アドオンでのインストール

Standard

このページでは、Config Connector アドオンを使用して Google Kubernetes Engine（GKE）クラスタに Config Connector をインストールする方法について説明します。

それぞれのインストールオプションのメリットとデメリットの詳細については、インストールタイプの選択をご覧ください。

始める前に

作業を始める前に、次のことを確認してください。

Google Kubernetes Engine API を有効にします。

Google Kubernetes Engine API の有効化

このタスクに Google Cloud CLI を使用する場合は、gcloud CLI をインストールして初期化します。すでに gcloud CLI をインストールしている場合は、gcloud components update を実行して最新のバージョンを取得します。
注: gcloud CLI がすでにインストールされている場合には、必ず compute/region と compute/zone のプロパティを設定してください。デフォルトの場所を設定することで、gcloud CLI のエラー（One of [--zone, --region] must be supplied: Please specify location など）を防止できます。

Config Connector をインストールする Google Cloud プロジェクトを作成または選択します。
以前に Config Connector を手動でインストールした場合は、Config Connector アドオンをインストールする前に Config Connector アンインストールしてください。
- クラスタモードのアンインストール
- 名前空間モードのアンインストール

Config Connector アドオンのインストール

Config Connector アドオンを使用するには、新しい GKE クラスタを作成するか、既存のクラスタでそれを有効化します。Config Connector アドオンをインストールしたら、Google サービスアカウントと Namespace を使用して Config Connector インストールを構成します。

要件

Config Connector アドオンには次の要件があります。

次の GKE バージョンを使用する必要があります。
- 1.15.11-gke.5 以降
- 1.16.8-gke.8 以降
- 1.17.4-gke.5 以降
Config Connector を有効にしたクラスタで、Workload Identity プールと Kubernetes Engine Monitoring を有効にする必要があります。

GKE クラスタを設定する

Config Connector アドオンは、新規または既存のクラスタで使用できます。

Config Connector アドオンを有効にして新しいクラスタを作成する

GKE クラスタは、gcloud CLI または Google Cloud Console を使用して作成できます。

gcloud

Google Cloud CLI を使用してクラスタを作成するには、次のコマンドを実行します。

gcloud container clusters create CLUSTER_NAME \
    --release-channel CHANNEL \
    --addons ConfigConnector \
    --workload-pool=PROJECT_ID.svc.id.goog \
    --logging=SYSTEM \
    --monitoring=SYSTEM

以下を置き換えます。

CLUSTER_NAME を GKE クラスタの名前に置き換えます。
CHANNEL を GKE リリースチャンネルに置き換えます。rapid と regular がサポートされています。
PROJECT_ID は、Google Cloud プロジェクト ID に置き換えます。

Google Cloud コンソール

Google Cloud コンソールでクラスタを作成するには、次の操作を行います。

Google Cloud コンソールで Google Kubernetes Engine のメニューに移動します。

Google Kubernetes Engine のメニューに移動
[作成] をクリックします。[Kubernetes クラスタの作成] ページが表示されます。
クラスタの [名前] を指定します。
サポートされている [マスターバージョン] を選択します。
必要に応じて残りのクラスタを構成します。
ナビゲーションパネルの [クラスタ] の下の [セキュリティ] をクリックします。
[ワークロード ID を有効にする] チェックボックスをオンにします。
左側のナビゲーションパネルで、[クラスタ] の下の [機能] をクリックします。
[Config Connector を有効にする] チェックボックスをオンにします。
[作成] をクリックします。

クラスタを作成したら、ID の作成に進みます。

既存のクラスタで Config Connector アドオンを有効にする

gcloud または Google Cloud Console を使用して、既存の GKE クラスタで Config Connector アドオンを有効にできます。

前提条件

既存のクラスタで Config Connector アドオンを有効にする前提条件は以下のとおりです。

Config Connector アドオンの要件を満たすクラスタが必要です。
Config Connector をインストールするクラスタに Workload Identity を設定します。

注: 既存のクラスタで Workload Identity を有効にしても、クラスタの既存のノードプールで Workload Identity が自動的に有効にはなりません。Config Connector は任意のクラスタで実行できるため、クラスタのすべてのノードプールで Workload Identity を有効にすることをおすすめします。

ノードプールの Workload Identity を有効にするには、gcloud コマンドラインツールを使用します。

gcloud container node-pools update NODE_POOL \
    --workload-metadata=GKE_METADATA \
    --cluster CLUSTER_NAME

以下を置き換えます。

NODE_POOL をノードプールの名前に置き換えます。
CLUSTER_NAME をクラスタ名に置き換えます。

Config Connector アドオンを有効にする

Config Connector アドオンは、Google Cloud CLI または Google Cloud Console を使用して既存の GKE クラスタで有効にできます。

gcloud

既存の GKE クラスタで Config Connector アドオンを有効にするには、Google Cloud CLI を使用します。

gcloud container clusters update CLUSTER_NAME \
    --update-addons ConfigConnector=ENABLED

CLUSTER_NAME を GKE クラスタの名前に置き換えます。

Google Cloud コンソール

Google Cloud コンソールで Google Kubernetes Engine のメニューに移動します。

Google Kubernetes Engine のメニューに移動
Config Connector をインストールするクラスタを選択します。[クラスタの詳細] ページが表示されます。
[機能] セクションで、Config Connector の行を見つけて [ 編集] をクリックします。
[Config Connector を有効にする] チェックボックスをオンにして、[変更を保存] をクリックし、クラスタを更新します。

ID を作成する

Config Connector は、Identity and Access Management（IAM）サービスアカウントで認証し、GKE の Workload Identity を使用して IAM サービスアカウントを Kubernetes サービスアカウントにバインドすることで、Google Cloud リソースを作成、管理します。

ID を作成するには、次の手順を行います。

IAM サービスアカウントを作成する。既存のサービスアカウントを使用する場合は、そのアカウントを使用してこの手順を省略できます。

サービスアカウントを作成するには、次のコマンドを使用します。
```
  gcloud iam service-accounts create SERVICE_ACCOUNT_NAME
```
SERVICE_ACCOUNT_NAME をサービスアカウントの名前に置き換えます。

サービスアカウントの作成の詳細については、サービスアカウントの作成と管理をご覧ください。

IAM サービスアカウントに、プロジェクトへの昇格した権限を付与します。
```
gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
    --role="roles/editor"
```
以下を置き換えます。
- PROJECT_ID: プロジェクト ID。
- SERVICE_ACCOUNT_NAME: サービスアカウントの名前。
注: 編集者ロールを付与すると、IAM の変更など、プロジェクトや組織全体の構成を除くほとんどの Config Connector 機能が使用できます。本番環境では、よりきめ細かいアクセス許可を設定することをおすすめします。IAM ロールの詳細については、ロールについてをご覧ください。
IAM サービスアカウントと、Config Connector が実行する事前定義された Kubernetes サービスアカウントの間の IAM ポリシーバインディングを作成します。
```
gcloud iam service-accounts add-iam-policy-binding \
SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
    --member="serviceAccount:PROJECT_ID.svc.id.goog[cnrm-system/cnrm-controller-manager]" \
    --role="roles/iam.workloadIdentityUser"
```
以下を置き換えます。
- SERVICE_ACCOUNT_NAME: サービスアカウントの名前。
- PROJECT_ID: プロジェクト ID。

Config Connector を構成する

インストールを完了するには、ConfigConnector CustomResource の構成ファイルを作成し、kubectl apply コマンドを使用してそれを適用します。Config Connector Operator は、Google Cloud リソースの CRD と Config Connector コンポーネントをクラスタにインストールします。

演算子をクラスタモードとして構成するには、次の手順を行います。

次の YAML ファイルを configconnector.yaml という名前のファイルにコピーします。

# configconnector.yaml
apiVersion: core.cnrm.cloud.google.com/v1beta1
kind: ConfigConnector
metadata:
  # the name is restricted to ensure that there is only one
  # ConfigConnector resource installed in your cluster
  name: configconnector.core.cnrm.cloud.google.com
spec:
 mode: cluster
 googleServiceAccount: "SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"

以下を置き換えます。

SERVICE_ACCOUNT_NAME: サービスアカウントの名前。
PROJECT_ID: プロジェクト ID。

kubectl apply を使用してクラスタに構成を適用します。
```
  kubectl apply -f configconnector.yaml
```

リソースを作成する場所の指定

Config Connector では、プロジェクト、フォルダ、組織別にリソースを編成できます。これは、Google Cloud でリソースを編成するのと同じ方法です。

Config Connector を使用してリソースを作成する前に、リソースを作成する場所を構成する必要があります。Config Connector は、リソースを作成する場所を決定するために、リソース構成または既存の Namespace のアノテーションを使用します。詳細については、リソースの整理をご覧ください。

この目的の Namespace がない場合は、kubectl を使用して Namespace を作成します。

kubectl create namespace NAMESPACE

NAMESPACE を実際の Namespace 名に置き換えます。例: config-connector

タブを選択して、Config Connector がリソースを作成する場所を選びます。

プロジェクト

特定のプロジェクトにリソースを作成するには、次のコマンドを実行します。

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/project-id=PROJECT_ID

以下を置き換えます。

NAMESPACE は、実際の Namespace 名に置き換えます。
PROJECT_ID は、Google Cloud プロジェクト ID に置き換えます。

フォルダ

特定のフォルダにリソースを作成するには、次のコマンドを実行します。

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/folder-id=FOLDER_ID

以下を置き換えます。

NAMESPACE は、実際の Namespace 名に置き換えます。
FOLDER_ID は、Google Cloud フォルダ ID に置き換えます。

組織

特定の組織にリソースを作成するには、次のコマンドを実行します。

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/organization-id=ORGANIZATION_ID

以下を置き換えます。

NAMESPACE は、実際の Namespace 名に置き換えます。
ORGANIZATION_ID は、Google Cloud 組織 ID に置き換えます。

名前空間にアノテーションを付けると、Config Connector は対応するプロジェクト、フォルダー、または組織にリソースを作成します。Config Connector が Kubernetes Namespace を使用する方法の詳細については、Kubernetes Namespace と Google Cloud プロジェクトをご覧ください。

インストールの確認

Config Connector は、すべてのコンポーネントを cnrm-system という名前の Namespace で実行します。Pod の準備ができていることを確認するには、次のコマンドを実行します。

kubectl wait -n cnrm-system \
      --for=condition=Ready pod --all

Config Connector が正しくインストールされている場合、出力は次のようになります。

pod/cnrm-controller-manager-0 condition met

Config Connector のアップグレード

クラスタの Config Connector アドオンのアップグレードは、Google Cloud によって管理されます。

アップグレードが行われるたびに、クラスタ内のリソースが保持されます。

Google Cloud で Config Connector アドオンのアップグレードを管理する方法について確認するか、Config Connector の最新バージョンを取得する方法に進んでください。

Google Cloud で Config Connector アドオンのアップグレードを管理する方法

GKE クラスタが取得する Config Connector のバージョンは、クラスタの GKE のマイナーバージョンによって異なります。次に例を示します。

GKE マイナーバージョン	Config Connector バージョン
1.20	1.69.0
1.21	1.69.0
1.22	1.71.0
1.23	1.82.0
1.24	1.89.0

バージョンが認定されると、Google Cloud で、最新の GKE マイナーバージョンが新たにリリースされた Config Connector バージョンに再マッピングされます。この操作は、Regular リリースチャンネルまたは Stable リリースチャンネルで公開されていないくらい新しい GKE マイナーバージョンすべてに対して行われます。

クラスタが取得する Config Connector のバージョンは、クラスタの GKE マイナーバージョンによって異なるため、クラスタの Config Connector アドオンが Google Cloud によって自動的にアップグレードされるのには 2 つのケースがあります。

クラスタは、より新しい Config Connector バージョンにマッピングされた新しい GKE マイナーバージョンにアップグレードされます。

注: 新しいマイナーバージョンがより新しい Config Connector バージョンにマッピングされる場合、GKE クラスタが新しいマイナーバージョンにアップグレードされてから Config Connector がアップグレードされるまでに、最長で 1 週間かかることがあります。
クラスタが、Regular リリースチャンネルまたは Stable リリースチャンネルで公開されていないくらい新しい GKE マイナーバージョンの場合、Google Cloud はその GKE マイナーバージョンを新しい Config Connector バージョンに再マッピングします。

Google Cloud が GKE マイナーバージョンを再マッピングし、既存のクラスタを新しい Config Connector バージョンにアップグレードする場合、その GKE マイナーバージョンに「新しい Config Connector バージョンをロールアウトする」と言われます。

Google Cloud は、安定性の理由から、Regular リリースチャンネルや Stable リリースチャンネルのバージョンで公開されているくらいの古い GKE マイナーバージョンに、新しい Config Connector バージョンをロールアウトしません。ただし、広範囲に及ぶ問題が検出された緊急時は除きます。

Config Connector の最新バージョンを取得するには

Config Connector アドオンを介してインストールされた Config Connector のバージョンは、大幅に遅れる（最大 12 か月）可能性があります。最新バージョンの Config Connector が必要な場合は、Config Controller に切り替えるか、手動で Config Connector をインストールし、アップグレードすることをおすすめします。各オプションの移行手順は次のとおりです。

Config Controller に切り替えるには、Config Controller の移行手順に沿って、既存の Config Connector リソースを Config Controller インスタンスに移行します。
Config Connector を手動でインストールするには、Config Connector アドオンから手動インストールに切り替える手順に沿って操作してください。

Config Connector のアンインストール

Config Connector をアンインストールするには、次の手順を実行します。

kubectl delete を使用して、コントローラコンポーネントとともに Config Connector CRD を削除します。
```
kubectl delete ConfigConnector configconnector.core.cnrm.cloud.google.com --wait=true
```
gcloud CLI または Google Cloud Console を使用して、クラスタ内の Config Connector アドオンを無効にします。
gcloud
gcloud で Config Connector アドオンを無効にするには、次のコマンドを実行します。
```
gcloud container clusters update CLUSTER_NAME --update-addons ConfigConnector=DISABLED
```
CLUSTER_NAME は、Config Connector アドオンがインストールされているクラスタの名前に置き換えます。
Cloud コンソール
Google Cloud Console から Config Connector アドオンを無効にするには、次の手順を実行します。
1. Google Cloud Console の [Google Kubernetes Engine Clusters] ページに移動し、更新するクラスタを選択します。
  
  Google Kubernetes Engine のメニューに移動
2. [編集] をクリックします。[クラスタの編集] 画面が表示されます。
3. [アドオン] をクリックします。
4. [Config Connector] を選択し、[Disabled] を選択します。
5. [保存] をクリックしてクラスタを更新します。

次のステップ

Config Connector を使ってみる。
Config Connector のトラブルシューティング方法を確認する。