aws-insight 0.14.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing
+
+I love pull requests from everyone! By the way, I have a favor to ask you with your contribution :bow:
+
+## Making changes
+
+- Currently, this gem supports only __AWS__ resources. Other providers are supported as separated gems.
+  - Datadog: [terraforming-datadog](https://github.com/dtan4/terraforming-datadog)
+  - DNSimple: [terraforming-dnsimple](https://github.com/dtan4/terraforming-dnsimple)
+- Do not bump gem version in your pull request.
+- Please follow the coding style of _existing_ code. Most of trivial rules can be checked by [RuboCop](https://github.com/bbatsov/rubocop) ([`rubocop.yml`](https://github.com/dtan4/terraforming/blob/master/.rubocop.yml)).
+  - Coding style is checked automatically by [SideCI](https://sideci.com) right after creating pull request. If there is error, SideCI comments at the point error occured.
+- Please write tests for your changes. All tests are written with [RSpec](http://rspec.info/).
+
+## Adding new resource
+
+- Class name must match to Terraforming's resource name without `aws_` prefix, and be a complete resource name.
+  - e.g. `aws_iam_group_membership`: `IAMGroupMembership`
+  - Yes, I know that some of resources I added a long ago don't follow to this rule...
+- File name must also match to Terraforming's resource name without `aws_` prefix.
+  - e.g. `aws_iam_group_membership`: `iam_group_membership.rb`
+- Command name should be abbreviation.
+  - e.g. `aws_iam_group_membership`: `iamgp`
+- Please check generation result by executing `terraform plan` with real resources. There should be NO diff with generated `.tf` and `.tfstate`.
+
+`script/generate` generates new resource code / test skeletons.
+
+```bash
+$ script/generate ec2
+==> Generate ec2.rb
+==> Generate ec2_spec.rb
+==> Generate ec2.erb
+
+Add below code by hand.
+
+lib/terraforming.rb:
+
+    require "terraforming/resource/ec2"
+
+lib/terraforming/cli.rb:
+
+    module Terraforming
+      class CLI < Thor
+
+        # Subcommand name should be acronym.
+        desc "ec2", "Ec2"
+        def ec2
+          execute(Terraforming::Resource::Ec2, options)
+        end
+
+spec/lib/terraforming/cli_spec.rb:
+
+module Terraforming
+  describe CLI do
+    context "resources" do
+    describe "ec2" do
+        let(:klass)   { Terraforming::Resource::Ec2
+        let(:command) { :ec2 }
+
+        it_behaves_like "CLI examples"
+      end
+```

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in terraforming.gemspec
+gemspec
+
+group :development do
+  gem "guard"
+  gem "guard-rspec"
+
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
+    gem "listen", "~> 3.1.0"
+  else
+    gem "listen", "< 3.1.0"
+  end
+
+  gem "rubocop"
+
+  gem "terminal-notifier-guard"
+end

data/Guardfile

@@ -0,0 +1,12 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Daisuke Fujita
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,393 @@
+# Terraforming
+
+[![Build Status](https://travis-ci.org/dtan4/terraforming.svg?branch=master)](https://travis-ci.org/dtan4/terraforming)
+[![Code Climate](https://codeclimate.com/github/dtan4/terraforming/badges/gpa.svg)](https://codeclimate.com/github/dtan4/terraforming)
+[![Coverage Status](https://coveralls.io/repos/github/dtan4/terraforming/badge.svg?branch=increase-test-cov-160528)](https://coveralls.io/github/dtan4/terraforming)
+[![Dependency Status](https://gemnasium.com/dtan4/terraforming.svg)](https://gemnasium.com/dtan4/terraforming)
+[![Gem Version](https://badge.fury.io/rb/terraforming.svg)](http://badge.fury.io/rb/terraforming)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
+[![Docker Repository on Quay.io](https://quay.io/repository/dtan4/terraforming/status "Docker Repository on Quay.io")](https://quay.io/repository/dtan4/terraforming)
+[![Join the chat at https://gitter.im/dtan4/terraforming](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dtan4/terraforming?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+Export existing AWS resources to [Terraform](https://terraform.io/) style (tf, tfstate)
+
+- [Supported version](#supported-version)
+- [Installation](#installation)
+- [Prerequisites](#prerequisites)
+- [Usage](#usage)
+  -  [Export tf](#export-tf)
+  -  [Export tfstate](#export-tfstate)
+    -  [Example: Export all](#example-export-all)
+- [Run as Docker container](#run-as-docker-container-)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Supported version
+
+Ruby 2.1 or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'terraforming'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install terraforming
+
+## Prerequisites
+
+You need to set AWS credentials.
+
+```bash
+export AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXXXX
+export AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+export AWS_REGION=xx-yyyy-0
+```
+
+You can also specify credential profile in `~/.aws/credentials` by `--profile` option.
+
+```bash
+$ cat ~/.aws/credentials
+[hoge]
+aws_access_key_id = Hoge
+aws_secret_access_key = FugaFuga
+
+# Pass profile name by --profile option
+$ terraforming s3 --profile hoge
+```
+
+You can force the AWS SDK to utilize the CA certificate that is bundled with the SDK for systems where the default OpenSSL certificate is not installed (e.g. Windows) by utilizing the `--use-bundled-cert` option.
+
+```bash
+PS C:\> terraforming ec2 --use-bundled-cert
+```
+
+## Usage
+
+```bash
+$ terraforming
+Commands:
+  terraforming alb             # ALB
+  terraforming asg             # AutoScaling Group
+  terraforming cwa             # CloudWatch Alarm
+  terraforming dbpg            # Database Parameter Group
+  terraforming dbsg            # Database Security Group
+  terraforming dbsn            # Database Subnet Group
+  terraforming ec2             # EC2
+  terraforming ecc             # ElastiCache Cluster
+  terraforming ecsn            # ElastiCache Subnet Group
+  terraforming efs             # EFS File System
+  terraforming eip             # EIP
+  terraforming elb             # ELB
+  terraforming help [COMMAND]  # Describe available commands or one specific command
+  terraforming iamg            # IAM Group
+  terraforming iamgm           # IAM Group Membership
+  terraforming iamgp           # IAM Group Policy
+  terraforming iamip           # IAM Instance Profile
+  terraforming iamp            # IAM Policy
+  terraforming iampa           # IAM Policy Attachment
+  terraforming iamr            # IAM Role
+  terraforming iamrp           # IAM Role Policy
+  terraforming iamu            # IAM User
+  terraforming iamup           # IAM User Policy
+  terraforming igw             # Internet Gateway
+  terraforming kmsa            # KMS Key Alias
+  terraforming kmsk            # KMS Key
+  terraforming lc              # Launch Configuration
+  terraforming nacl            # Network ACL
+  terraforming nat             # NAT Gateway
+  terraforming nif             # Network Interface
+  terraforming r53r            # Route53 Record
+  terraforming r53z            # Route53 Hosted Zone
+  terraforming rds             # RDS
+  terraforming rs              # Redshift
+  terraforming rt              # Route Table
+  terraforming rta             # Route Table Association
+  terraforming s3              # S3
+  terraforming sg              # Security Group
+  terraforming sn              # Subnet
+  terraforming snst            # SNS Topic
+  terraforming snss            # SNS Subscription
+  terraforming sqs             # SQS
+  terraforming vgw             # VPN Gateway
+  terraforming vpc             # VPC
+
+Options:
+  [--merge=MERGE]                                # tfstate file to merge
+  [--overwrite], [--no-overwrite]                # Overwrite existng tfstate
+  [--tfstate], [--no-tfstate]                    # Generate tfstate
+  [--profile=PROFILE]                            # AWS credentials profile
+  [--region=REGION]                              # AWS region
+  [--use-bundled-cert], [--no-use-bundled-cert]  # Use the bundled CA certificate from AWS SDK
+```
+
+### Export tf
+
+```bash
+$ terraforming <resource> [--profile PROFILE]
+```
+
+(e.g. S3 buckets):
+
+```bash
+$ terraforming s3
+```
+
+```hcl
+resource "aws_s3_bucket" "hoge" {
+    bucket = "hoge"
+    acl    = "private"
+}
+
+resource "aws_s3_bucket" "fuga" {
+    bucket = "fuga"
+    acl    = "private"
+}
+```
+
+### Export tfstate
+
+```bash
+$ terraforming <resource> --tfstate [--merge TFSTATE_PATH] [--overwrite] [--profile PROFILE]
+```
+
+(e.g. S3 buckets):
+
+```bash
+$ terraforming s3 --tfstate
+```
+
+```json
+{
+  "version": 1,
+  "serial": 1,
+  "modules": {
+    "path": [
+      "root"
+    ],
+    "outputs": {
+    },
+    "resources": {
+      "aws_s3_bucket.hoge": {
+        "type": "aws_s3_bucket",
+        "primary": {
+          "id": "hoge",
+          "attributes": {
+            "acl": "private",
+            "bucket": "hoge",
+            "id": "hoge"
+          }
+        }
+      },
+      "aws_s3_bucket.fuga": {
+        "type": "aws_s3_bucket",
+        "primary": {
+          "id": "fuga",
+          "attributes": {
+            "acl": "private",
+            "bucket": "fuga",
+            "id": "fuga"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+If you want to merge exported tfstate to existing `terraform.tfstate`, specify `--tfstate --merge=/path/to/terraform.tfstate` option.
+You can overwrite existing `terraform.tfstate` by specifying `--overwrite` option together.
+
+Existing `terraform.tfstate`:
+
+```bash
+# /path/to/terraform.tfstate
+
+{
+  "version": 1,
+  "serial": 88,
+  "remote": {
+    "type": "s3",
+    "config": {
+      "bucket": "terraforming-tfstate",
+      "key": "tf"
+    }
+  },
+  "modules": {
+    "path": [
+      "root"
+    ],
+    "outputs": {
+    },
+    "resources": {
+      "aws_elb.hogehoge": {
+        "type": "aws_elb",
+        "primary": {
+          "id": "hogehoge",
+          "attributes": {
+            "availability_zones.#": "2",
+            "connection_draining": "true",
+            "connection_draining_timeout": "300",
+            "cross_zone_load_balancing": "true",
+            "dns_name": "hoge-12345678.ap-northeast-1.elb.amazonaws.com",
+            "health_check.#": "1",
+            "id": "hogehoge",
+            "idle_timeout": "60",
+            "instances.#": "1",
+            "listener.#": "1",
+            "name": "hoge",
+            "security_groups.#": "2",
+            "source_security_group": "default",
+            "subnets.#": "2"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+To generate merged tfstate:
+
+```bash
+$ terraforming s3 --tfstate --merge=/path/to/tfstate
+```
+
+```json
+{
+  "version": 1,
+  "serial": 89,
+  "remote": {
+    "type": "s3",
+    "config": {
+      "bucket": "terraforming-tfstate",
+      "key": "tf"
+    }
+  },
+  "modules": {
+    "path": [
+      "root"
+    ],
+    "outputs": {
+    },
+    "resources": {
+      "aws_elb.hogehoge": {
+        "type": "aws_elb",
+        "primary": {
+          "id": "hogehoge",
+          "attributes": {
+            "availability_zones.#": "2",
+            "connection_draining": "true",
+            "connection_draining_timeout": "300",
+            "cross_zone_load_balancing": "true",
+            "dns_name": "hoge-12345678.ap-northeast-1.elb.amazonaws.com",
+            "health_check.#": "1",
+            "id": "hogehoge",
+            "idle_timeout": "60",
+            "instances.#": "1",
+            "listener.#": "1",
+            "name": "hoge",
+            "security_groups.#": "2",
+            "source_security_group": "default",
+            "subnets.#": "2"
+          }
+        }
+      },
+      "aws_s3_bucket.hoge": {
+        "type": "aws_s3_bucket",
+        "primary": {
+          "id": "hoge",
+          "attributes": {
+            "acl": "private",
+            "bucket": "hoge",
+            "id": "hoge"
+          }
+        }
+      },
+      "aws_s3_bucket.fuga": {
+        "type": "aws_s3_bucket",
+        "primary": {
+          "id": "fuga",
+          "attributes": {
+            "acl": "private",
+            "bucket": "fuga",
+            "id": "fuga"
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+After writing exported tf and tfstate to files, execute `terraform plan` and check the result.
+There should be no diff.
+
+```bash
+$ terraform plan
+No changes. Infrastructure is up-to-date. This means that Terraform
+could not detect any differences between your configuration and
+the real physical resources that exist. As a result, Terraform
+doesn't need to do anything.
+```
+
+#### Example: Export all
+Example assuming you want to export everything from us-west-2 and you are using ~/.aws/credentials with a `default` profile
+```bash
+export AWS_REGION=us-west-2
+terraforming help | grep terraforming | grep -v help | awk '{print "terraforming", $2, "--profile", "default", ">", $2".tf";}' | bash
+# find files that only have 1 empty line (likely nothing in AWS)
+find . -type f -name '*.tf' | xargs wc -l | grep ' 1 .'
+```
+
+## Run as Docker container [![Docker Repository on Quay.io](https://quay.io/repository/dtan4/terraforming/status "Docker Repository on Quay.io")](https://quay.io/repository/dtan4/terraforming)
+
+Terraforming Docker Image is available at [quay.io/dtan4/terraforming](https://quay.io/repository/dtan4/terraforming) and developed at [dtan4/dockerfile-terraforming](https://github.com/dtan4/dockerfile-terraforming).
+
+Pull the Docker image:
+
+```bash
+$ docker pull quay.io/dtan4/terraforming:latest
+```
+
+And then run Terraforming as a Docker container:
+
+```bash
+$ docker run \
+    --rm \
+    --name terraforming \
+    -e AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXXXXXXXX \
+    -e AWS_SECRET_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx \
+    -e AWS_REGION=xx-yyyy-0 \
+    quay.io/dtan4/terraforming:latest \
+    terraforming s3
+```
+
+## Development
+
+After checking out the repo, run `script/setup` to install dependencies. Then, run `script/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Please read [Contribution Guide](CONTRIBUTING.md) at first.
+
+1. Fork it ( https://github.com/dtan4/terraforming/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)