GS2-Script Deploy/CDK 레퍼런스

GS2-Deploy의 스택을 생성할 때 사용하는 템플릿 포맷과, CDK를 이용한 각종 언어의 템플릿 출력 구현 예제

엔티티

Deploy 처리에서 조작 대상이 되는 리소스

Namespace

네임스페이스

네임스페이스는 하나의 프로젝트 내에서 동일한 서비스를 서로 다른 용도로 여러 개 이용하기 위한 엔티티입니다.
GS2의 각 서비스는 네임스페이스 단위로 관리됩니다. 네임스페이스가 다르면 동일한 서비스라도 완전히 독립된 데이터 공간으로 취급됩니다.

따라서 각 서비스의 이용을 시작하려면 먼저 네임스페이스를 생성해야 합니다.

Request

리소스 생성·갱신 요청

	타입	필수	값 제한	설명
name	string	✓	~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
description	string		~ 1024자	설명문
transactionSetting	TransactionSetting			트랜잭션 설정 스크립트가 트랜잭션 액션을 반환할 때 사용되는 분산 트랜잭션 설정입니다.
logSetting	LogSetting			로그 출력 설정 API 요청·응답 로그의 출력 대상이 되는 GS2-Log의 네임스페이스를 지정합니다. 스크립트 호출과 그 결과의 추적에 사용됩니다.

GetAttr

!GetAttr 태그로 취득 가능한 리소스 생성 결과

	타입	설명
Item	Namespace	생성한 네임스페이스

구현 예제

Type: GS2::Script::Namespace
Properties:
  Name: namespace-0001
  Description: null
  TransactionSetting: null
  LogSetting:
    LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/script"
)


