クラスタの使用¶

クラスタの作成¶

クラスタを作成するには、Genvid Bastion が起動している必要があります。クラスタの管理には、 genvid-bastion スクリプトを使用します。以下のコマンドで、最低必要なサービスを開始します。

genvid-bastion install --bastionid mybastion --checkmodules --update-global-tfvars --loadconfig

--bastionid mybastion

bastion の一意の識別子です。次の形である必要があります。

3 ～ 32 文字。

小文字、数字、ハイフンのみで構成。

冒頭は必ず小文字のアルファベット。

--checkmodules

このオプションを使用して、インストールされていない場合に新しいモジュールをインストールしたり、既にインストールされている場合は更新を行います。

--update-global-tfvars

このオプションを使用してグローバル Terraform 変数を更新します。

--loadconfig

bastion にジョブとログをロード。

次のステップで、クラスタを管理するための Bastion-UI の Web サイトを開きます。

genvid-bastion monitor

Bastion-UI ページで、Bastion 名を変更できます。

Bastion の名前を変更します。

Update をクリックします

Terraform ページで:

Add Config をクリックします。

一意の ID を入力します。

カテゴリに cluster を選択します。

必要に応じて、他の backend を選択することができます。今は、デフォルトのままにしておきましょう。バックエンドによっては、変数の設定が必要になる場合があります。

クラスタの作成¶

似た構成の異なるクラスタを作成する場合、クローン機能を使うと便利です。Terraform 構成画面のクローンボタンをクリックします。

クラスタのステータス¶

クラスタ作成後、ステータスは EMPTY になっています。これは、クラスタにモジュールが必要であることを意味しています。クラスタのステータスには、次のようなものがあります。

VOID: クラスタが存在しません。
EMPTY: クラスタを作成したが、モジュールが存在しない。
DOWN: クラスタを初期化したが、リソースがない。
UP: Terraform apply 処理に成功した。
BUSY: コマンドを実行中です。
ERROR: クラスタのチェックでエラーが発生。
INVALID: 無効、またはステータスが不明。

Terraform モジュールのインポート¶

クラスタを構成する前に、モジュールを初期化する必要があります。そうすることで、モジュールのテンプレートがコピーされ、必要なモジュール、プラグインがダウンロードされます。

Commands をクリックします。
SDK-{version}/basic/basic_cluster のモジュールを選択します。
Import module をクリックします。

初期化ログが表示されます。このステップには、数秒間かかります。

Terraform 設定¶

Terraform は、クラスタのインフラストラクチャを構築するために使用します。設定値は、クラスタのインフラストラクチャ構築に使用されます。クラスタの Settings のサブリンクをクリックして、設定を編集します。

使いやすさのため、ページの設定を JSON ファイルにダウンロードすることもできます。編集したファイルをフォーム上でドラッグ&ドロップして、複数の設定を一度に編集したり、以前の構成に戻すことができます。保存されていない構成は失われるため、注意してください。

設定	説明	デフォルト値
admin_password	Windows マシンの管理者パスワードです。Windows マシンは、他のサーバーインスタンス、または [1] に同じ外部 IP が設定された他のマシンからのみ、アクセス可能です。	1genvid6
ami_prefix	ゲーム AMI の共通プレフィックスです。 AMI の保存のセクションで使用したプレフィックスです。自分の AMI でテストしたい場合は、変更することができます。	default
ami_version	AMI の正しいバージョンを探すためのプレフィックスフィルタ。クラスタを異なる SDK バージョンにバインドしたい場合は変更可能。	Current SDK version
datacenter	Nomad がローカルエージェントのグループ化に使用するデータセンター名です。	default
force_az	すべてのインスタンスを、指定したアベイラビリティゾーンで構成します。 AMI の開始で使用したものと同じになります。アベイラビリティゾーンは us-east-1d のように、完全な形で指定する必要があります。ゾーンで使用できる G2 や C5 インスタンスがない場合、ゾーンを変更する必要があります。現在、特定のゾーンでインスタンスが使用できるかどうかを確認する方法はありません。	none
instance_encoding_count	Terraform が作成するエンコーディングサーバー数を指定します。	1
instance_encoding_type	Terraform がサーバーのエンコードに使用する AWS インスタンスのタイプを指定します。	c5.2xlarge
instance_game_count	Terraform が作成するゲームサーバー数を指定します。	1
instance_game_type	Terraform がゲームサーバーに使用する AWS インスタンスのタイプを指定します。	g2.2xlarge
instance_internal_count	Terraform が作成する内部サーバー数を指定します。	1
instance_internal_type	Terraform が内部サーバーに使用する AWS インスタンスのタイプを指定します。	t2.small
instance_public_count	Terraform が作成するパブリックサーバー数を指定します。	1
instance_public_type	Terraform がパブリックサーバーに使用する AWS インスタンスのタイプを指定します。	t2.small
instance_server_count	Terraform が作成する admin サーバー数を指定します。	1
instance_server_type	Terraform が admin サーバーに使用する AWS インスタンスのタイプを指定します。	t2.small
region	クラスタを作成する AWS 領域です。G2 インスタンスを含むすべてのリージョンを使用できます。	us-east-1
namespace	クラスタの現在のデプロイプロジェクト名です。この値は、AWS タグ構成の一部で、AWS コンソールでリソースのグループ化に役立ちます。	deployment
stage	クラスタが含まれるステージ名です。この値は、AWS タグ構成の一部で、AWS コンソールでリソースのグループ化に役立ちます。	dev
vpc_cidr_block	Terraform が、新たに作成された VPC の新しいサブネットの作成に使用する CIDR ブロックを指定します。vpc_auto_create と連動して動作します。好きな CIDR ブロックに変更することもできます。	10.0.0.0/16
admin_username	クラスタ VM の接続と初期化に使用する管理者アカウントの名前を指定します。	gadmin

