cfndk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab06c175fb5cdccfc94b9687d885d18b1876d6fd
+  data.tar.gz: a29b07a06036df653836de1b16f310e8d02c5c88
+SHA512:
+  metadata.gz: 5e73ca3a44aeaf1d912c0fe06bc7a3c9c7b072ff1c8d6cda247f6ebd83db38ed149fb0bc3f4df7fffad9f6528c8d0a984cb5dbcf50281c7add88607c19cd6326
+  data.tar.gz: 4d22614faac17bfb1fce63b406d8da6b87c64ac5d2e011b4434aa7881f28eb6cbdc89610ec1f026fabee2fc6267956f642001f420e59da576a42429a3314ff38

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AsciiComments:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 160
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/ClassLength:
+  Max: 102
+
+Style/MethodLength:
+  Max: 30
+
+Style/Documentation:
+  Enabled: false
+
+AllCops:
+  Exclude:
+    - 'cookbooks/**'
+    - '.chef/**'
+    - '.bundle/**'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xpub.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2019 Yoshihisa AMAKATA all rights reserved.
+
+licensed under the apache license, version 2.0 (the "license");
+you may not use this file except in compliance with the license.
+you may obtain a copy of the license at
+
+    http://www.apache.org/licenses/license-2.0
+
+unless required by applicable law or agreed to in writing, software
+distributed under the license is distributed on an "as is" basis,
+without warranties or conditions of any kind, either express or implied.
+see the license for the specific language governing permissions and
+limitations under the license.

data/README-ja.md

