基本クラスタを作成する

bmctl

プロジェクトで GKE On-Prem API（gkeonprem.googleapis.com）を有効にすると、新しく作成されたクラスタが自動的に API に登録されます。クラスタ構成ファイルで spec.gkeOnPremAPI が指定されていない場合でも、登録は行われます。この Google Cloud でホストされている API にクラスタを登録すると、Google Cloud コンソールまたは gcloud CLI を使用してクラスタのライフサイクルを管理できます。

自動登録を無効にするには、クラスタ構成ファイルの spec.gkeOnPremAPI セクションのコメントを削除し、クラスタを作成する前に spec.gkeOnPremAPI.enabled を false に設定します。spec.gkeOnPremAPI.enabled フィールドは変更可能であるため、それを作成した後にいつでもクラスタの登録を解除できます。

1. クラスタ構成ファイルを生成します。

   bmctl create config -c USER_CLUSTER_NAME \
     --project-id=PROJECT_ID

2. ユーザー クラスタ構成ファイルを確認します。

   次のクラスタ構成ファイルには、前述の計画テーブルに入力した値が入力されています。入力した値に加え、生成された構成ファイルとは次の違いがあります。

   • 読みやすくするために、このサンプルではコメントを削除しています。
   • クラスタ タイプ spec.type は、user に設定されています。
   • clusterrole/cluster-admin がアカウントに付与されるように、spec.clusterSecurity.authorization.clusterAdmin.gcpAccounts フィールドが追加されています。とりわけ、このフィールドによって Google Cloud コンソールでクラスタにログインして、クラスタの詳細を表示できます。

   ---
   apiVersion: v1
   kind: Namespace
   metadata:
     name: cluster-USER_CLUSTER_NAME
   ---
   apiVersion: baremetal.cluster.gke.io/v1
   kind: Cluster
   metadata:
     name: USER_CLUSTER_NAME
     namespace: cluster-USER_CLUSTER_NAME
   spec:
     type: user
     profile: default
     anthosBareMetalVersion: CLUSTER_VERSION
     gkeConnect:
       projectID: PROJECT_ID
     controlPlane:
       nodePoolSpec:
         nodes:
         - address: USER_CP_NODE_IP
     clusterNetwork:
       pods:
         cidrBlocks:
         - 192.168.0.0/16
       services:
         cidrBlocks:
         - 10.96.0.0/20
     loadBalancer:
       mode: bundled
       ports:
         controlPlaneLBPort: 443
       vips:
         controlPlaneVIP: USER_CP_VIP
         ingressVIP: USER_INGRESS_VIP
       addressPools:
       - name: pool1
         addresses:
         - START_IP-END_IP
     clusterOperations:
       projectID: PROJECT_ID
       location: us-central1
     clusterSecurity:
       authorization:
         clusterAdmin:
           gcpAccounts:
           - GOOGLE_ACCOUNT_EMAIL
     storage:
       lvpNodeMounts:
         path: /mnt/localpv-disk
         storageClassName: local-disks
       lvpShare:
         path: /mnt/localpv-share
         storageClassName: local-shared
         numPVUnderSharedPath: 5
     nodeConfig:
       podDensity:
         maxPodsPerNode: 250
     # GKEOnPremAPI (Optional) Specify if you wish to explicitly enable/disable the cloud hosted gkeonprem
     # API to enable/disable cluster lifecycle management from gcloud UI and Terraform.
     # gkeOnPremAPI:
       # enabled: false
       # location is the Cloud location for the cluster resource metadata where the cluster will be enrolled.
       # location: us-central1
   ---
   apiVersion: baremetal.cluster.gke.io/v1
   kind: NodePool
   metadata:
     name: node-pool-1
     namespace: cluster-USER_CLUSTER_NAME
   spec:
     clusterName: USER_CLUSTER_NAME
     nodes:
     - address: USER_WORKER_NODE_IP
   

3. 管理ワークステーションで生成された構成ファイルの内容を、上記サンプルの内容に置き換えます。

   生成された bmctl-workspace/USER_CLUSTER_NAME/USER_CLUSTER_NAME.yaml ファイルを開き、その内容を前の手順で確認したサンプルの内容に置き換えます。