[1]	セキュリティ向上のため、将来のクラスタのバージョンでは bastion ホストを使用する予定です。

次の 2 つの設定値は、環境変数をもとに自動的に設定されます。手動で設定する必要はありません。

cluster はクラスタの名称です。

bastionid は、Bastion の名称です。

basic_cluster の構成は、新しい VPC やキーペアを作成したりなど、あらゆる処理を行います。より詳細な制御を行いたい場合や、権限により AWS VPC や Role の作成が行えない場合、 minimal_cluster の構成を行って、以下の要素を提供することができます。

設定	説明	デフォルト値
key_pair_private	EC2 インスタンスの管理に使用する SSH キーのプライベートな部分を指定します。キーは、次のようになります。—–BEGIN RSA PRIVATE KEY—–n… n—–END RSA PRIVATE KEY—–n	null
key_pair_public	EC2 インスタンスの管理に使用する SSH key のパブリックな部分を指定します。キーは、次のようになります。ssh-rsa …	null
iam_policy_name_game	Terraform のゲームサーバー接続の IAM ポリシーを指定します。デフォルト値が Terraform に新しいポリシーを作成させます。	null
iam_policy_name_server	Terraform の Genvid サーバー接続の IAM ポリシーを指定します。デフォルト値が Terraform に新しいポリシーを作成させます。	null
vpc_id	新しく作成する代わりに使用する VPC ID を指定します。これにより、クラスタ間で VPC を共有できます。vpc_id は次のようになります : vpc-…	null

変数の設定方法の詳細については、Terraform Configuration Documentation を参照してください。

Terraform プロバイダ¶

プロバイダはクラスタ、より具体的にはそのクラスタにインポートされたモジュールに固有のものです。したがって、新しいクラスタを作成し、そこにモジュールをインポートすることから始めましょう。

../_images/bastion_ui_basic_cluster_init.png

図 6 最初のインポートで、ダウンロードされているプロバイダプラグインが表示されます。特定のモジュールで使用されているプロバイダを知るのに最適な方法です。

すべてのプロバイダには、識別のための独自の引数セットがあります。特定のプロバイダをカスタマイズする方法を知る一番の方法は、Terraform Providers のページにアクセスして、興味のある特定のプロバイダを検索することです。

重要

モジュールをインポートするときに、各プロバイダに使用するバージョンを常に指定する必要があります。そうしないと、terraform init コマンドがそれぞれに利用可能な最新バージョンを使用します。そのため、更新によって大幅な変更が実施された場合に、環境が不安定になる可能性があります。

詳細は Terraform documentation を参照してください。

Terraform プロバイダのカスタマイズ¶

(グローバル) デフォルト構成¶

プロバイダの構成は 2 レベルでカスタマイズできます。グローバル (bastion) レベル、またはモジュールをインポートした直後のクラスタです。グローバル構成は、新しいクラスタに (またはモジュールの再インポート時に) デフォルト構成を提供することを目的としています。

../_images/bastion_ui_global_terraform_providers.png

bastion のインストール中に、こうした構成をセットアップして、提供されるモジュールのいずれかを使用してクラスタがそのまま動作するようにします。情報は、bastion-services/terraform/providers/default.json に保存されているファイルから読み込まれます。