@@ -0,0 +1,282 @@
+# AWS CloudFormation Development Kit
+
+このツールは、AWS CloudFromationのための簡単な運用/構築サポートツールです。
+
+## インストール
+
+```
+$ gem install cfndk
+```
+
+## Credentials設定
+
+次の順番でCredentialsを評価して最初に有効なCredentialsを使用します。
+
+1. access key、secret access key、session token環境変数よるCredentials
+   * ACCESS_KEYで利用される環境変数名: AWS_ACCESS_KEY_ID AMAZON_ACCESS_KEY_ID AWS_ACCESS_KEY
+   * SECRET_ACCESS_KEYで利用される環境変数名: AWS_SECRET_ACCESS_KEY AMAZON_SECRET_ACCESS_KEY AWS_SECRET_KEY
+   * SESSION_TOKEで利用される環境変数名: AWS_SESSION_TOKEN AMAZON_SESSION_TOKEN
+2. AWS_PROFILE環境変数によるProfileのaccess key、secret access key、session tokenによるCredentials
+   * 環境変数が指定されない場合は、defaultが利用されます。
+3. AWS_PROFILE環境変数によるProfileのcredential_processによるCredentials
+   * 環境変数が指定されない場合は、defaultが利用されます。
+4. EC2/ECS Instance ProfileによるCredentials
+   * AWS_CONTAINER_CREDENTIALS_RELATIVE_URI環境変数が設定された場合のみECSが使われます。
+
+## コマンド
+
+```
+cfndk [cmd] [options]
+```
+
+### [cmd]
+
+#### 初期化
+
+カレントディレクトリにcfndk.yamlのひな形を作成します。
+
+```
+cfndk init [option]
+```
+
+#### スタックの作成
+
+cfndk.yamlで定義されているスタックを作成します。
+
+```
+cfndk create [option]
+```
+
+#### スタック更新
+
+cfndk.yamlで定義されているスタックを更新します。
+
+```
+cfndk update [option]
+```
+
+#### スタックの作成、changeset作成
+
+cfndk.yamlで定義されているスタックが存在しない場合は作成を、存在する場合はチェンジセットを作成します。
+チェンジセットの実行は行いません。
+コマンドを実行後に手動で実行する必要があります。
+
+```
+cfndk ｃreate-or-changeset [option]
+```
+
+#### スタックの破壊
+
+cfndk.yamlで定義されているスタックを削除します。
+
+```
+cfndk destroy [option]
+```
+
+#### UUIDの生成
+
+UUIDを生成して標準出力に出力します。
+
+```
+cfndk generate-uuid
+```
+
+例えば次のような使い方をします。
+
+```
+export CFNDK_UUID=`cfndk generate-uuid`
+cfndk create
+cfndk destroy
+```
+
+#### スタックのイベントのレポート
+
+cfndk.yamlで定義されているスタックのイベント情報をレポートします。
+
+```
+cfndk report-event [option]
+```
+
+#### スタックのスタックのレポート
+
+cfndk.yamlで定義されているスタックの情報をレポートします。
+
+```
+cfndk report-stack [option]
+```
+
+#### スタックのスタックリソースのレポート
+
+cfndk.yamlで定義されているスタックのリソース情報をレポートします。
+
+```
+cfndk report-stack-resource [option]
+```
+
+### [option]
+
+#### -v --verbose
+
+実行時に詳細な情報を表示します。
+
+#### -c, --config_path <cfndi.yml>
+
+カレントディレクトリのcfndi.ymlの代わりに、ファイルを指定します。
+
+#### -p, --properties <name>=<value>
+
+プロパティを追加します。
+cfndi.ymlのparametersの値で参照することができます。
+
+#### -a, --auto-uuid
+
+UUIDを自動生成し使用します。
+UUIDが指定されるとスタック名に付加されます。
+またcfndi.ymlのparametersの値で参照することができます。
+```-a```と```-u```は最後に指定されたものが有効になります。
+
+####  -u, --uuid <uuid>
+
+指定されたUUIDを使用します。
+UUIDが指定されるとスタック名に付加されます。
+またcfndi.ymlのparametersの値で参照することができます。
+```-a```と```-u```は最後に指定されたものが有効になります。
+
+
+## 環境変数
+
+### CFNDK_UUID
+
+この環境変数が指定されている場合、```--uuid $CFNDK_UUID```が指定されたものとして動作します。
+```-a```や```-u```のほうが優先されます。
+
+
+## cfndk.yaml
+
+* example
+
+```
+stacks:
+  Stack2:
+    template_file: stack2/stack2.yaml 
+    parameter_input: stacn2/env.json
+    parameters:
+      VpcName: Prod<%= append_uuid %>
+    capabilities:
+      - CAPABILITY_IAM
+      - CAPABILITY_NAMED_IAM
+    depends:
+      - Stack1      
+    timeout_in_minutes: 10
+```
+
+```
+stacks:
+  [String]:
+    template_file: [String]
+    parameter_input: [String]
+    parameters:
+      [String]: [String]
+      [String]: [String]   
+    capabilities:
+      - [String]
+      - [String]
+    timeout_in_minutes: [Integer]
+    depends:
+      - [String]
+      - [String]      
+```
+
+### ```stacks:```
+
+```
+stacks:
+  [Stack Original Name]:
+```
+
+cfndkで管理するスタックを定義します。
+stacksの配下には、管理するスタックのオリジナル名を定義します。
+通常は、stackを作成するとこの名称が利用されます。
+UUIDを利用すると、```[Stack Original Name]-[UUID]```のような形式のスタック名が利用されます。
+
+#### template_file 
+
+必須。CloudFormationテンプレートファイルのパスをcfndk.yamlからの相対パスで指定します。
+
+#### parameter_input
+
+必須。CloudFormationのパラメータJSONをcfndk.yamlからの相対パスで指定します。
+
+#### parameters
+
+parameter_inputのJSONの値を上書きした場合に指定します。
+複数指定することができます。
+
+```
+    parameters:
+      [Parameter Key1]: [Parameter Value1]
+      [Parameter Key2]: [Parameter Value2]
+```
+
+Parameter Valueではerbの記法が利用できます。
+
+```
+    parameters:
+      VpcName: Prod<%= append_uuid %>
+```
+
+##### parametrsのerbで使用できるメソッド
+
+  * ```append_uuid(glue='-')```
+
+    UUIDガ指定されている場合、```[glueの文字列] + [UUID]```を返します。
+    UUIDが指定されてい無い場合は空文字が返ります。
+    glueで接続文字を置き換えることができます。
+
+  * ```uuid```
+
+    UUIDを返します。
+    UUIDが指定されてい無い場合は空文字が返ります。
+
+  * ```properties(key)```
+
+    オプション```--properties```で指定したキーに対応する値を参照することができます。
+
+#### capabilities
+
+スタックを操作するcapabilitiesを指定します。
+複数指定することができます。
+
+```
+    capabilities:
+      - CAPABILITY_IAM
+      - CAPABILITY_NAMED_IAM
+```
+
+以下の値を指定することができます。
+
+* CAPABILITY_IAM
+* CAPABILITY_NAMED_IAM
+* CAPABILITY_AUTO_EXPAND
+
+
+#### depends
+
+スタックに依存している別のスタックを指定します。
+複数指定することができます。
+dependsを指定すると、create,update,create-or-changeset,destoryのコマンドを実行する際に、依存関係に従ってスタックを処理します。
+dependsが循環するような指定をすることはできません。
+
+```
+    depends:
+      - Stack1
+      - Stack2  
+```
+
+#### timeout_in_minutes (デフォルト: 1)
+
+スタックを作成する際などのタイムアウト時間を分で指定します。
+
+```
+    timeout_in_minutes: 5
+```

