GS2-Version GS2-Deploy/CDK リファレンス

エンティティ

Namespace

ネームスペース

ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。 GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。

そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。

	型	必須	値の制限	説明
name	string	✓	~ 32文字	ネームスペース名
description	string		~ 1024文字	説明文
assumeUserId	string	✓	~ 1024文字	ユーザGRN
acceptVersionScript	ScriptSetting			バージョンを承認したときに実行するスクリプト
checkVersionTriggerScriptId	string		~ 1024文字	バージョンチェック処理を実行する GS2-Script のスクリプト
logSetting	LogSetting			ログの出力設定

GetAttr

	型	説明
Item	Namespace	作成したネームスペース

実装例

Type: GS2::Version::Namespace
Properties:
  Name: namespace1
  Description: null
  AssumeUserId: grn:gs2::YourOwnerId:identifier:user:user-0001
  AcceptVersionScript: null
  CheckVersionTriggerScriptId: null
  LogSetting: 
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1

from gs2_cdk import Stack, core, version

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        version.Namespace(
            stack=self,
            name="namespace-0001",
            assume_user_id='grn:gs2::YourOwnerId:identifier:user:user-0001',
            options=version.NamespaceOptions(
                log_setting=core.LogSetting(
                    logging_namespace_id='grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001',
                ),
            ),
        )

print(SampleStack().yaml())  # Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Version\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            assumeUserId: "grn:gs2::YourOwnerId:identifier:user:user-0001",
            options: new \Gs2Cdk\Version\Model\Options\NamespaceOptions(
                logSetting: new \Gs2Cdk\Core\Model\LogSetting(
                    loggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
                ),
            ),
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.version.model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-0001",
            new io.gs2.cdk.version.model.options.NamespaceOptions() {
                {
                    logSetting = new io.gs2.cdk.core.model.LogSetting(
                        "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                    );
                }
            }
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

import core from "@/gs2cdk/core";
import version from "@/gs2cdk/version";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new version.model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-0001",
            {
                logSetting: new core.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                )
            }
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Version.Model.Namespace(
            this,
            "namespace-0001",
            "grn:gs2::YourOwnerId:identifier:user:user-0001",
            new Gs2Cdk.Gs2Version.Model.Options.NamespaceOptions {
                logSetting = new Gs2Cdk.Core.Model.LogSetting(
                    "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                ),
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

CurrentVersionMaster

現在有効なマスターデータ

GS2ではマスターデータの管理にJSON形式のファイルを使用します。ファイルをアップロードすることで、実際にサーバーに設定を反映することができます。

JSONファイルを作成する方法として、マネージメントコンソール上でのマスターデータエディタを提供していますがよりゲームの運営に相応しいツールを作成し、適切なフォーマットのJSONファイルを書き出すことでもサービスを利用可能です。

JSONファイルの形式についてはドキュメントを参照ください。

	型	必須	デフォルト	値の制限	説明
namespaceName	string	✓		~ 32文字	ネームスペース名
settings	string	✓		~ 5242880文字	マスターデータ

GetAttr

	型	説明
Item	CurrentVersionMaster	更新した現在有効なバージョン

実装例

Type: GS2::Version::CurrentVersionMaster
Properties:
  NamespaceName: namespace1
  Settings: {
    "version": "2019-10-09",
    "versionModels": [
      {
        "name": "app",
        "metadata": "APP",
        "warningVersion": {
          "major": 2,
          "minor": 2,
          "micro": 2
        },
        "errorVersion": {
          "major": 1,
          "minor": 1,
          "micro": 1
        },
        "scope": "passive",
        "needSignature": false
      },
      {
        "name": "asset",
        "metadata": "ASSET",
        "warningVersion": {
          "major": 3,
          "minor": 3,
          "micro": 3
        },
        "errorVersion": {
          "major": 2,
          "minor": 2,
          "micro": 2
        },
        "scope": "passive",
        "needSignature": true,
        "signatureKeyId": "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
      },
      {
        "name": "eula",
        "metadata": "EULA",
        "warningVersion": {
          "major": 4,
          "minor": 4,
          "micro": 4
        },
        "errorVersion": {
          "major": 3,
          "minor": 3,
          "micro": 3
        },
        "scope": "active",
        "currentVersion": {
          "major": 2,
          "minor": 2,
          "micro": 2
        }
      }
    ]
  }

from gs2_cdk import Stack, core, version

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        version.Namespace(
            stack=self,
            # 省略
        ).master_data(
            [
                version.VersionModel(
                    name='app',
                    scope='passive',
                    options=version.VersionModelOptions(
                        metadata='APP',
                        warning_version={'major': 2, 'minor': 2, 'micro': 2},
                        error_version={'major': 1, 'minor': 1, 'micro': 1},
                    ),
                ),
                version.VersionModel(
                    name='asset',
                    scope='passive',
                    options=version.VersionModelOptions(
                        metadata='ASSET',
                        warning_version={'major': 3, 'minor': 3, 'micro': 3},
                        error_version={'major': 2, 'minor': 2, 'micro': 2},
                        need_signature=True,
                        signature_key_id='grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001',
                    ),
                ),
                version.VersionModel(
                    name='eula',
                    scope='active',
                    options=version.VersionModelOptions(
                        metadata='EULA',
                        current_version={'major': 2, 'minor': 2, 'micro': 2},
                        warning_version={'major': 4, 'minor': 4, 'micro': 4},
                        error_version={'major': 3, 'minor': 3, 'micro': 3},
                    ),
                ),
            ],
        )

print(SampleStack().yaml())  # Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        (new \Gs2Cdk\Version\Model\Namespace_(
            stack: $this,
            // 省略
        ))->masterData(
            [
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"app",
                    scope: \Gs2Cdk\Version\Model\Enums\CurrentVersionMasterScope::PASSIVE
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"APP",
                        warningVersion:{'major': 2, 'minor': 2, 'micro': 2},
                        errorVersion:{'major': 1, 'minor': 1, 'micro': 1},
                    ),
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"asset",
                    scope: \Gs2Cdk\Version\Model\Enums\CurrentVersionMasterScope::PASSIVE
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"ASSET",
                        warningVersion:{'major': 3, 'minor': 3, 'micro': 3},
                        errorVersion:{'major': 2, 'minor': 2, 'micro': 2},
                        needSignature:True,
                        signatureKeyId:"grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    ),
                ),
                new \Gs2Cdk\Version\Model\VersionModel(
                    name:"eula",
                    scope: \Gs2Cdk\Version\Model\Enums\CurrentVersionMasterScope::ACTIVE
                    options: new \Gs2Cdk\Version\Model\Options\VersionModelOptions(
                        metadata:"EULA",
                        currentVersion:{'major': 2, 'minor': 2, 'micro': 2},
                        warningVersion:{'major': 4, 'minor': 4, 'micro': 4},
                        errorVersion:{'major': 3, 'minor': 3, 'micro': 3},
                    ),
                ),
            ],
        );
    }
}