モジュールをクラスタにインポートすると、このモジュールが使用するプロバイダのデフォルト構成のみが適用されます。そのため、すべてのモジュールで使用されないプロバイダ構成を追加しても安全です。

../_images/bastion_ui_global_terraform_provider_add.png

プロバイダに新しいデフォルト構成を追加するには:

Bastion UI ページを開く。
Settings をクリックします。
Providers をクリックします。
+ NEW PROVIDER をクリックします。
カスタマイズするプロバイダを識別するために、Provider 、Alias にユニークな名前を入力する。
- オプション: そのプロバイダで使用する指定のデフォルト Version を設定することもできます。
重要

Provider と Alias に使用する識別子は、モジュールをクラスタにインポートするときにチェックされます。そのモジュールで使用されるプロバイダと一致しない場合、デフォルトの構成は適用されません。
プロバイダに設定する引数が複数存在する場合は、+ をクリックしてそれぞれを追加する。
SAVE をクリックしてプロバイダ構成を保存する。

クラスタごとの構成¶

クラスタにモジュールをインポートした後、(Terraform の) Provider タブに移動して、現在の構成を確認できます。

../_images/bastion_ui_provider_need_module.png

図 7 Settings タブと同様に、モジュールをまだインポートしていない場合は、 Commands ページに移動して、インポートするように促されます。

一部のプロバイダがこの時点までに自動的に適用されるグローバル構成を持つものでない限り、デフォルトでは構成は空でなければなりません。クラスタのプロバイダに加えられた変更は、そのクラスタにのみ影響します。

警告

クラスタのモジュールが再インポートされると、グローバル構成がその構成をオーバーライドします。

../_images/bastion_ui_initial_provider_configuration.png

図 8 この例から分かるように、プロバイダの引数の値を指定するために Terraform 変数の補間がサポートされています。

クラスタが作成され、カスタマイズするプロバイダが分かったら、トップメニューから Terraform に移動し、左側のメニューからクラスタ名の下の Provider に移動できます。

重要

プロバイダのバージョンを変更した後、新しいバージョンをダウンロードするには、新しい terraform init コマンドを実行する必要があります。

プロバイダをカスタマイズする作業は、グローバルな場合と非常によく似ています。+ ADD PROVIDER ボタンは、まだリストされていないプロバイダの構成を追加するために使用します。それ以外の場合は、編集ボタン (左の Action ボタン) を使用して、既存の構成をカスタマイズできます。

警告

プロバイダ構成の変更は、Refresh コマンドを実行するまで有効にならない場合があります。

Terraform プロバイダの引数¶

バージョン、エイリアス、引数などのメタ引数を区別していることにお気付きかもしれません。

これらのメタ引数はすべてのプロバイダに存在し、Terraform の init フェーズで参照されます。他の引数は plan または apply フェーズで使用され、プロバイダによって異なります。

注釈

plan フェーズでいくつかの引数が無視されている場合、Refresh を実行して Terraform の状態を新しい構成で更新してみてください。

独自の Terraform モジュールを作成しない場合、プロバイダエイリアスは必要ない可能性がありますが、上記で確認したように、バージョンは非常に重要です。詳細については、Terraform Provider Configuration ページをご覧ください。

Terraform プロバイダのツールボックスのサポート¶

ツールボックスには、プロバイダの管理に役立つサブコマンドが用意されています。次の表は、使用可能なコマンドをまとめたものです。

コマンド	説明
genvid-bastion get-default-terraform-providers	現在のグローバルプロバイダ構成を JSON で表示する。
genvid-bastion set-default-terraform-providers	get-default-terraform-providers の形式と一致する JSON ファイルからグローバルプロバイダ構成を設定する。
genvid-bastion delete-default-terraform-providers	既存のグローバルプロバイダ構成を削除する。
genvid-clusters get-terraform-providers	指定のクラスタの指定の現在のプロバイダ構成を表示する。
genvid-clusters set-terraform-providers	get-terraform-providers の形式と一致する JSON ファイルから指定クラスタのプロバイダ構成を設定する。
genvid-clusters delete-terraform-providers	指定のクラスタの指定の既存のプロバイダ構成を削除する。

最も簡単に新しいプロバイダ構成を作成する方法は、bastion UI を使用後にツールボックスを使用して構成をファイルにリダイレクトすることですが、手動で構成する場合の例を次に示します。