data/README.md

@@ -0,0 +1,288 @@
+# AWS CloudFormation Development Kit
+
+This is easy operation/integration support tool for AWS CloudFormation.
+このツールは、AWS CloudFromationのための簡単な運用/構築サポートツールです。
+
+## インストール
+
+```
+$ gem install cfndk
+```
+
+## Credentials設定
+
+次の順番でCredentialsを評価して最初に有効なCredentialsを使用します。
+
+1. access key、secret access key、session token環境変数よるCredentials
+   * ACCESS_KEYで利用される環境変数名: AWS_ACCESS_KEY_ID AMAZON_ACCESS_KEY_ID AWS_ACCESS_KEY
+   * SECRET_ACCESS_KEYで利用される環境変数名: AWS_SECRET_ACCESS_KEY AMAZON_SECRET_ACCESS_KEY AWS_SECRET_KEY
+   * SESSION_TOKEで利用される環境変数名: AWS_SESSION_TOKEN AMAZON_SESSION_TOKEN
+2. AWS_PROFILE環境変数によるProfileのaccess key、secret access key、session tokenによるCredentials
+   * 環境変数が指定されない場合は、defaultが利用されます。
+3. AWS_PROFILE環境変数によるProfileのcredential_processによるCredentials
+   * 環境変数が指定されない場合は、defaultが利用されます。
+4. EC2/ECS Instance ProfileによるCredentials
+   * AWS_CONTAINER_CREDENTIALS_RELATIVE_URI環境変数が設定された場合のみECSが使われます。
+
+## コマンド
+
+```
+cfndk [cmd] [options]
+```
+
+### [cmd]
+
+#### 初期化
+
+カレントディレクトリにcfndk.yamlのひな形を作成します。
+
+```
+cfndk init [option]
+```
+
+#### スタックの作成
+
+cfndk.yamlで定義されているスタックを作成します。
+
+```
+cfndk create [option]
+```
+
+#### スタック更新
+
+cfndk.yamlで定義されているスタックを更新します。
+
+```
+cfndk update [option]
+```
+
+#### スタックの作成、changeset作成
+
+cfndk.yamlで定義されているスタックが存在しない場合は作成を、存在する場合はチェンジセットを作成します。
+チェンジセットの実行は行いません。
+コマンドを実行後に手動で実行する必要があります。
+
+```
+cfndk ｃreate-or-changeset [option]
+```
+
+#### スタックの破壊
+
+cfndk.yamlで定義されているスタックを削除します。
+
+```
+cfndk destroy [option]
+```
+
+#### UUIDの生成
+
+UUIDを生成して標準出力に出力します。
+
+```
+cfndk generate-uuid
+```
+
+例えば次のような使い方をします。
+
+```
+export CFNDK_UUID=`cfndk generate-uuid`
+cfndk create
+cfndk destroy
+```
+
+#### スタックのイベントのレポート
+
+cfndk.yamlで定義されているスタックのイベント情報をレポートします。
+
+```
+cfndk report-event [option]
+```
+
+#### スタックのスタックのレポート
+
+cfndk.yamlで定義されているスタックの情報をレポートします。
+
+```
+cfndk report-stack [option]
+```
+
+#### スタックのスタックリソースのレポート
+
+cfndk.yamlで定義されているスタックのリソース情報をレポートします。
+
+```
+cfndk report-stack-resource [option]
+```
+
+### [option]
+
+#### -v --verbose
+
+実行時に詳細な情報を表示します。
+
+#### -c, --config_path <cfndi.yml>
+
+カレントディレクトリのcfndi.ymlの代わりに、ファイルを指定します。
+
+#### -p, --properties <name>=<value>
+
+プロパティを追加します。
+cfndi.ymlのparametersの値で参照することができます。
+
+#### -a, --auto-uuid
+
+UUIDを自動生成し使用します。
+UUIDが指定されるとスタック名に付加されます。
+またcfndi.ymlのparametersの値で参照することができます。
+```-a```と```-u```は最後に指定されたものが有効になります。
+
+####  -u, --uuid <uuid>
+
+指定されたUUIDを使用します。
+UUIDが指定されるとスタック名に付加されます。
+またcfndi.ymlのparametersの値で参照することができます。
+```-a```と```-u```は最後に指定されたものが有効になります。
+
+
+## 環境変数
+
+### CFNDK_UUID
+
+この環境変数が指定されている場合、```--uuid $CFNDK_UUID```が指定されたものとして動作します。
+```-a```や```-u```のほうが優先されます。
+
+
+## cfndk.yaml
+
+* example
+
+```
+stacks:
+  Stack2:
+    template_file: stack2/stack2.yaml 
+    parameter_input: stacn2/env.json
+    parameters:
+      VpcName: Prod<%= append_uuid %>
+    capabilities:
+      - CAPABILITY_IAM
+      - CAPABILITY_NAMED_IAM
+    depends:
+      - Stack1      
+    timeout_in_minutes: 10
+```
+
+```
+stacks:
+  [String]:
+    template_file: [String]
+    parameter_input: [String]
+    parameters:
+      [String]: [String]
+      [String]: [String]   
+    capabilities:
+      - [String]
+      - [String]
+    timeout_in_minutes: [Integer]
+    depends:
+      - [String]
+      - [String]      
+```
+
+### ```stacks:```
+
+```
+stacks:
+  [Stack Original Name]:
+```
+
+cfndkで管理するスタックを定義します。
+stacksの配下には、管理するスタックのオリジナル名を定義します。
+通常は、stackを作成するとこの名称が利用されます。
+UUIDを利用すると、```[Stack Original Name]-[UUID]```のような形式のスタック名が利用されます。
+
+#### template_file 
+
+必須。CloudFormationテンプレートファイルのパスをcfndk.yamlからの相対パスで指定します。
+
+#### parameter_input
+
+必須。CloudFormationのパラメータJSONをcfndk.yamlからの相対パスで指定します。
+
+#### parameters
+
+parameter_inputのJSONの値を上書きした場合に指定します。
+複数指定することができます。
+
+```
+    parameters:
+      [Parameter Key1]: [Parameter Value1]
+      [Parameter Key2]: [Parameter Value2]
+```
+
+Parameter Valueではerbの記法が利用できます。
+
+```
+    parameters:
+      VpcName: Prod<%= append_uuid %>
+```
+
+##### parametrsのerbで使用できるメソッド
+
+  * ```append_uuid(glue='-')```
+
+    UUIDガ指定されている場合、```[glueの文字列] + [UUID]```を返します。
+    UUIDが指定されてい無い場合は空文字が返ります。
+    glueで接続文字を置き換えることができます。
+
+  * ```uuid```
+
+    UUIDを返します。
+    UUIDが指定されてい無い場合は空文字が返ります。
+
+  * ```properties(key)```
+
+    オプション```--properties```で指定したキーに対応する値を参照することができます。
+
+#### capabilities
+
+スタックを操作するcapabilitiesを指定します。
+複数指定することができます。
+
+```
+    capabilities:
+      - CAPABILITY_IAM
+      - CAPABILITY_NAMED_IAM
+```
+
+以下の値を指定することができます。
+
+* CAPABILITY_IAM
+* CAPABILITY_NAMED_IAM
+* CAPABILITY_AUTO_EXPAND
+
+
+#### depends
+
+スタックに依存している別のスタックを指定します。
+複数指定することができます。
+dependsを指定すると、create,update,create-or-changeset,destoryのコマンドを実行する際に、依存関係に従ってスタックを処理します。
+dependsが循環するような指定をすることはできません。
+
+```
+    depends:
+      - Stack1
+      - Stack2  
+```
+
+#### timeout_in_minutes (デフォルト: 1)
+
+スタックを作成する際などのタイムアウト時間を分で指定します。
+
+```
+    timeout_in_minutes: 5
+```
+
+
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'