print((new SampleStack())->yaml());  // Generate Template

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.version.model.Namespace(
            this,
            // 省略
        ).masterData(
            Arrays.asList(
                new io.gs2.cdk.version.model.VersionModel(
                    "app",
                    Passive,
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "APP";
                            warningVersion: {'major': 2, 'minor': 2, 'micro': 2};
                            errorVersion: {'major': 1, 'minor': 1, 'micro': 1};
                        }
                    }
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "asset",
                    Passive,
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "ASSET";
                            warningVersion: {'major': 3, 'minor': 3, 'micro': 3};
                            errorVersion: {'major': 2, 'minor': 2, 'micro': 2};
                            needSignature: true;
                            signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001";
                        }
                    }
                ),
                new io.gs2.cdk.version.model.VersionModel(
                    "eula",
                    Active,
                    new io.gs2.cdk.version.model.options.VersionModelOptions() {
                        {
                            metadata: "EULA";
                            currentVersion: {'major': 2, 'minor': 2, 'micro': 2};
                            warningVersion: {'major': 4, 'minor': 4, 'micro': 4};
                            errorVersion: {'major': 3, 'minor': 3, 'micro': 3};
                        }
                    }
                )
            )
        );
    }
}

System.out.println(new SampleStack().yaml());  // Generate Template

