cloudformation-tool 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76594dd22665ad87aa9cd9e2e6541b85d6a21b7a
+  data.tar.gz: 6089b920121308b4a738290e9c87f0c412676799
+SHA512:
+  metadata.gz: e205fb54c469ae9cff48099a609f8392954a554067b5d1f62b9eb3889c3d9032146fb9d00e554e860f6048d398b35362bd94190a84df105a12c2b219bcb14754
+  data.tar.gz: e63f990eb5d34f4a60678acd36b3ec1c774781119aa8f3481cbf362b43a0dea32ca17931937932728504fc79af9c01e4db553f7fbc32a3326b49177cd2477601

data/LICENSE

@@ -0,0 +1,339 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc., <http://fsf.org/>
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    {description}
+    Copyright (C) {year}  {fullname}
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  {signature of Ty Coon}, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -0,0 +1,204 @@
+# cloudformation-tool
+
+A pre-compiler for CloudFormation YAML files, allowing modularization of large CloudFormation
+templates. 
+
+By breaking a large template into distinct modules, including allowing parts to be
+loaded from git submodules or even to be downloaded on the fly, very large CloudFormation 
+configurations become manageable and useful.
+
+## Syntax
+
+This tool is based on the CloudFormation YAML syntax (as it is a bit more human friendly than
+the original JSON syntax) and extend it with a few more operation to allow for the 
+modularization of templates. The following additional syntaxes are supported:
+
+### Including Additional Sub-templates
+
+The CloudFormation pre-compiler introduces a new top-level element called `Include`.
+
+This element specifies a list of additional template files to be loaded and merged into
+the current template file. 
+
+Loading is done using the same file resolution rules as the
+`compile` CLI command:
+ - resolution is done relative to the directory of the current file
+ - if the path specified is missing the `.yaml` extension and a valid file with the extension
+   exist, it will be loaded instead.
+ - if the path specified is a directory, the file `cloud-formation.yaml` will be loaded 
+   from that directory
+
+The merged file must be a valid CloudFormation template - it should have at least a top-level
+`Resources` entry and can have any other top-level entry that a standard CloudFormation
+template can include (see below regarding the merging of parameters). The sub-template will
+be merged back to the top template without nesting - e.g. all resources specified in a
+sub-template are standard resources in the top-level `Resources` list.
+
+As logical resource names as well as parameters are merged into a single name space, these
+can be referenced directly from any file. Unless as specified for parameter merging below, the
+names used can be directly addressed as done in a normal CloudFormation template.
+
+#### Parameter merging
+
+A sub-template may specify parameters just like a standard CloudFormation template, and as
+long as each parameter is specified uniquely (i.e. only once) in the entire set of sub-templates
+that are being loaded, then they are just merged into a flat list and all parameters can be
+used equally from all sub-templates.
+
+If the same parameter name is mentioned in more than one file, then special merging rules take
+effect:
+ 1. If the same parameter is named in more than one file, and in all instances the default
+    value is exactly the same, than the merging is done normally - we basically ignore the
+    duplicate settings.
+ 1. If the same parameter is named in more than one file, and uses different default value,
+    then the new parameter is renamed using a path-specific template (i.e. based on the path
+    to the sub-template where the new copy was encountered) and any use of that parameter in
+    the current sub-template is also renamed automatically, as if there is full scoping of the
+    nested sub-template (though the mangled name is not very readable due to YAML restrictions
+    on the available characters for names). Uses of the duplicate parameter in sub-templates
+    other than the one where it was defined should use the mangled form if they mean the new
+    parameter or the original form if they mean the original parameter
+
+#### Example:
+
+```
+AWSTemplateFormatVersion: "2010-09-09"
+Description: "Example cloud formation template"
+Parameters:
+  DomainName:
+    Description: "The DNS domain name for the system"
+    Type: String
+    Default: example.com
+  AMI:
+    Description: "The AMI ID for the image to deploy"
+    Type: String
+    Default: ami-af4333cf
+
+Resources:
+  VPC:
+    Type: AWS::EC2::VPC
+    Properties:
+      CidrBlock: 172.20.0.0/16
+      EnableDnsSupport: true
+      EnableDnsHostnames: true
+  SecurityGroupExample:
+    Type: AWS::EC2::SecurityGroup
+    Properties:
+      VpcId: !Ref VPC 
+      GroupDescription: example security group
+      SecurityGroupIngress:
+        - { IpProtocol: icmp, CidrIp: 0.0.0.0/0, FromPort: -1, ToPort: -1 }
+        - { IpProtocol: tcp, CidrIp: 0.0.0.0/0, FromPort: 22, ToPort: 22 }
+
+Include:
+ - network
+ - servers/global
+ - outputs.yaml
+```
+
+#### Logical resource merging
+
+Logical resources are not mangled - if multiple resources with the same name are defined in 
+multiple sub-templates, this is an error that would cause the tool to abort.
+
+### Loading user data files
+
+When specifying a user-data block for a `LaunchConfiguration` resource or an `Instance`
+resource, the user-data can be loaded from an external YAML file (only YAML formatted user-data
+is currently supported, sorry) by specifying the `UserData` element as a map with the single
+field `File` that is set with the relative path to the user-data file. The user-data file is
+expected to be a cloud-init file with the extension `.init`. 
+
+The loaded file will be checked that it does not exceed the user-data size limitation. If the
+file is bigger than can fit in the AWS user-data block, it will first be compressed using gzip
+and if it is still too large, it will be uploaded to S3 and the user-data block will be set 
+with a cloud-init download reference to the S3 object.
+
+#### Example:
+
+```
+  LaunchConfigurationForServer:
+    Type: AWS::AutoScaling::LaunchConfiguration
+    Properties:
+      AssociatePublicIpAddress: true
+      IamInstanceProfile: !Ref InstanceProfileForServer
+      ImageId: !Ref AMI # read from parameters
+      InstanceType: !Ref InstanceType # read from parameters
+      KeyName: !Ref KeyName # read from parameters
+      SecurityGroups:
+        - Ref: SecurityGroupExample
+      UserData:
+        File: config.init 
+```
+
+### Loading Lambda code
+
+When specifying the `Code` property of a `AWS::Lambda::Function` resource, instead of
+specifying the S3 bucket and object key, the field `URL` may be used to specify an HTTP URL
+from which the code is to be uploaded to AWS Lambda. The tool will download the code file from
+the specified URL, upload it to S3 and specify the correct S3 location for CloudFormation.
+
+In the future we plan to add support for specifying `File` to upload from a local file.
+
+#### Example:
+
+```
+  LambdaExample:
+    Type: AWS::Lambda::Function
+    Properties:
+      FunctionName: !Join [ "-", [ route53-update, !Ref SystemTag ] ]
+      Runtime: java8
+      Code:
+         URL: https://github.com/GreenfieldTech/lambda-route53-updates/releases/download/0.2.5/lambda-route53-updates-0.2.5.jar
+      Description: Update DNS with autoscaling servers
+      MemorySize: 256
+      Timeout: 60
+      Handler: net.gftc.aws.route53.NotifyRecords
+      Environment:
+        Variables: # set variables here, see lambda-route53-updates for documentation ...
+      Role: !GetAtt [ LambdaExecutionRole, Arn ]
+```
+
+## Caching
+
+Some resource compilation may require uploading to S3, such as Lambda code or cloud-init setup
+files. In such cases, the tool will take precaution not to update the uploaded file (and thus
+cause a CloudFormation update) unless the content has changed. This is done by comparing the
+MD5 hash of the compiled object with the MD5 hash of the previously uploaded object, and
+re-uploading and updating CloudFormation only if a change in the actual content as been 
+detected.
+
+## Usage
+
+The CloudFormation Tool uses a "sub-command CLI syntax" (like GIT, for example).
+
+Usage: `cftool [options] <command> <command-options...>`
+
+The following commands are supported:
+
+ - `list` - List names and status of existing CloudFormation stacks
+ - `parameters` - List parameters defined in the specified CloudFormation template and
+   their default values.
+ - `compile` - Compile a CloudFormation template set (including all caching needed) and
+   output the resulting valid CloudFormation template to the console.
+ - `create` - Create or update a CloudFormation stack by compiling the specified template 
+   set and uploading it to CloudFormation. If no stack with the specified name exists, then
+   a new stack will be created, otherwise the existing stack will be updated. After sending the
+   template to CloudFormation, the tool will immediately start `monitor` mode until the
+   operation has completed successfully or with an error.
+ - `monitor` - Track and display ongoing events for the named stack.
+ - `status` - Check if the names stack exists or not
+ - `delete` - Delete the specified stack. After issuing the delete command, the tool will
+   immediately start `monitor` mode until the operation has completed. 
+ - `servers` - List EC2 instances created and managed by this stack.
+
+Please see the specific help for each command by running `cftool <command> --help` for
+more details and specific options.
+
+### Region Selection
+
+The AWS region to be used can be select by specifying top level option (i.e. before the command name) `-r <region>`, by providing the standard environment variable `AWS_DEFAULT_REGION` or it will default to `us-west-1`
+
+### Credentials Selection
+
+The tool will use the standard AWS credentials selection process, except when you want to use AWS CLI configured credential profiles, you may select to use a profile other than "default" by specifying the top level option (i.e. before the command name) `-p <profile>`, by providing the standard environment variable `AWS_DEFAULT_PROFILE` or by having a file called `.awsprofile` - whose content is the name of a valid AWS REGION - in a parent directory (at any level up to the root directory).