GS2-Key
GS2-Deploy のテンプレートで使用できるリソース定義のリファレンス
GS2-Deploy リファレンス
エンティティ
Namespace
Namespace
Type: GS2::Key::Namespace
Properties:
Name: namespace1
Description: null
LogSetting:
LoggingNamespaceId: grn:gs2:ap-northeast-1:YourOwnerId:log:namespace1
ネームスペース
ネームスペースは一つのプロジェクトで同じサービスを異なる用途で複数利用できるようにするための仕組みです。
GS2 のサービスは基本的にネームスペースというレイヤーがあり、ネームスペースが異なれば同じサービスでもまったく別のデータ空間として取り扱われます。
そのため、各サービスの利用を開始するにあたってネームスペースを作成する必要があります。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
name | string | ✓ | ~ 32文字 | ネームスペース名 | |
description | string | ~ 1024文字 | 説明文 | ||
logSetting | LogSetting | ログの出力設定 |
Key
Key
Type: GS2::Key::Key
Properties:
NamespaceName: namespace1
Name: key-0001
Description: null
暗号鍵
GS2 で暗号化処理が必要な場合にここで作成する暗号鍵のGRNを指定する必要があります。
具体的な暗号鍵の内容は GS2 の外に出ることはなく、安全に暗号化・復号処理を行えます。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
name | string | ✓ | ~ 128文字 | 暗号鍵名 | |
description | string | ~ 1024文字 | 説明文 |
GitHubApiKey
GitHubApiKey
Type: GS2::Key::GitHubApiKey
Properties:
NamespaceName: namespace1
Name: api-key-0001
Description: null
ApiKey: secret-0001
EncryptionKeyName: $key1.name
GitHub APIキー
GS2 ではマスターデータや GS2-Deploy のテンプレートファイルなどファイルをアップロードするインターフェースが複数あります。
このようなインターフェースに対して、データをアップロードするのではなく、GitHunの特定のリポジトリの特定のブランチやタグから設定を反映するインターフェースが用意されています。
このインターフェースを利用するにあたって必要となる GitHub の APIキー を格納します。
型 | 必須 | デフォルト | 値の制限 | 説明 | |
---|---|---|---|---|---|
namespaceName | string | ✓ | ~ 32文字 | ネームスペース名 | |
name | string | ✓ | ~ 128文字 | GitHub APIキー名 | |
description | string | ~ 1024文字 | 説明文 | ||
apiKey | string | ✓ | ~ 1024文字 | APIキー | |
encryptionKeyName | string | ✓ | ~ 128文字 | APIキーの暗号化に使用する暗号鍵名 |