一个用于CloudFormation模板验证和转换的工具
一个用于CloudFormation模板验证和转换的工具
Go 其它杂项
共84Star
详细介绍
Perun 
A swiss army knife for AWS CloudFormation templates - validation, conversion, generators and other various stuff.
Goal
Perun was created to support work with CloudFormation templates. CloudFormation works in a way that it runs template online in AWS infrastructure and fails after first error - in many cases it is related with particular name length (e.g. maximum length is 64 characters). Instead of doing a round-trip, we would like to detect such cases locally.
Building and Installation
OSX
If you are using homebrew just run:
brew install Appliscale/tap/perun
Building from sources
First of all you need to download Perun to your GO workspace:
$GOPATH $ go get github.com/Appliscale/perun
$GOPATH $ cd perun
Then build and install configuration for the application inside perun directory by executing:
perun $ make config-install
perun $ make all
With first command a default configuration file (defaults/main.yaml) will be copied to your home directory under the ~/.config/perun/main.yaml path. After second command application will be compiled as a perun binary inside bin directory in your $GOPATH/perun workspace.
Working with Perun
Commands
To validate your template with AWS API (online validation), just type:
~ $ perun validate <PATH TO YOUR TEMPLATE>
To validate your template offline (well, almost offline
validate_offline mode:
~ $ perun validate_offline <PATH TO YOUR TEMPLATE>
To convert your template between JSON and YAML formats you have to type:
~ $ perun convert
<PATH TO YOUR INCOMING TEMPLATE>
<PATH FOR A CONVERTED FILE, INCLUDING FILE NAME>
<JSON or YAML>
To create your own configuration file use configure mode:
~ $ perun configure
Then type path and name of new configuration file.
To create new stack you have to type:
~ $ perun --mode=create-stack --template=<PATH TO YOUR TEMPLATE> --stack=<NAME OF YOUR STACK>
To destroy stack just type:
~ $ perun --mode=delete-stack --stack=<NAME OF YOUR STACK>
Configuration file
You can find an example configuration file in the main directory of the repository in file defaults/main.yml.
perun supports multiple configuration files for different locations. Configuration files take precedence, according to the typical UNIX convention. The application will be looking for the configuration file in the following order:
- CLI argument (
-c=<CONFIG FILE>, --config=<CONFIG FILE>). - Current working directory (
.perunfile). - Current user local configuration (
~/.config/perun/main.yaml). - System global configuration (
/etc/perun/main.yaml).
Having a configuration file is mandatory. Minimal configuration file requires only AWS CloudFormation Resource Specification URLs, listed under SpecificationURL key:
SpecificationURL:
us-east-2: "https://dnwj8swjjbsbt.cloudfront.net"
...
There are two optional parameters:
Profile(defaulttaken by default, when no value found inside configuration files).Region(us-east-1taken by default, when no value found inside configuration files).
Supporting MFA
If you account is using MFA (which we strongly recommend to enable) you should add --mfa flag to the each executed command.
~ $ perun validate <PATH TO YOUR TEMPLATE> --mfa
In that case application will use [profile]-long-term from the ~/.aws/credentials file ([profile] is a placeholder filled with adequate value taken from configuration files).
Example profile you need to setup - in this case default:
[default-long-term]
aws_access_key_id = <YOUR ACCESS KEY>
aws_secret_access_key = <YOUR SECRET ACCESS KEY>
mfa_serial = <IDENTIFICATION NUMBER FOR MFA DEVICE>
Working with stacks
Perun allows to create and destroy stacks.
To create stack it uses your template. It can be JSON or YAML format.
Example JSON template which describe S3 Bucket:
{
"Resources" : {
"HelloPerun" : {
"Type" : "AWS::S3::Bucket"
}
}
}
If you want to destroy stack just type its name. Before you create stack you should validate it with perun