SampleStack := core.NewStack()
script.NewNamespace(
    &SampleStack,
    "namespace-0001",
    script.NamespaceOptions{
        LogSetting: &core.LogSetting{
            LoggingNamespaceId: "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001",
        },
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Script\Model\Namespace_(
            stack: $this,
            name: "namespace-0001",
            options: new \Gs2Cdk\Script\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.script.model.Namespace(
                this,
                "namespace-0001",
                new io.gs2.cdk.script.model.options.NamespaceOptions()
                        .withLogSetting(new io.gs2.cdk.core.model.LogSetting(
                            "grn:gs2:ap-northeast-1:YourOwnerId:log:namespace-0001"
                        ))
        );
    }
}

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

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

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

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

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

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

from gs2_cdk import Stack, core, script

class SampleStack(Stack):

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

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

TransactionSetting

트랜잭션 설정

트랜잭션 설정은 트랜잭션의 실행 방법·정합성·비동기 처리·충돌 회피 메커니즘을 제어하는 설정입니다.
자동 실행(AutoRun), 원자적 실행(AtomicCommit), GS2-Distributor를 이용한 비동기 실행, 스크립트 결과의 일괄 적용, GS2-JobQueue를 통한 입수 액션의 비동기화 등을 조합하여 게임 로직에 맞는 견고한 트랜잭션 관리를 가능하게 합니다.

	타입	활성화 조건	기본값	값 제한	설명
enableAutoRun	bool		false		발행한 트랜잭션을 서버 사이드에서 자동으로 실행할지 여부
enableAtomicCommit	bool	{enableAutoRun} == true	false		트랜잭션의 실행을 원자적으로 커밋할지 여부 ※ enableAutoRun이(가) true 이면 활성화
transactionUseDistributor	bool	{enableAtomicCommit} == true	false		트랜잭션을 비동기 처리로 실행할지 여부 ※ enableAtomicCommit이(가) true 이면 활성화
commitScriptResultInUseDistributor	bool	{transactionUseDistributor} == true	false		스크립트의 결과 커밋 처리를 비동기 처리로 실행할지 여부 ※ transactionUseDistributor이(가) true 이면 활성화
acquireActionUseJobQueue	bool	{enableAtomicCommit} == true	false		입수 액션을 실행할 때 GS2-JobQueue를 사용할지 여부 ※ enableAtomicCommit이(가) true 이면 활성화
distributorNamespaceId	string		“grn:gs2:{region}:{ownerId}:distributor:default”	~ 1024자	트랜잭션 실행에 사용하는 GS2-Distributor 네임스페이스 GRN
queueNamespaceId	string		“grn:gs2:{region}:{ownerId}:queue:default”	~ 1024자	트랜잭션 실행에 사용하는 GS2-JobQueue의 네임스페이스 GRN

LogSetting

로그 출력 설정

로그 데이터의 출력 설정을 관리합니다. 이 타입은 로그 데이터를 출력하기 위해 사용되는 GS2-Log 네임스페이스의 식별자(Namespace ID)를 보관합니다.
로그 네임스페이스ID(loggingNamespaceId)에는 로그 데이터를 수집하여 저장하는 GS2-Log의 네임스페이스를 GRN 형식으로 지정합니다.
이 설정을 하면 설정된 네임스페이스 내에서 발생한 API 요청·응답 로그 데이터가 대상 GS2-Log 네임스페이스 쪽으로 출력됩니다.
GS2-Log에서는 실시간으로 로그가 제공되어 시스템 모니터링, 분석, 디버깅 등에 활용할 수 있습니다.

	타입	활성화 조건	필수	기본값	값 제한	설명
loggingNamespaceId	string		✓		~ 1024자	로그를 출력할 GS2-Log의 네임스페이스 GRN “grn:gs2:“로 시작하는 GRN 형식의 ID로 지정해야 합니다.

Script

스크립트

GS2에서는 표준 기능만으로 기능을 구현할 수 없을 때를 위해 스크립트로 기능을 확장할 수 있게 되어 있습니다.
스크립트는 Lua 언어로 작성할 수 있습니다.

스크립트 내에서 GS2 서비스의 데이터를 취득할 수도 있으므로, 유연한 처리를 작성할 수 있습니다.
자세한 내용은 문서를 참조해 주세요.

Request

리소스 생성·갱신 요청

	타입	필수	기본값	값 제한	설명
namespaceName	string	✓		~ 128자	네임스페이스 이름 네임스페이스 고유의 이름입니다. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
name	string	✓		~ 128자	스크립트 이름 스크립트 고유의 이름. 영숫자 및 -(하이픈) _(언더스코어) .(마침표)로 지정합니다.
description	string			~ 1024자	설명문
script	string	✓		~ 5242880자	Lua 스크립트 실행할 Lua 스크립트의 소스 코드입니다. 스크립트에서 GS2 서비스의 데이터에 액세스하여 호출한 서비스의 동작을 변경하는 결과를 반환할 수 있습니다.
disableStringNumberToNumber	bool		false		문자열-숫자 변환 비활성화 활성화하면 숫자로만 구성된 문자열(예: “12345”)이 자동으로 숫자로 변환되지 않고 문자열로 유지됩니다. 숫자처럼 보여도 문자열 타입으로 유지해야 하는 ID나 코드를 다룰 때 유용합니다.

GetAttr

!GetAttr 태그로 취득 가능한 리소스 생성 결과

	타입	설명
Item	Script	생성한 스크립트

구현 예제

Type: GS2::Script::Script
Properties:
  NamespaceName: namespace-0001
  Name: script-0001
  Description: null
  Script: result = {permit=true}
  DisableStringNumberToNumber: false

import (
    "github.com/gs2io/gs2-golang-cdk/core"
    "github.com/gs2io/gs2-golang-cdk/script"
)


SampleStack := core.NewStack()
script.NewScript(
    &SampleStack,
    "namespace-0001",
    "script-0001",
    "result = {permit=true}",
    script.ScriptOptions{
        DisableStringNumberToNumber: false,
    },
)

println(SampleStack.Yaml())  // Generate Template

class SampleStack extends \Gs2Cdk\Core\Model\Stack
{
    function __construct() {
        parent::__construct();
        new \Gs2Cdk\Script\Model\Script(
            stack: $this,
            namespaceName: "namespace-0001",
            name: "script-0001",
            script: "result = {permit=true}",
            options: new \Gs2Cdk\Script\Model\Options\ScriptOptions(
                disableStringNumberToNumber: false
            )
        );
    }
}

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

class SampleStack extends io.gs2.cdk.core.model.Stack
{
    public SampleStack() {
        super();
        new io.gs2.cdk.script.model.Script(
                this,
                "namespace-0001",
                "script-0001",
                "result = {permit=true}",
                new io.gs2.cdk.script.model.options.ScriptOptions()
                        .withDisableStringNumberToNumber(false)
        );
    }
}

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

public class SampleStack : Gs2Cdk.Core.Model.Stack
{
    public SampleStack() {
        new Gs2Cdk.Gs2Script.Model.Script(
            stack: this,
            namespaceName: "namespace-0001",
            name: "script-0001",
            script: "result = {permit=true}",
            options: new Gs2Cdk.Gs2Script.Model.Options.ScriptOptions
            {
                disableStringNumberToNumber = false
            }
        );
    }
}

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

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

class SampleStack extends core.Stack
{
    public constructor() {
        super();
        new script.model.Script(
            this,
            "namespace-0001",
            "script-0001",
            "result = {permit=true}",
            {
                disableStringNumberToNumber: false
            }
        );
    }
}

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

from gs2_cdk import Stack, core, script

class SampleStack(Stack):

    def __init__(self):
        super().__init__()
        script.Script(
            stack=self,
            namespace_name='namespace-0001',
            name='script-0001',
            script='result = {permit=true}',
            options=script.ScriptOptions(
                disable_string_number_to_number=False,
            ),
        )

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