4. ユーザー クラスタを作成します。

   bmctl create cluster -c USER_CLUSTER_NAME \
   --kubeconfig bmctl-workspace/ADMIN_CLUSTER_NAME/ADMIN_CLUSTER_NAME-kubeconfig

   bmctl コマンドは、プリフライト チェックを実行し、クラスタを作成するときに出力を画面に表示します。詳細情報は、管理ワークステーションの baremetal/bmctl-workspace/USER_CLUSTER_NAME/log フォルダのログに書き込まれます。

   クラスタの作成が完了するまでに数分を要する場合があります。

5. クラスタが作成され、動作していることを確認します。

   kubectl --kubeconfig bmctl-workspace/USER_CLUSTER_NAME/USER_CLUSTER_NAME-kubeconfig \
     get nodes

   クラスタが動作している場合、レスポンスは次のようになります。

   NAME    STATUS   ROLES           AGE     VERSION
   nuc-3   Ready    control-plane   4m32s   v1.26.2-gke.1001
   nuc-4   Ready    worker          2m2s    v1.26.2-gke.1001

コンソール

次の手順に沿って、コンソールでユーザー クラスタを作成します。

1. コンソールで、ベアメタル クラスタの作成ページに移動します。

   ベアメタル クラスタの作成ページに移動

2. Google Cloud プロジェクトのリストで PROJECT_ID が選択されていることを確認します。

3. [CREATE CLUSTER] をクリックします。

4. ダイアログで [オンプレミス] をクリックします。

5. [ベアメタル] の横にある [構成] をクリックします。[前提条件] ページが表示されます。

6. [クラスタタイプの選択] で、[既存の管理クラスタ用のユーザー クラスタを作成する] を選択します。

7. [次へ] をクリックします。

クラスタの基本

1. ユーザー クラスタの名前として「USER_CLUSTER_NAME」を入力するか、デフォルト値を使用します。

2. 新しく作成した管理クラスタが選択されていることを確認します。

3. [GCP API ロケーション] で、[us-central1] を選択します。

4. [Google Distributed Cloud version] で、CLUSTER_VERSION を選択するか、デフォルトを使用します。このページの残りの設定には、デフォルト値を使用できます。

5. 左側のナビゲーション バーで [ネットワーキング] をクリックします。

ネットワーキング

1. [コントロール プレーン] セクションで、[コントロール プレーン ノード IP 1] フィールドに次を入力します。

   USER_CP_NODE_IP
   

2. [ロードバランサ] セクションで、デフォルトのロードバランサ [バンドルされた MetalLB] を使用します。

3. [新しいアドレスプール] セクションに移動します。[IP アドレス範囲 1] フィールドに IP アドレス範囲を入力します。

   10.200.0.51-10.200.0.70
   

4. [Done] をクリックします。

5. [仮想 IP] セクションで、コントロール プレーン VIP の IP アドレスを入力します。

   USER_CP_VIP
   

6. Ingress VIP の IP アドレスを入力します。

   USER_INGRESS_VIP
   

7. プランナーで Service と Pod CIDR を変更していない場合は、[Service と Pod CIDR] セクションでデフォルト値を使用できます。

   CIDR を変更した場合は、使用する CIDR を入力します。

   • Service の CIDR:

   10.96.0.0/20
   

   • Pod の CIDR:

   192.168.0.0/16
   

8. 左側のナビゲーション バーで [デフォルト プール] をクリックします。

ノードプールを作成

クラスタには、ワーカーノード用のノードプールが少なくとも 1 つ必要です。ノードプールは、このクラスタで作成されるワーカーノードのグループのテンプレートです。

[ノードアドレス 1] フィールドに、ユーザー クラスタ ワーカーノードの IP アドレスを入力します。

USER_WORKER_NODE_IP

クラスタを作成する

