クラスタの登録

このページでは、レルムの Game Servers クラスタの登録、一覧表示、詳細表示を行う方法について説明します。

始める前に

始める前に、Game Servers の概要の主なコンセプトを理解しておくことをおすすめします。次のタスクも完了していることを確認してください。

Game Services API が有効になっていることを確認します。

Game Services API を有効にする

gcloud CLI がインストールされているシェルを選択するか、API クライアントを使用します。

Cloud Shell

Cloud Shell を起動するには、次の手順に従います。

Google Cloud Console に移動します。

Google Cloud Console
コンソールの右上隅にある [Cloud Shell をアクティブにする] ボタンをクリックします。

コンソールの下部にあるフレーム内で Cloud Shell セッションが開きます。このシェルで gcloud コマンドを実行します。

ローカルシェル

gcloud CLI をインストールします。

Google Cloud CLI に必要なデフォルトのプロジェクトが設定されていることを確認します（設定されていない場合、後でコマンドごとに --project フラグを明示的に指定する必要があります）。

gcloud config list project

デフォルトプロジェクトを設定していない場合は、次のコマンドを実行して、デフォルトプロジェクトを設定します。PROJECT_ID は、設定するプロジェクト ID に置き換えてください。

gcloud config set project PROJECT_ID

次のコマンドを実行して、Google Cloud CLI のバージョンを確認します。Game Servers には、gcloud CLI のバージョン 306.0.0 以降が必要です。

gcloud version

インストールを更新するには、次のコマンドを実行します。

gcloud components update

curl / PowerShell

REST API を curl または Windows PowerShell で使用するには、次の操作を行います。

サービスアカウントを作成する。
秘密鍵を JSON ファイルとしてダウンロードします。
環境変数 GOOGLE_APPLICATION_CREDENTIALS を、認証情報を含む JSON ファイルのパスに設定します。この変数は現在のシェルセッションにのみ適用されるため、新しいセッションを開く場合は、変数を再度設定する必要があります。
例: Linux または macOS
```
export GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"
```
KEY_PATH は、認証情報が含まれる JSON ファイルのパスに置き換えます。

例:
```
export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
```
例: Windows

PowerShell の場合:
```
$env:GOOGLE_APPLICATION_CREDENTIALS="KEY_PATH"
```
KEY_PATH は、認証情報が含まれる JSON ファイルのパスに置き換えます。

例:
```
$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
```
コマンドプロンプトの場合:
```
set GOOGLE_APPLICATION_CREDENTIALS=KEY_PATH
```
KEY_PATH は、認証情報が含まれる JSON ファイルのパスに置き換えます。

クライアントライブラリ

Google Cloud Game Servers は、クライアントライブラリを使用して、プログラムで制御できます。ライブラリと認証の手順については、クライアントライブラリの概要をご覧ください。

クラスタの登録

Game Servers のレルムを作成していることを確認します。

Agones がインストールされている Google Kubernetes Engine（GKE）クラスタがない場合は、次の手順を実行します。

Agones 用の公開 Google Kubernetes Engine クラスタとファイアウォールルールを作成します。Kubernetes Engine API を有効にしてください。

なお、Game Servers では、限定公開クラスタはサポートされていません。

Agones のファイアウォールルールが有効になっていることを確認します。

gcloud compute firewall-rules list --filter="name~'game-server.*'"

次の出力が表示されます。

NAME                               NETWORK  DIRECTION  PRIORITY  ALLOW    DENY  DISABLED
game-server-firewall-test-cluster  default  INGRESS    1000      udp:7000-8000  False

Agones をインストールします。
Agones と Kubernetes クラスタのバージョンが準拠していることと、Agones がagones-system名前空間にインストールされていることを確認します（Agones のインストールの確認をご覧ください）。

Game Servers クラスタの登録

Console

Google Cloud コンソールで、[レルムとクラスタ] ページに移動します。

Game Servers に移動
[Add Game Server Cluster] をクリックします。
[Realms to choose from] リストから、ゲームサーバークラスタが属するレルムを選択します。[Create a Realm] ボタンをクリックすると、必要に応じてレルムを作成できます。
[続行] をクリックします。
[Game server cluster ID] ボックスに、このゲームサーバークラスタの一意の識別子を入力します。
[Kubernetes クラスタ] リストで、Agones がインストールされている Kubernetes クラスタを選択します。
[作成] をクリックします。

gcloud

Google Cloud CLI を使用して、Game Servers クラスタをレルムに登録することができます。

グローバル Game Servers クラスタの登録

グローバル Game Servers クラスタを登録するには:

次のコマンドを実行します。realmID などのプレースホルダの値は、適切な値に置き換えます。
```
gcloud game servers clusters create gscID --realm=realmID --gke-cluster=gkeCluster --namespace=default --dry-run
```
登録する前に新しいクラスタをプレビューできるように、出力では targetState が返されます。

グローバルクラスタを登録して作成するには、次のコマンドを実行します。

gcloud game servers clusters create gscID --realm=realmID --gke-cluster gkeCluster --namespace=default --no-dry-run

リージョン Game Servers クラスタの登録

リージョン Game Servers クラスタを登録するには:

次のコマンドを実行します。realmID などのプレースホルダの値は、適切な値に置き換えます。
```
gcloud game servers clusters create gscID --realm=realmID --gke-cluster gkeCluster --location=region --namespace=default --dry-run
```
新しいクラスタを作成する前にプレビューできるように、出力では targetState が返されます。

リージョンクラスタを登録して作成するには、次のコマンドを実行します。

gcloud game servers clusters create gscID --realm=realmID --gke-cluster gkeCluster --location=region --namespace=default --no-dry-run

接続しようとしているクラスタを Game Servers が検証できない場合、次のエラーが表示されることがあります。

Cannot connect to the provided Kubernetes cluster "projects/project/locations/location/clusters/gkeCluster, check the name and make sure that the cluster exists

その場合は、gkeCluster の形式が正しいこと、クラスタが project に location で存在することを確認してください。

変数のプレースホルダは、次の説明のとおりです。

gscID は、このクラスタに指定できる一意の ID です。
realmID は、クラスタを保存するレルムの一意の ID です。
gkeCluster は、GKE クラスタの完全修飾されたリソースパスです（たとえば、projects/<projectId>/locations/<location>/clusters/<clusterId>）。
region は、クラスタのリージョンです。親レルムと同じリージョンを選択します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

PROJECT_ID: IAM 設定に載っている Google Cloud プロジェクト ID。
REALM_LOCATION: このクラスタを保存するレルムのリージョンまたは global。
REALM_ID: このクラスタを保存するレルムの識別子。
GS_CLUSTER_ID: クラスタのユーザー定義の識別子。
GKE_CLUSTER_LOCATION: GKE クラスタのリージョン。
GKE_CLUSTER_ID: GKE クラスタの識別子。

JSON 本文をリクエストします。

