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

このページでは、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 を実行して最新のバージョンを取得する。

• 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 コンソールを使用して作成できます。

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

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

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

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

前提条件

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

• Config Connector アドオンの要件を満たすクラスタが必要です。

• 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 コンソールを使用して既存の GKE クラスタで有効にできます。

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

ID を作成する

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

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

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

     gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

   SERVICE_ACCOUNT_NAME をサービス アカウントの名前に置き換えます。

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

2. 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: サービス アカウントの名前。
3. 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 コンポーネントをクラスタにインストールします。

クラスタモードとしてオペレータを構成するには、次の操作を行います。

1. 次の 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"
     # Setting `stateIntoSpec` to `Absent` is recommended. It means setting `cnrm.cloud.google.com/state-into-spec`
     # annotation to `absent` for all Config Connector resources created in the cluster in the future.
     # It prevents Config Connector from populating unspecified fields into the spec.
     stateIntoSpec: Absent

   次のように置き換えます。
   • SERVICE_ACCOUNT_NAME: サービス アカウントの名前。
   • PROJECT_ID: プロジェクト ID。
2. kubectl apply を使用してクラスタに構成を適用します。

     kubectl apply -f configconnector.yaml

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

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

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

kubectl create namespace NAMESPACE

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

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

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

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

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/organization-id=ORGANIZATION_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 のマイナー バージョンによって異なります。次に例を示します。

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

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

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

2. クラスタが、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 をアンインストールするには、次の手順を実行します。

1. kubectl delete を使用して、コントローラ コンポーネントとともに Config Connector CRD を削除します。

   kubectl delete ConfigConnector configconnector.core.cnrm.cloud.google.com --wait=true
   

2. gcloud CLI または Google Cloud コンソールを使用して、クラスタ内の Config Connector アドオンを無効にします。

   gcloud

   gcloud で Config Connector アドオンを無効にするには、次のコマンドを実行します。

   gcloud container clusters update CLUSTER_NAME --update-addons ConfigConnector=DISABLED
   

   CLUSTER_NAME は、Config Connector アドオンがインストールされているクラスタの名前に置き換えます。

   Cloud コンソール

   Google Cloud コンソールから Config Connector アドオンを無効にするには、次の手順を実行します。

   1. Google Cloud コンソールの [Google Kubernetes Engine Clusters] ページに移動し、更新するクラスタを選択します。

      Google Kubernetes Engine のメニューに移動

   2. [編集] をクリックします。[クラスタの編集] 画面が表示されます。

   3. [アドオン] をクリックします。

   4. [Config Connector] を選択し、[Disabled] を選択します。

   5. [保存] をクリックしてクラスタを更新します。

次のステップ

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