codebuild 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7cce7e14c55b16c76ad7c5ca3fe53d49c6a0ea53e0a776796d0461ca59a06c79
-  data.tar.gz: c80068ba1f03a19223e75e5a99a89f75b9ecc383673dcb2a49a2e74c696224ce
+  metadata.gz: badd1e72fa3c3f4789dab4d592f6d26d14b75e6544b4dc2f51b0e363a95ca60c
+  data.tar.gz: d7b8bd1d7e44f670b526acacc9efd00a8c102366379cd359e23e131814cb8ed2
 SHA512:
-  metadata.gz: 189737112a90fcc408a49b3fbc044062f1b92e8ab89a735108e822bcbeabbd0fa95a67aba1d86e03ee69d95ab8d91dc752e7eb03c7a70160424c60be8820657d
-  data.tar.gz: 951a796d4c4611704b23e5771dc4b0a669ee2858c1fcd22533f5373c71d3f7bfe149bae1a76c2e14b3233fe3af74389df9320f37ce37594c01003ba579ada06e
+  metadata.gz: a129f41b1259bb1611fe919244a3d4bf21145bc0378b6a1da652399351a587fce014ef34498b93282eda7ddc186eb8a4a34b174bd0a701fab439f6766dd1c6af
+  data.tar.gz: 4e92c824e7c1d59bf9dfd1585bce64ad5acfe158927ea2dd7f33b291699d700b6e47fe065f764798b4c63aa015f488e0bc7c0c58d6358b4ae0c5b487f6ec435f

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.3]
+- add aws_data gem dependency
+
 ## [0.6.2]
 - add s3 read-only access to default role
 - fix settings

data/README.md

@@ -97,7 +97,7 @@ Here's a list of some of the convenience shorthand DSL methods:
 
 Please refer to [lib/codebuild/dsl/project.rb](lib/codebuild/dsl/project.rb) for the full list.
 