{
  "name": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID",
  "connectionInfo": {
    "namespace": "default",
    "gkeClusterReference": {
      "cluster": "projects/PROJECT_ID/locations/GKE_CLUSTER_LOCATION/clusters/GKE_CLUSTER_ID"
    }
  }
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザーアカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存します。ターミナルで次のコマンドを実行して、このファイルを現在のディレクトリに作成または上書きします。

cat > request.json << 'EOF'
{
  "name": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID",
  "connectionInfo": {
    "namespace": "default",
    "gkeClusterReference": {
      "cluster": "projects/PROJECT_ID/locations/GKE_CLUSTER_LOCATION/clusters/GKE_CLUSTER_ID"
    }
  }
}
EOF

そのうえで、次のコマンドを実行して REST リクエストを送信します。

curl -X POST \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @request.json \
    "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters?gameServerClusterId=GS_CLUSTER_ID"

PowerShell（Windows）

@'
{
  "name": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID",
  "connectionInfo": {
    "namespace": "default",
    "gkeClusterReference": {
      "cluster": "projects/PROJECT_ID/locations/GKE_CLUSTER_LOCATION/clusters/GKE_CLUSTER_ID"
    }
  }
}
'@  | Out-File -FilePath request.json -Encoding utf8

その後、次のコマンドを実行して REST リクエストを送信します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters?gameServerClusterId=GS_CLUSTER_ID" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/REALM_LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.gaming.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID",
    "verb": "create",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

Game Servers クラスタを作成すると、Game Servers によって Agones フリートとオートスケーラーが必要に応じて作成されます。Game Servers では、手動で作成された Agones フリートは変更されません。

クラスタの一覧表示

Console

Google Cloud コンソールで、[レルムとクラスタ] ページに移動します。

Game Servers に移動
レルムを展開して、レルムに所属するゲームサーバークラスタを確認します。
フィルタボックスを使用すると、レルムとクラスタのリストをさまざまなプロパティでフィルタリングできます。

gcloud

Google Cloud CLI を使用して、グローバルクラスタまたはリージョンクラスタを一覧表示できます。

グローバルとリージョンの両方のクラスタを一覧表示するには、次のコマンドを実行します。オプションの --view=FULL フラグを追加して、クラスタにインストールされている Agones と Kubernetes のバージョンを表示します。

gcloud game servers clusters list [--view=FULL; default="BASIC"]

リージョン内のクラスタのみを一覧表示するには、次のコマンドを実行します。region は、クラスタを一覧表示するリージョンに置き換えます。

gcloud game servers clusters list --location=region [--view=FULL; default="BASIC"]

レルム内のすべてのクラスタを一覧表示するには、次のコマンドを実行します。realmID は、親のレルムに、region は、クラスタを一覧表示するリージョンに置き換えます。

gcloud game servers clusters list --realm=realmID --location=region [--view=FULL; default="BASIC"]

REST

リクエストのデータを使用する前に、次のように置き換えます。

PROJECT_ID: IAM 設定に載っている Google Cloud プロジェクト ID。
REALM_LOCATION: レルムのリージョンまたは global。
REALM_ID: レルムのユーザー定義の識別子。

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

次のコマンドを実行します。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters?view=full"

PowerShell（Windows）

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters?view=full" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "gameServerClusters": [
    {
      "name": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/my-gs-cluster-1",
      "createTime": CREATE_TIME,
      "updateTime": UPDATE_TIME,
      "connectionInfo": {
        "namespace": "default",
        "gkeClusterReference": {
          "cluster": "projects/PROJECT_ID/locations/GKE_CLUSTER_LOCATION/clusters/my-gke-cluster-1"
        }
      },
      "etag": "8mBC7IJJFvY40k-rBabOOaGR6sSRG3dP6pI-frTuu9Y",
      "clusterState": {
        "agonesVersionInstalled": "1.15.0",
        "kubernetesVersionInstalled": "1.18.20-gke.900",
        "installationState": "AGONES_KUBERNETES_VERSION_SUPPORTED",
        "provider": "gke"
      }
    },
    {
      "name": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/my-gs-cluster-2",
      "createTime": CREATE_TIME,
      "updateTime": UPDATE_TIME,
      "connectionInfo": {
        "namespace": "default",
        "gkeClusterReference": {
          "cluster": "projects/PROJECT_ID/locations/GKE_CLUSTER_LOCATION/clusters/my-gke-cluster-2"
        }
      },
      "etag": "8mBC7IJJFvY40k-rBabOOaGR6sSRG3dP6pI-frTuu9Y",
      "clusterState": {
        "agonesVersionInstalled": "1.15.0",
        "kubernetesVersionInstalled": "1.18.20-gke.900",
        "installationState": "AGONES_KUBERNETES_VERSION_SUPPORTED",
        "provider": "gke"
      }
    }
  ]
}

クラスタの詳細表示

Console

Google Cloud コンソールで、[レルムとクラスタ] ページに移動します。

Game Servers に移動
レルムを展開して、レルムに所属するゲームサーバークラスタを確認します。
レルムの最後のテーブル列で、省略記号をクリックして、[詳細を表示] を選択します。

gcloud

作成時間や GKE クラスタの詳細など、クラスタの詳細を表示するには、Google Cloud CLI を使用します。

クラスタの詳細を表示するには、次のコマンドを実行します。realmID などのプレースホルダ値は、適切な値に置き換えます。

gcloud game servers clusters describe gscID --realm realmID --location=region [--view=FULL; default="BASIC"]

クラスタの詳細が出力に表示されます。オプションの --view=FULL フラグを追加して、クラスタにインストールされている Agones と Kubernetes のバージョンを表示します。

変数のプレースホルダは、次の説明のとおりです。

gscID は、この Game Servers クラスタ用に指定した一意の ID です。
realmID は、クラスタが保存されているレルムの一意の ID です。
region は、クラスタのリージョンです。親レルムと同じリージョンを選択します。

REST

リクエストのデータを使用する前に、次のように置き換えます。

PROJECT_ID: IAM 設定に載っている Google Cloud プロジェクト ID。
REALM_LOCATION: レルムのリージョンまたは global。
REALM_ID: レルムのユーザー定義の識別子。
GS_CLUSTER_ID: クラスタのユーザー定義の識別子。

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

次のコマンドを実行します。

curl -X GET \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID?view=full"

PowerShell（Windows）

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID?view=full" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID",
  "createTime": CREATE_TIME,
  "updateTime": UPDATE_TIME,
  "connectionInfo": {
    "namespace": "default",
    "gkeClusterReference": {
      "cluster": "projects/PROJECT_ID/locations/GKE_CLUSTER_LOCATION/clusters/MY_GKE_CLUSTER"
    }
  },
  "etag": "8mBC7IJJFvY40k-rBabOOaGR6sSRG3dP6pI-frTuu9Y",
  "clusterState": {
    "agonesVersionInstalled": "1.15.0",
    "kubernetesVersionInstalled": "1.18.20-gke.900",
    "installationState": "AGONES_KUBERNETES_VERSION_SUPPORTED",
    "provider": "gke"
  }
}

