geoengineer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7ba4efcd817f80f7f9f1cd14b0605e3b71cfc9c
+  data.tar.gz: 596d587ef7bbede66b50e5b72570bed3305e43a2
+SHA512:
+  metadata.gz: c7bf1e7081f46e7b6d2468a37c5fcca8fb29a783f3802d2d5f74e19dafb9120f64abcc5f61ecb5f9af8df67cdfa39aa9dd60b6aab96bf158c95393067641a812
+  data.tar.gz: 2566e1bf5352d9aa9b54d0d69bf86afec722685d1856a04566ee14ba77ef7cc73394260e5742672f218338796b23038deb20bf99cf817ba9da9fefcb3b208be7

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2016 Coinbase, Inc.
+
+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.md

@@ -0,0 +1,476 @@
+# GeoEngineer
+
+<a href="https://commons.wikimedia.org/wiki/File:Mantle_of_Responsibility.png"><img src="./assets/mantle.png" align="right" alt="Mantle_of_Responsibility" /></a>
+
+*[🚀 Coinbase is looking for DevOps and Software Engineers](http://grnh.se/gri162)*
+
+GeoEngineer provides a Ruby DSL and command line tool (`geo`) to *codeify*  then plan and execute changes to cloud resources.
+
+GeoEngineer's goals/requirements/features are:
+
+0. **DSL based on Terraform**: GeoEngineer uses [Terraform](https://github.com/hashicorp/terraform) to plan and execute changes, so the DSL to describe resources is similar to Terraform's. GeoEngineer's DSL also provides programming and object oriented features like inheritance, abstraction, branching and looping.
+1. **Development Workflow**: GeoEngineer is built to be used within existing development workflows, e.g. branching, creating pull requests, code reviewing and merging. To simplify these workflows, GeoEngineer dynamically generates Terraform state files using cloud APIs and opinionated tagging.
+2. **Extensible Validation**: Every team has their own standards when managing cloud resources e.g. naming patterns, tagging requirements, security rules. GeoEngineer resources can have custom validations added to ensure the resources conform to required standards.
+3. **Reusable Templates**: copy and pasting codified resources makes it difficult to understand and maintain infrastructure. By abstracting recommended patterns of reuse into **templates**, GeoEngineer aims to increase code reuse and decrease code copy/paste.
+4. **Describe Existing Resources**: Existing resources can be described with GeoEngineer without having to destroy and recreate them.
+5. **Principle of Least Astonishment**: show the exact plan before execution; do nothing without confirmation; do not allow a plan to be executed with failing validations; by default do not allow deletions; show warnings and hints to make code better.
+6. **One File per Project**: Managing dozens of projects with hundreds of files is difficult and error-prone, especially if a single project's resources are described across many files. Projects are easier to manage when they are each described in one file.
+7. **Dependencies**: resources have dependencies on other resources, projects have dependencies on other projects. Using Ruby's `require` file that describe resources can be included and referenced without having to hard-code any values.
+
+## Getting Started
+
+### Install Terraform
+
+Instructions to install Terraform can be found [here](https://www.terraform.io/downloads.html).
+
+### Install Ruby
+
+Instruction to install Ruby can be found [here](https://www.ruby-lang.org/en/documentation/installation/).
+
+### Install GeoEngineer
+
+```
+gem build geoengineer.gempsec
+gem install geoengineer
+```
+
+Test it is installed correctly with:
+
+```
+geo --help
+```
+
+### First GeoEngineer Project
+
+GeoEngineer can use the folder structure where projects and environments are in the `projects` and `environments` directories respectively, however everything can also be defined in a single file, e.g. `first_project.rb`:
+
+```ruby
+# First define the environment which is available with the variable `env`
+# This is where project invariants are stored, e.g. subnets, vpc ...
+environment("staging") {
+  account_id  "1"
+  subnet      "1"
+  vpc_id      "1"
+}
+
+# Create the first_project to be in the `staging` environment
+project = project('org', 'first_project') {
+  environments 'staging'
+}
+
+# Define the security group for the ELB to allow HTTP
+elb_sg = project.resource("aws_security_group", "allow_http") {
+  name         "allow_http"
+  description  "Allow All HTTP"
+  vpc_id       env.vpc_id
+  ingress {
+      from_port    80
+      to_port      80
+      protocol     "tcp"
+      cidr_blocks  ["0.0.0.0/0"]
+  }
+  tags {
+    Name "allow_http"
+  }
+}
+
+# Define the security group for EC2 to allow ingress from the ELB
+ec2_sg = project.resource("aws_security_group", "allow_elb") {
+  name         "allow_elb"
+  description  "Allow ELB to 80"
+  vpc_id       env.vpc_id
+  ingress {
+      from_port    8000
+      to_port      8000
+      protocol     "tcp"
+      security_groups  [elb_sg]
+  }
+  tags {
+    Name "allow_elb"
+  }
+}
+
+# cloud_config to run webserver
+user_data = %{
+#cloud-config
+runcmd:
+  - docker run -d --name nginx -p 8000:80 nginx
+}
+
+# Create an EC2 instance to run nginx server
+instance = project.resource("aws_instance", "web") {
+  ami           "ami-1c94e10b" # COREOS AMI
+  instance_type "t1.micro"
+  subnet_id     env.subnet
+  user_data     user_data
+  tags {
+    Name "ec2_instance"
+  }
+}
+
+# Create the ELB connected to the instance
+project.resource("aws_elb", "main-web-app") {
+  name             "main-app-elb"
+  security_groups  [elb_sg]
+  subnets          [env.subnet]
+  instances        [instance]
+  listener {
+    instance_port     8000
+    instance_protocol "http"
+    lb_port           80
+    lb_protocol       "http"
+  }
+}
+```
+
+GeoEngineer command line tool `geo` can:
+
+1. **Create a plan** with `geo plan -e staging first_project.rb`
+2. **Execute the plan** with `geo apply -e staging first_project.rb`
+3. **Create a graph** with `geo graph -e staging --quiet first_project.rb | dot -Tpng > graph.png && open graph.png`
+4. **Status of Codeified Resources** with `geo status first_project.rb -e staging`
+
+*There are more examples in the `examples` folder.*
+
+## Customizations
+
+A core benefit of GeoEngineer is the ability to customize the DSL to your needs using custom validations, templates and reusable methods on resources.
+
+### Validations
+
+Below is an example which will add the validation to ensure that all listeners on all ELB's must be HTTPS, for security reasons.
+
+```ruby
+class GeoEngineer::Resources::AwsElb < GeoEngineer::Resource
+  validate :validate_listeners_must_be_https
+
+  def validate_listeners_must_be_https
+    errors = []
+    all_listener.select{ |i| i.lb_protocol != 'https' }.each do
+      errors << "ELB must use https protocol #{for_resource}"
+    end
+    return errors
+  end
+end
+```
+
+### Templates
+
+Below is an example template that builds a Elastic Load Balancer and a security group for an array of listeners:
+
+```ruby
+class LoadBalancedInstance < Template
+  attr_reader :elb, :elb_sg
+
+  def initialize(name, project, parameters)
+    super(name, project, parameters)
+    # { listeners: [{ in: out: }]}
+    listeners = parameters[:listeners] || []
+
+    # Create the Security Groups
+    elb_sg = resource("aws_security_group", "#{name}_allow_http") {
+      name         "#{name}_elb_sg"
+      description  ""
+      vpc_id       env.vpc_id
+      for l in listeners
+        ingress {
+          from_port    l[:in]
+          to_port      l[:in]
+          protocol     "tcp"
+          cidr_blocks  ["0.0.0.0/0"]
+        }
+      end
+      tags { Name "#{name}_elb_sg" }
+    }
+
+    # ELB
+    elb = resource("aws_elb", "main-web-app") {
+      name             "#{name}_elb"
+      security_groups  [elb_sg]
+      subnets          [env.subnet]
+      for l in listeners
+        listener {
+          instance_port     l[:out]
+          instance_protocol "http"
+          lb_port           l[:in]
+          lb_protocol       "http"
+        }
+      end
+    }
+
+    @elb    = elb
+    @elb_sg = elb_sg
+  end
+
+  def template_resources
+    [@elb, @elb_sg]
+  end
+end
+
+# Instantiate the template for this project to forward two ports 80 and 8080
+project.from_template("load_balanced_instance", "main_app", {
+  listeners: [{in: 80, out: 3000 }, {in: 8080, out: 4000 }]
+})
+```
+
+### Methods
+
+Define methods to be used in your own resources, e.g. a custom method to security group to add a rule:
+
+```ruby
+class GeoEngineer::Resources::AwsSecurityGroup < GeoEngineer::Resource
+  # ...
+  def all_egress_everywhere
+    egress {
+        from_port        0
+        to_port          0
+        protocol         "-1"
+        cidr_blocks      ["0.0.0.0/0"]
+    }
+  end
+  # ...
+end
+
+project.resource('aws_security_group', 'all_egress') {
+  all_egress_everywhere # use the method to add egress
+}
+```
+
+## Adding New Resources
+
+The best way to contribute is to add resources that exist in Terraform but are not yet described in GeoEngineer.
+
+To define a resource:
+
+0. checkout and fork/branch GeoEngineer
+1. create a file `./lib/geoengineer/resources/<resource_type>.rb`
+2. define a class `class GeoEngineer::Resources::<ResourceType> < GeoEngineer::Resource`
+3. define `_terraform_id`, and potentially `_geo_id` and `self._fetch_remote_resources` method (more below).
+4. write a test file for the resource that follows the style of other similar resources
+
+### Codeified to Remote Resources
+
+A fundamental problem with codifying resources is matching the in code resource to the real remote resource. Terraform does this by maintaining an `id` in a state file which is matched to a remote resources attribute. This attribute is different per resource, e.g. for ELB's it is their `name`, for security groups it is their `group_name` that is generated so cannot be codified.
+
+Without a state file GeoEngineer uses API's to match resources, this makes generated `id`'s likes security groups difficult. For these generated ids GeoEngineer uses tags e.g. for ELB's the GeoEngineer id is its `name` (just like Terraform) and for security groups it is their `Name` tag.
+
+In a GeoEngineer resource the `_terraform_id` is the id used by Terraform and the `_geo_id` is GeoEngineer ID. By default a resources `_geo_id` is the same as the `_terraform_id`, so for most resources only the `_terraform_id` is required.
+
+If `_terraform_id` is generated then the remote resource needed to be fetched via API and matched to the codified resource with `_geo_id`. This is done by implementing the `self._fetch_remote_resources` method to use the API and return a list of resources with both `_terraform_id` and `_geo_id`, then GeoEngineer can match them.
+
+For example, in `aws_security_group`'s the resource is matched based on the `Name` tag, implements as:
+
+```ruby
+class GeoEngineer::Resources::AwsSecurityGroup < GeoEngineer::Resource
+  after :initialize, -> { _terraform_id -> { NullObject.maybe(remote_resource)._terraform_id } }
+  after :initialize, -> { _geo_id -> { NullObject.maybe(tags)[:Name] } }
+
+  def self._fetch_remote_resources
+    AwsClients.ec2.describe_security_groups['security_groups'].map(&:to_h).map do |sg|
+      sg[:name] = sg[:group_name]
+      sg[:_terraform_id] = sg[:group_id]
+      sg[:_geo_id] = sg[:tags] ? sg[:tags].select { |x| x[:key] == "Name" }.first[:value] : nil
+      sg
+    end
+  end
+end
+```
+
+### Validations
+
+Terraform does not validate a lot of attributes before they are sent to the cloud. This means that often plans will fail for reasons that could have been initially validated. When creating a resource think about what validations could be done to ensure a plan is successful.
+
+For example, a security groups needs a `Name` tag, requires a `name` and `description`, and a more complicated example is that its `cidr_blocks` should be valid:
+
+```ruby
+class GeoEngineer::Resources::AwsSecurityGroup < GeoEngineer::Resource
+  # ...
+  validate :validate_correct_cidr_blocks
+  validate -> { validate_required_attributes([:name, :description]) }
+  validate -> { validate_has_tag(:Name) }
+
+  def validate_correct_cidr_blocks
+    errors = []
+    (self.all_ingress + self.all_egress).each do |in_eg|
+      next unless in_eg.cidr_blocks
+      in_eg.cidr_blocks.each do |cidr|
+        begin
+          NetAddr::CIDR.create(cidr)
+        rescue NetAddr::ValidationError
+          errors << "Bad cidr block \"#{cidr}\" #{for_resource}"
+        end
+      end
+    end
+    errors
+  end
+  # ...
+end
+```
+
+### Terraform State
+
+Terraform by default will attempt to sync its resources with the API so that its state file is up to date with the real world. Given that GeoEngineer uses Terraform in a different way this sometimes causes plans to list changes that have already happened.
+
+To fix this issue a resource can override `to_terraform_state` method, e.g. `aws_db_instance` has issues with `final_snapshot_identifier` updating:
+
+
+```ruby
+class GeoEngineer::Resources::AwsDbInstance < GeoEngineer::Resource
+  # ...
+  def to_terraform_state
+    tfstate = super
+    tfstate[:primary][:attributes] = {
+      'final_snapshot_identifier' => final_snapshot_identifier,
+    }
+    tfstate
+  end
+  # ...
+end
+```
+
+## GeoEngineer Reference
+
+The core models in GeoEngineer are:
+
+```
+ +-------------+ 1
+ | Environment +-----------+
+ +-------------+           |
+       | 1                 |
+       |                   |
+       v *                 v *
+ +-----+-------+ 1  * +-------------+ 1  *  +-------------+
+ | Project     +----->+ Resource    +------>+ SubResource |
+ +-------------+      +-------------+       +-------------+
+       | 1                 ^ *
+       |                   |
+       v *                 |
+ +-------------+           |
+ | Template    +-----------+
+ +-------------+ 1
+```
+
+
+1. `Environment` contains many resources that may exist outside of a project, like VPCs or routing tables. Also every project defined to be in the environment, for example the `test_www` project is in `staging` but `monorail` is in `staging` and `production` environments.
+2. `Project` contains many resources and services grouped together into a name.
+3. `Template` has a `type` and `name`, and a group of resources that are defined in a pattern, e.g. every Load Balancer requires a unique security group that allows traffic in. It is an simple abstraction that can dramatically simplify and standardize cloud resources.
+4. `Resource` and `SubResource` are based off of how terraform models cloud resources. A `Resource` instance can have many `SubResource` instances, but a `SubResource` instance belongs to only one `Resource` instance, e.g. a load balancer resource may have a `health_check` sub-resource to only allow specific incoming ports.
+
+All these models can have arbitrary attributes assigned to them either by directly assigning on the instance, or through passing a block to the constructor. For example:
+
+```ruby
+resource = Resource.new('type','id') { |res|
+  # CORRECT
+  res.hello = 'hey'
+  puts res.hello # 'hey'
+  hello 'hey again' #
+  puts res.hello # 'hey again'
+
+  # INCORRECT way of assigning variables
+  goodbye = 'nooo' # This assigns a local variable, not an attribute on the resource
+  puts res.goodbye # nil
+}
+
+puts resource.hello # 'hey again'
+
+resource.goodbye = 'see ya'
+puts resource.goodbye # 'see ya'
+```
+
+Additionally, if the value is expensive to calculate or requires other attributes not yet assigned, an attribute can be assigned a `Proc` or `lambda` which will be calculated lazily:
+
+```ruby
+resource = Resource.new('type','id')
+resource.lazy_attr = -> { puts "CALCULATING THE VALUE"; 'value' }
+# ...
+puts resource.lazy_attr
+#$ "CALCULATING THE VALUE"
+#$ "value"
+```
+
+### Environment
+
+The top level class in GeoEngineer is the `environment`, it contains all projects, resources and services, there should only ever be one initialized at a time.
+
+An environment can mean many things to different people, e.g. an AWS account, an AWS region, or a specific AWS VPC. The only real constraint is that a resource has one instance per environment, e.g. a load balancer that is defined to be in `staging` and `production` environments, will have an instance in each.
+
+The function `environment` is provided as a factory to build an environment:
+
+```ruby
+environment = environment("environment_name") { |e|
+  e.attr_1 = [1,2,3]
+  attr_2 'value'
+}
+environment.attr_3 = "another value"
+```
+
+### Project
+
+A project is a group of resources typically provisioned to deploy one code base. A project has an `organization` and `name`, to mimic the github `username`/`organiztion` and `repository` structure.
+
+A project is defined like:
+
+```ruby
+project = project('org', 'project_name') {
+  environments 'staging', 'production'
+}
+```
+
+This projects organization is `org`, its name `project_name` and will be provisioned in the `staging` and `production` environments. The `org` and `name` must be unique across all other projects.
+
+The method `project` will automatically add the project to the instantiated environment object **only if** that environments name is in the list of environments, otherwise it is ignored.
+
+### Templates
+
+A template is used to create a group of resources in a recommended pattern. For example, an HTTP service could create a load balancer, a load balancer security group, and a ec2 security group.
+
+```ruby
+template_instance = project.from_template('template_type', 'name', { parameter: 'helloworld') { |resource, resource_sg|
+
+  # set attribute
+  attribute "custom attribute"
+
+  # Customize the values
+  resource.cutomize_value = "Customize"
+  resource.override_value = "Override"
+
+  # Overrider a subresource value
+  resource.subresource.override_sr_value = "first value"
+  resource.all_subresource[1].override_sr_value = "new value"
+}
+
+template_instance.resource_sg # access the created resources outside the block
+```
+
+This template will create a resource `resource` and a resource security group `resource_sg` with the option `hello` set to value `'world'`. The resources can then be customized and have their values overridden.
+
+Each template should be documented with the created resources and how to modify them.
+
+### Resources and SubResources
+
+Resources are defined to be similar to the [terraform resource](https://www.terraform.io/docs/configuration/resources.html) configuration. The main difference is to not use `=` as this will create a local ruby variable and not assign the value.
+
+A `Resource` can be created with and `environment`, `project` or `template` object (this will add that resource to that object):
+
+```ruby
+environment.resource('type', 'identifier') {
+  name "resource_name"
+  subresource {
+    attribute "attribute"
+  }
+}
+
+project.resource('type', 'identifier') {
+  # ...
+}
+
+template.resource('type', 'identifier') {
+  # ...
+}
+```
+
+The `type` of a resource must be a valid terraform type, where AWS types are listed [here](https://www.terraform.io/docs/providers/aws/index.html). Some resources are not supported yet by GeoEngineer.
+
+`identifier` is used by GeoEngineer and terraform to reference this resource so must be unique, however it is not stored in the cloud so can be changed without affecting a plan.
+
+A resource also has a ruby block sent to it that contains parameters and sub-resources. These values are defined by terraform so for reference to what values are required please refer to the [terraform docs](https://www.terraform.io/docs/providers/aws/index.html).