-More slightly more control, you may be interested in the `github_source` and `linux_environment` methods.  For even more control, see [DSL docs](docs/dsl).
+More slightly more control, you may be interested in the `github_source` and `linux_environment` methods.  For even more control, see [DSL docs](https://codebuild.cloud/docs/dsl/).
 
 ## IAM Role DSL
 
@@ -140,11 +140,11 @@ rate "1 day"
 
 ## Full DSL
 
-The convenience DSL methods shown above are short and clean.  They merely wrap a DSL that map to the properties of CloudFormation resources like [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) and [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). Refer the [DSL docs](docs/dsl) for more info.
+The convenience DSL methods shown above are short and clean.  They merely wrap a DSL that map to the properties of CloudFormation resources like [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) and [AWS::IAM::Role](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html). Refer the [DSL docs](https://codebuild.cloud/docs/dsl/) for more info.
 
 ## Type Option
 
-By default, the codebuild tool looks up files in the `.codebuild` folder.  You can affect the behavior of the Type logic with the `--Type` option.  More info [Type docs](readme/type.md).
+By default, the codebuild tool looks up files in the `.codebuild` folder.  You can affect the behavior of the Type logic with the `--Type` option.  More info [Type docs](https://codebuild.cloud/docs/type-option/).
 
 ## Installation
 

data/codebuild.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"
+  spec.add_dependency "aws_data"
   spec.add_dependency "aws-sdk-cloudformation"
   spec.add_dependency "aws-sdk-codebuild"
   spec.add_dependency "aws-sdk-ssm"

data/docs/_docs/dsl/project.md

@@ -37,7 +37,7 @@ The convenience methods are shorter and cleaner. However, you have access to a F
 .codebuild/project.rb:
 
 ```ruby
-name("demo") # recommend to not set this, and let the codebuild tool set this automatically
+# name("demo") # recommend to not set, and let the codebuild tool set this automatically
 description("desc2")
 # https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html
 source(
@@ -77,4 +77,4 @@ environment(
 service_role(ref: "IamRole")
 ```
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/dsl/schedule.md

@@ -12,7 +12,7 @@ The codebuild tool supports creating a CloudWatch scheduled event rule that will
 ```ruby
 rate "1 day"
 # or
-cron("0 10 * * ? *") # Run at 10:00 am (UTC) every day
+# cron("0 10 * * ? *") # Run at 10:00 am (UTC) every day
 ```
 
 ## Full DSL
@@ -26,4 +26,4 @@ description "my description"
 schedule_expression "rate(1 day)"
 ```
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/examples/ecs.md

@@ -49,10 +49,19 @@ phases:
       - UFO_ENV=$UFO_ENV ufo ship $UFO_APP
 ```
 
-Last, here's the IAM Policy that will give CodeBuild the IAM permissions necessary to create the ECS service and other resources that ufo can create:
+The `ufo ship` command:
 
-.codebuild/role.rb:
+    UFO_ENV=$UFO_ENV ufo ship $UFO_APP
+
+When codebuild actually runs, the values will be:
+
+    UFO_ENV=production ufo ship demo-web
+
+## IAM Policy
 
+The codebuild tool also can create the IAM Policy that will give CodeBuild the IAM permissions necessary to create the ECS service and other resources that `ufo ship` creates. Here are the IAM permissions as detailed on the [UFO Minimal IAM Permissions](https://ufoships.com/docs/extras/minimal-deploy-iam/) docs.
+
+.codebuild/role.rb:
 
 ```ruby
 iam_policy(
@@ -83,6 +92,8 @@ iam_policy(
 managed_iam_policy("AmazonS3ReadOnlyAccess") # optional but common to need read only access to s3
 ```
 
+## Security
+
 From a security perspective, using CodeBuild gives us a stronger security posture. The **only** permission the user calling [cb start]({% link _docs/start.md %}) really needs is CodeBuild access.  The permissions to create the ECS service and other deployment resources are delegated to the CodeBuild project itself. We know that the CodeBuild project will not run any arbitrary commands unless we update `buildspec.yml` and explicitly give permission to it's IAM role.
 
 {% include examples-steps.md %}
@@ -91,6 +102,6 @@ From a security perspective, using CodeBuild gives us a stronger security postur
 
 If you are using CodePipeline also, you may be wondering why not just use the provided Amazon ECS deployment action instead.  It comes down to control. With a CodeBuild project, we have full control of how we want to build and deploy the Docker image to ECS.
 
-Also, with the CodePipeline ECS deploy action, we are unable to configure a timeout.  If the ECS deployment fails due to some reasons, we're stuck waiting 60 minutes for the pipeline timeout. There's a way to hack around this by literally overriding updating the CodeBuild project. You also must do it manually and are charged for the time. With CodeBuild project, you can set the timeout value yourself. Essentially, you have more control with CodeBuild.
+Also, with the CodePipeline ECS deploy action, we are unable to configure a timeout.  If the ECS deployment fails due to some reasons, we're stuck waiting 60 minutes for the pipeline timeout. There's a way to hack around this by literally overriding updating the CodeBuild project. You also must do it manually and are charged for the time if you don't notice it. With CodeBuild project, you can set the timeout value yourself. Essentially, you have more control with CodeBuild. There's some more info here: [CodePipeline ECS Deploy vs CodeBuild ufo ship](https://codepipeline.org/docs/ecs-deploy/).
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/examples/jets.md

@@ -20,7 +20,7 @@ environment_variables(
 )
 ```
 
-The [.codebuild/project.rb](.codebuild/project.rb) uses a Docker image that has ruby, node, and yarn already installed.  If you prefer to use another image, update the `linux_image` setting, and update your `buildspec.yml` accordingly. IE: Install the necessary packages.
+The [.codebuild/project.rb](https://github.com/tongueroo/jets-codebuild/blob/master/.codebuild/project.rb) uses a Docker image that has Ruby, Node, and Yarn already installed.  If you prefer to use another image, update the `linux_image` setting, and update your `buildspec.yml` accordingly. For example, you may need to install the necessary packages.
 
 Here's the buildspec:
 
@@ -76,4 +76,4 @@ You may be interested in the [separate-unit-and-deploy branch](https://github.co
 
 {% include examples-steps.md %}
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/examples/ruby.md

@@ -30,7 +30,7 @@ version: 0.2
 phases:
   install:
     commands:
-      - apt-get update -y apt-get install -y rsync
+      - apt-get update -y && apt-get install -y rsync
   build:
     commands:
       - echo Build started on `date`

data/docs/_docs/github_oauth.md

@@ -48,4 +48,4 @@ Import the source credential into codebuild.
 
 Setting this sets the oauth token used by the CodeBuild projects.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/start.md

@@ -5,18 +5,23 @@ nav_order: 7
 
 You can start a CodeBuild project with the `cb start` command. Here's an example:
 
-    $ cb start
+    $ cb start demo
     Build started for project: demo
     Please check the CodeBuild console for the status.
     Codebuild Log Url:
     https://us-west-2.console.aws.amazon.com/codesuite/codebuild/projects/demo/build/demo%3A7bc4cb33-d918-467a-9e09-fe7fe1f57ed8/log
     $
 
+If the project name is the same as the parent folder name then you can do this:
+
+    cd demo
+    cb start # demo is inferred from the parent folder
+
 ## Specifying Code Branch
 
 If you would like start a build using a specific code branch you can use the `--branch` or `-b` option.  Example:
 
-    cb start -b feature-branch
+    cb start demo -b feature-branch
 
 ## AWS CLI Equivalent
 
@@ -28,14 +33,14 @@ The `cb start` command is a simple wrapper to the AWS API with the ruby sdk. You
 
 If you are using multiple Codebuild projects with [Types]({% link _docs/type-option.md %}), you can start the specific CodeBuild project type with the `--type` option.  Example:
 
-    cb start --type unit
+    cb start demo --type unit
 
 ## Override CodeBuild Environment Variables
 
 You can override CodeBuild env variables at runtime with `--env-vars`. Examples:
 
-    cb start --type vpc --env-vars K1=v1 K2=v2
-    cb start --type vpc --env-vars K1=v1 K2=ssm:v2 # support for PARAMETER_STORE
+    cb start demo --type vpc --env-vars K1=v1 K2=v2
+    cb start demo --type vpc --env-vars K1=v1 K2=ssm:v2 # support for PARAMETER_STORE
 
 Remember the environment variables are within the CodeBuild environment instance running the build script, not the application's environment.
 
@@ -43,4 +48,4 @@ Remember the environment variables are within the CodeBuild environment instance
 
 Also, for help info you can check the [cb start]({% link _reference/cb-start.md %}) CLI reference.
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/type-option.md

@@ -3,7 +3,7 @@ title: Type Option
 nav_order: 4
 ---
 
-The `--type` option is a powerful option that allows you to create multiple codebuild projects associated with the same project.
+The `--type` option is a powerful option that allows you to create multiple codebuild projects associated with the same repo.
 
 ## Default Behavior
 
@@ -69,4 +69,4 @@ demo | demo-cb
 demo-unit | demo-unit-cb
 demo-web-unit | demo-web-unit-cb
 
-{% include prev_next.md %}
+{% include prev_next.md %}

data/docs/_docs/variables.md

@@ -87,4 +87,31 @@ The type specific variable files override the top-level variable files. Type spe
 
 The top-level variables files are also loaded because it is common to need variables that are available to all projects.
 
-{% include prev_next.md %}
+## VPC and Migrations Example
+
+An good exmaple of using variables is run migrations via codebuild and the task requires access to the VPC.
+  However, the development and production resources are on separate VPCs.  Variables can help here:
+
+.codebuild/variables/development.rb:
+
+```ruby
+@vpc_config = { vpc_id: "vpc-aaa", subnet_id: "subnet-aaa" }
+```
+
+.codebuild/variables/production.rb:
+
+```ruby
+@vpc_config = { vpc_id: "vpc-bbb", subnet_id: "subnet-bbb" }
+```
+
+You'll use then `@vpc_config` variable in the `buildspec.yml`.
+
+.codebuild/buildspec.yml:
+
+```ruby
+github_url("https://github.com/tongueroo/demo-ufo")
+linux_image("aws/codebuild/ruby:2.5.3-1.7.0")
+vpc_config @vpc_config
+```
+
+{% include prev_next.md %}

data/docs/_includes/examples-steps.md

@@ -10,8 +10,8 @@ This creates the CodeBuild project as well as the necessary IAM role.
 
 To start a build:
 
-    cb start
+    cb start demo
 
 You can also start a build with a specific branch. Remember to `git push` your branch.
 
-    cb start -b mybranch
+    cb start demo -b mybranch

data/docs/_includes/subnav.html

@@ -9,7 +9,7 @@
         <li><a href="{% link _docs/deploy.md %}">Deploy</a></li>
         <li><a href="{% link _docs/start.md %}">Start</a></li>
         <li><a href="{% link _docs/settings.md %}">Settings</a></li>
-        <li><a href="{% link _docs/conventions.md %}">Naming Conventions</a></li>
+        <li><a href="{% link _docs/conventions.md %}">Conventions</a></li>
         <li><a href="{% link _docs/github_oauth.md %}">Github Oauth</a></li>
       </ul>
     </li>

data/lib/codebuild/version.rb

@@ -1,3 +1,3 @@
 module Codebuild
-  VERSION = "0.6.2"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codebuild
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2019-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws_data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-cloudformation
   requirement: !ruby/object:Gem::Requirement