1. [確認して作成] をクリックしてユーザー クラスタを作成します。

   ユーザー クラスタの作成には 15 分以上かかります。コンソールには、設定の確認とクラスタの作成中にステータス メッセージが表示されます。

   構成に問題がある場合は、構成の問題を修正してクラスタの作成を再試行できる十分な量のエラー メッセージがコンソールに表示されます。

   作成プロセスに関する追加情報を表示するには、[詳細を表示] をクリックしてサイドパネルを表示します。[close] をクリックすると、詳細パネルが閉じます。

   クラスタが作成されると、「クラスタ ステータス: 実行中」と表示されます。

2. クラスタが作成されたら、arrow_back [クラスタ] をクリックして [クラスタ] ページに戻ります。

gcloud CLI

このセクションでは、gcloud CLI を使用してユーザー クラスタとノードプールを作成する方法について説明します。

1. 次のコマンドを実行して、ユーザー クラスタを作成します。

   gcloud container bare-metal clusters create USER_CLUSTER_NAME \
     --project=PROJECT_ID \
     --location=us-central1 \
     --admin-cluster-membership=ADMIN_CLUSTER_NAME \
     --admin-cluster-membership-project=PROJECT_ID \
     --admin-cluster-membership-location=global \
     --version=CLUSTER_VERSION \
     --admin-users=GOOGLE_ACCOUNT_EMAIL \
     --island-mode-service-address-cidr-blocks=10.96.0.0/20 \
     --island-mode-pod-address-cidr-blocks=192.168.0.0/16 \
     --metal-lb-address-pools='pool=lb-pool-1,manual-assign=True,addresses=START_IP-END_IP' \
     --control-plane-node-configs='node-ip=USER_CP_NODE_IP' \
     --control-plane-vip=USER_CP_VIP \
     --control-plane-load-balancer-port=443 \
     --ingress-vip=USER_INGRESS_VIP \
     --lvp-share-path=/mnt/localpv-share \
     --lvp-share-storage-class=local-shared \
     --lvp-node-mounts-config-path=/mnt/localpv-disk \
     --lvp-node-mounts-config-storage-class=local-disks
   

   このコマンドからの出力は、次のようになります。

   Waiting for operation [projects/example-project-12345/locations/us-west1/operations/operation-1679543737105-5f7893fd5bae9-942b3f97-75e59179] to complete.
   

   この出力例では、operation-1679543737105-5f7893fd5bae9-942b3f97-75e59179 という文字列は長時間実行オペレーションの OPERATION_ID です。 オペレーションのステータスは、次のコマンドで確認できます。

   gcloud container bare-metal operations describe OPERATION_ID \
     --project=PROJECT_ID \
     --location=us-central1
   

   クラスタの作成には 15 分以上かかります。クラスタが作成されている間、上記のコマンドを繰り返し実行することで現在のステータスを取得できます。

   クラスタが作成されると、次のような出力が表示されます。

   Created Anthos cluster on bare metal [https://gkeonprem.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/bareMetalClusters/USER_CLUSTER_NAME].
   

2. クラスタを作成した後は、次のコマンドを実行して、新しく作成したクラスタにノードプールを作成します。

   gcloud container bare-metal node-pools create node-pool-1 \
     --cluster=USER_CLUSTER_NAME \
     --project=PROJECT_ID \
     --location=us-central1 \
     --node-configs node-ip=USER_WORKER_NODE_IP

詳細と他の例については、以下をご覧ください。

• gcloud container bare-metal clusters

• gcloud container bare-metal node-pools

• ユーザー クラスタの作成

Terraform

このセクションでは、Terraform を使用してユーザー クラスタとノードプールを作成する方法を説明します。

1. ディレクトリを作成し、そのディレクトリ内に新しいファイルを作成します。ファイル名の拡張子は .tf にする必要があります。このガイドでは、このファイルは main.tf と呼ばれます。

   mkdir DIRECTORY && cd DIRECTORY && touch main.tf
   

2. ユーザー クラスタの Terraform リソースを確認します。

   次の Terraform リソースの例には、前のセクションで計画テーブルに入力した値が入力されています。

   resource "google_gkeonprem_bare_metal_cluster"  "cluster-basic" {
     provider = google-beta
     name = "USER_CLUSTER_NAME"
     project = "PROJECT_ID"
     location = "us-central1"
     admin_cluster_membership = "projects/PROJECT_ID/locations/global/memberships/ADMIN_CLUSTER_NAME"
     bare_metal_version = "CLUSTER_VERSION"
     network_config {
       island_mode_cidr {
         service_address_cidr_blocks = ["10.96.0.0/20"]
         pod_address_cidr_blocks = ["192.168.0.0/16"]
       }
     }
     control_plane {
       control_plane_node_pool_config {
         node_pool_config {
           labels = {}
           operating_system = "LINUX"
           node_configs {
             labels = {}
             node_ip = "USER_CP_NODE_IP"
           }
         }
       }
     }
     load_balancer {
       port_config {
         control_plane_load_balancer_port = 443
       }
       vip_config {
         control_plane_vip = "USER_CP_VIP"
         ingress_vip = "USER_INGRESS_VIP"
       }
       metal_lb_config {
         address_pools {
           pool = "pool1"
           addresses = [
             "START_IP-END_IP"
           ]
           avoid_buggy_ips = true
           manual_assign = true
         }
       }
     }
     storage {
       lvp_share_config {
         lvp_config {
           path = "/mnt/localpv-share"
           storage_class = "local-shared"
         }
         shared_path_pv_count = 5
       }
       lvp_node_mounts_config {
         path = "/mnt/localpv-disk"
         storage_class = "local-disks"
       }
     }
     security_config {
       authorization {
         admin_users {
           username = "GOOGLE_ACCOUNT_EMAIL"
         }
       }
     }
   }
   
   resource "google_gkeonprem_bare_metal_node_pool" "node-pool-default" {
     provider = google-beta
     name =  "node-pool-1"
     bare_metal_cluster = google_gkeonprem_bare_metal_cluster.cluster-basic.name
     project = "PROJECT_ID"
     location = "us-central1"
     node_pool_config {
       operating_system = "LINUX"
       node_configs {
         node_ip = "USER_WORKER_NODE_IP"
       }
     }
   }
   

3. Terraform リソースを main.tf にコピーしてファイルを保存します。

4. Terraform プランを初期化して作成します。

   terraform init
   

   Terraform によって、Google Cloud プロバイダなどの必要なライブラリがインストールされます。

5. 構成を確認し、必要に応じて変更を加えます。

   terraform plan
   

6. Terraform プランを適用して、ユーザー クラスタを作成します。

   terraform apply
   

   プロンプトが表示されたら、「yes」と入力します。

   基本的なユーザー クラスタとノードプールを作成するには、約 15 分（ネットワークによってはそれ以上）かかります。

7. ユーザー クラスタの kubeconfig ファイルを作成するには、管理ワークステーションで次のコマンドを実行します。

   bmctl get credentials --cluster USER_CLUSTER_NAME \
   --admin-kubeconfig bmctl-workspace/ADMIN_CLUSTER_NAME/ADMIN_CLUSTER_NAME-kubeconfig

   コマンドの出力には、ユーザー クラスタの kubeconfig ファイルの名前が表示されます。たとえば、次のとおりです。

   bmctl-workspace/USER_CLUSTER_NAME/USER_CLUSTER_NAME-TIMESTAMP-kubeconfig

   ファイル名の TIMESTAMP は、ファイルが作成された日時を示します。

   このファイルにはクラスタの認証情報が含まれているため、アクセスが制限された安全なロケーションに保存する必要があります。

8. クラスタが作成され、動作していることを確認します。

   kubectl --kubeconfig bmctl-workspace/USER_CLUSTER_NAME/USER_CLUSTER_NAME-TIMESTAMP-kubeconfig \
       get nodes

   クラスタが動作している場合、レスポンスは次のようになります。

   NAME    STATUS   ROLES           AGE     VERSION
   nuc-3   Ready    control-plane   4m32s   v1.26.2-gke.1001
   nuc-4   Ready    worker          2m2s    v1.26.2-gke.1001

詳細と他の例については、以下をご覧ください。

• google_gkeonprem_bare_metal_cluster

• google_gkeonprem_bare_metal_node_pool

• terraform.tfvars.sample

• ユーザー クラスタの作成