[
    {
        "provider": "aws",
        "meta": {
            "alias": null,
            "version": "~> 2.17"
        },
        "arguments": {
            "region": "us-west-2"
        }
    },
    {
        "provider": "template",
        "meta": {
            "alias": null,
            "version": "~> 2.1"
        },
        "arguments": {}
    },
    {
        "provider": "tls",
        "meta": {
            "alias": "myalias",
            "version": null,
        },
        "arguments": {}
    }
]

Terraform インフラストラクチャの適用¶

Terraform Apply は、クラスタのインフラストラクチャを構築するための処理です。

Plan Apply をクリックして、実行プランを作成します。
変更内容が、必要な内容と一致しているかを検証します。
変更内容の検証後、Apply をクリックしてプランを実行します。

ログが表示されます。

Terraform によるインフラストラクチャの構築に失敗した場合:

エラーメッセージを確認します。
設定を更新します。
もう一度適用します。

この手順が完了すると、クラウド上でクラスタが動作します。Terraform ページの All Configs を確認すると、ステータスは UP になっています。これは、インフラストラクチャが構築できていて、Genvid SDK が存在していないことを表しています。

重要

バージョン 1.19.0 より、Terraform がインスタンスを作成した後、バックグラウンドでインスタンスのプロビジョンを行います。ただ、インスタンスを使用する前に、インスタンスがクラスタ UI に Nomad クライアントとして登録されるまで少し時間がかかります。特に、Windows インスタンスは準備が整うまでに最大 30 分かかることがあります。

注釈

パブリック IP は、AMI 設定時に使用した IP とは違います。

ゲーム機にアクセスするには、AMI 設定中に設定したものと同じパスワードで game_public_ips の IP を使用します。

game_public_ips の取得方法:

クラスタが UP であることを確認します。
クラスタの Commands ページに移動します。
OUTPUT ボタンをクリックします。

game_public_ips は、JSON ファイル内に記述されています。

実行中のクラスタでのSDKの設定¶

クラスタのステータスが UP になってから、Genvid SDK を設定して、プロジェクトを実行します。

クラウドの SDK ガイドの手順に従ってください。

Terraform インフラストラクチャの廃止¶

terraform destroy コマンドは、クラスタ設定からすべてのリソースを削除します。そのクラスタでプロジェクトを実行する必要がなくなった場合は、クラスタの Terraform インフラストラクチャだけを廃止してください。Terraform インフラストラクチャを廃止するには、Plan destroy ボタンをクリックします。

現在の Terraform インフラストラクチャを廃止して構わなければ、Destroy ボタンをクリックします。

詳細はインフラストラクチャの廃止を参照してください。

クラスタの削除¶

クラスタを削除するには、まず、Terraform インフラストラクチャを廃止します。All Configs で、 Delete ボタンをクリックします。

カスタムレポジトリの使用¶

bastion の Terraform のレポジトリは、追加や削除を行うことができます。各レポジトリには、クラスタのインスタンスを作成するモジュールが含まれています。現在のレポジトリを一覧表示するには、以下のコマンドを使用します。

genvid-clusters module-list

新規モジュールを追加するには、以下のコマンドを実行します。

genvid-clusters module-add -u {URL} {name}

{URL} には go-getter と互換性のあるすべてのソースを指定できます (ローカルファイルを含みます)。
{name} は、bastion でのこのレポジトリの保存フォルダです。

bastion レポジトリで URL をクローン後、modules/module のソースとして利用できるようになります。モジュールの使用方法についての詳細は、Terraform’s Module Configuration を参照してください。

Bastion は、モジュールの起源を記憶しているため、以下のコマンドでアップデートできます。

genvid-clusters module-update [name]

名前の指定はオプションです。指定しない場合、すべてのレポジトリが更新されます。

以下のコマンドを使用して、モジュールを削除できます。

genvid-clusters module-remove {name}

参考

genvid-clusters: Genvid Cluster-Management スクリプト解説書。
Terraform の Bastion API: Terraform の Bastion API
Terraform のモジュール設定: Terraform のモジュールの解説書
go-getter: Go で URL を取得するライブラリ。

Related Topics

目次

クラスタの使用¶

クラスタの作成¶

クラスタの作成¶

クラスタのステータス¶

Terraform モジュールのインポート¶

Terraform 設定¶

Terraform プロバイダ¶

Terraform プロバイダのカスタマイズ¶

(グローバル) デフォルト構成¶

クラスタごとの構成¶

Terraform プロバイダの引数¶

Terraform プロバイダのツールボックスのサポート¶

Terraform インフラストラクチャの適用¶

実行中のクラスタでのSDKの設定¶

Terraform インフラストラクチャの廃止¶

クラスタの削除¶

カスタムレポジトリの使用¶