クラスタの更新

gcloud

クラスタのフィールドを更新するには、既存のクラスタの識別子を置き換えてから gcloud game servers clusters update コマンドを実行します。次のコマンドは、クラスタの説明フィールドを更新します。

gcloud game servers clusters update gscID \
    --realm=realmID --location=region \
    --description="My updated description" --no-dry-run

他のクラスタフィールドのフラグを確認するには、gcloud リファレンスをご覧ください。

REST

次のサンプルでは、description フィールドを更新します。他のフィールドを更新するには、フィールド名を ?updateMask= クエリパラメータに追加して、JSON 本文をリクエストします。

リクエストのデータを使用する前に、次のように置き換えます。

PROJECT_ID: IAM 設定に載っている Google Cloud プロジェクト ID。
REALM_LOCATION: レルムのリージョンまたは global。
REALM_ID: レルムの識別子。
GS_CLUSTER_ID: クラスタのユーザー定義の識別子。

JSON 本文をリクエストします。

{
  "description": "My updated description"
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

cat > request.json << 'EOF'
{
  "description": "My updated description"
}
EOF

そのうえで、次のコマンドを実行して REST リクエストを送信します。

curl -X PATCH \
    -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json; charset=utf-8" \
    -d @request.json \
    "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID?updateMask=description"

PowerShell（Windows）

@'
{
  "description": "My updated description"
}
'@  | Out-File -FilePath request.json -Encoding utf8

その後、次のコマンドを実行して REST リクエストを送信します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://gameservices.googleapis.com/v1/projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID?updateMask=description" | Select-Object -Expand Content

次のような JSON レスポンスが返されます。

{
  "name": "projects/PROJECT_ID/locations/REALM_LOCATION/operations/OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.gaming.v1.OperationMetadata",
    "createTime": CREATE_TIME,
    "target": "projects/PROJECT_ID/locations/REALM_LOCATION/realms/REALM_ID/gameServerClusters/GS_CLUSTER_ID",
    "verb": "update",
    "requestedCancellation": false,
    "apiVersion": "v1"
  },
  "done": false
}

トラブルシューティング

IAM 権限エラー

権限が正しく設定されていない場合、次のエラーが表示されます。

Cannot connect to the provided Kubernetes cluster "projects/projectId/locations/location/clusters/gkeCluster", make sure that "service-projectNumber@gcp-sa-gameservices.iam.gserviceaccount.com" has been granted the required permissions to access the cluster

このエラーが発生した場合は、このセクションの手順に従って IAM 権限を設定してください。

Google Cloud プロジェクトで Game Servers リソースを作成すると、Game Servers によって Game Servers の Google マネージドサービスアカウント（serviceAccount:service-projectNumber@gcp-sa-gameservices.iam.gserviceaccount.com という形式をとる）が作成されます。このサービスアカウントには、事前定義された Game Servers roles/gameservices.serviceAgent ロールが自動的に付与されます。このロールにより、登録する GKE クラスタを管理するために必要な権限が Google マネージドサービスアカウントに付与されます。このロールを取り消すと、上記のエラーメッセージが表示されます。

次のコマンドは、サービスアカウントに Game Servers roles/gameservices.serviceAgent のロールを付与する構文を示しています。

gcloud projects add-iam-policy-binding projectId --role roles/gameservices.serviceAgent --member serviceAccount:service-projectNumber@gcp-sa-gameservices.iam.gserviceaccount.com

ここで

projectId はプロジェクト ID です。projectId は、gcloud config get-value project を実行して取得できます。
gcloud projects describe projectId を実行すると、projectNumber を取得できます。

次のステップ

クラスタを削除する方法を確認する。

クラスタの登録

始める前に

Cloud Shell

ローカルシェル

curl / PowerShell

クライアント ライブラリ

クラスタの登録

Game Servers クラスタの登録

Console

gcloud

グローバル Game Servers クラスタの登録

リージョン Game Servers クラスタの登録

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

クラスタの一覧表示

Console

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

クラスタの詳細表示

Console

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

クラスタの更新

gcloud

REST

curl（Linux、macOS、Cloud Shell）

PowerShell（Windows）

トラブルシューティング

IAM 権限エラー

次のステップ

クライアントライブラリ