import core from "@/gs2cdk/core";
import version from "@/gs2cdk/version";

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new version.model.Namespace(
            this,
            // 省略
        ).masterData(
            [
                new version.model.VersionModel(
                    "app",
                    version.model.CurrentVersionMasterScope.PASSIVE,
                    {
                        metadata: "APP",
                        warningVersion: {'major': 2, 'minor': 2, 'micro': 2},
                        errorVersion: {'major': 1, 'minor': 1, 'micro': 1}
                    }
                ),
                new version.model.VersionModel(
                    "asset",
                    version.model.CurrentVersionMasterScope.PASSIVE,
                    {
                        metadata: "ASSET",
                        warningVersion: {'major': 3, 'minor': 3, 'micro': 3},
                        errorVersion: {'major': 2, 'minor': 2, 'micro': 2},
                        needSignature: true,
                        signatureKeyId: "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001"
                    }
                ),
                new version.model.VersionModel(
                    "eula",
                    version.model.CurrentVersionMasterScope.ACTIVE,
                    {
                        metadata: "EULA",
                        currentVersion: {'major': 2, 'minor': 2, 'micro': 2},
                        warningVersion: {'major': 4, 'minor': 4, 'micro': 4},
                        errorVersion: {'major': 3, 'minor': 3, 'micro': 3}
                    }
                )
            ]
        );
    }
}

console.log(new SampleStack().yaml());  // Generate Template

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Version.Model.Namespace(
            this,
            // 省略
        ).MasterData(
            new [] {
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "app",
                    Gs2Cdk.Gs2Version.Model.Enums.CurrentVersionMasterScope.Passive,
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "APP",
                        warningVersion = {'major': 2, 'minor': 2, 'micro': 2},
                        errorVersion = {'major': 1, 'minor': 1, 'micro': 1},
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "asset",
                    Gs2Cdk.Gs2Version.Model.Enums.CurrentVersionMasterScope.Passive,
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "ASSET",
                        warningVersion = {'major': 3, 'minor': 3, 'micro': 3},
                        errorVersion = {'major': 2, 'minor': 2, 'micro': 2},
                        needSignature = true,
                        signatureKeyId = "grn:gs2:ap-northeast-1:YourOwnerId:key:namespace-0001:key:key-0001",
                    }
                ),
                new Gs2Cdk.Gs2Version.Model.VersionModel(
                    "eula",
                    Gs2Cdk.Gs2Version.Model.Enums.CurrentVersionMasterScope.Active,
                    new Gs2Cdk.Gs2Version.Model.Options.VersionModelOptions {
                        metadata = "EULA",
                        currentVersion = {'major': 2, 'minor': 2, 'micro': 2},
                        warningVersion = {'major': 4, 'minor': 4, 'micro': 4},
                        errorVersion = {'major': 3, 'minor': 3, 'micro': 3},
                    }
                )
            }
        );
    }
}

Debug.Log(new SampleStack().Yaml());  // Generate Template

ScriptSetting

	型	必須	デフォルト	値の制限	説明
triggerScriptId	string			~ 1024文字	スクリプトGRN
doneTriggerTargetType	enum [’none’, ‘gs2_script’, ‘aws’]	✓	“none”	~ 128文字	完了通知の通知先
doneTriggerScriptId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024文字	スクリプトGRN
doneTriggerQueueNamespaceId	string	{doneTriggerTargetType} == “gs2_script”		~ 1024文字	ネームスペースGRN

GitHubCheckoutSetting

	型	必須	値の制限	説明
apiKeyId	string	✓	~ 1024文字	GitHub のAPIキーGRN
repositoryName	string	✓	~ 1024文字	リポジトリ名
sourcePath	string	✓	~ 1024文字	ソースコードのファイルパス
referenceType	enum [‘commit_hash’, ‘branch’, ’tag’]	✓	~ 128文字	コードの取得元
commitHash	string	{referenceType} == “commit_hash”	~ 1024文字	コミットハッシュ
branchName	string	{referenceType} == “branch”	~ 1024文字	ブランチ名
tagName	string	{referenceType} == “tag”	~ 1024文字	タグ名

LogSetting

	型	必須	デフォルト	値の制限	説明
loggingNamespaceId	string	✓		~ 1024文字	ネームスペースGRN

Version

	型	必須	値の制限	説明
major	int	✓	~ 2147483646	メジャーバージョン
minor	int	✓	~ 2147483646	マイナーバージョン
micro	int	✓	~ 2147483646	マイクロバージョン

ScheduleVersion

	型	必須	値の制限	説明
currentVersion	Version	✓		現在のバージョン
warningVersion	Version	✓		バージョンアップを促すバージョン
errorVersion	Version	✓		バージョンチェックを蹴るバージョン
scheduleEventId	string		~ 1024文字	バージョンチェックを有効化する期間を設定した GS2-Schedule のイベント