ufo 4.1.5 → 4.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +5 -0
  3. data/Gemfile.lock +18 -18
  4. data/docs/_reference/ufo-init.md +13 -15
  5. data/docs/bin/web +1 -1
  6. data/docs/quick-start.md +14 -10
  7. data/lib/template/bin/deploy.tt +1 -1
  8. data/lib/ufo/help/init.md +13 -15
  9. data/lib/ufo/version.rb +1 -1
  10. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dfa53f85e3ac49817fc7173c918c0df4fcf438d16136a6fd51feb0ddc82b0e0e
4
- data.tar.gz: e02f034850589710adf85058649086082cced6df401e76c854f8eed737ebf5ba
3
+ metadata.gz: a483c161490cb3856ee429ffa12e4d75d8443a00bb8712d0274b322dc7eb7a00
4
+ data.tar.gz: 4fbe98c516f119218a9eaedde01f81221163412855b62ca726bd6dc935e6f7b7
5
5
  SHA512:
6
- metadata.gz: 3d7b2d923c46bad0e2d307f6ebb453ea3382c11dae15d81979ee273ecffbe386470c8ac3f13b1e7beb8def4a58afd37ce0e87f125fd1a3d4899ac82d5981035e
7
- data.tar.gz: b3fcdecaf2d7b3507df84bd78c7d790a15b9f5299977bb4396f833470f0c05b15448a505c687e475220763266ea52577d8dfbba8f3baa927cff8f8d76752d74d
6
+ metadata.gz: f11255a49c787365803f8514de49a0a6be79d658b2b5fcca701cfa0fb41c903a1238b6b70dd75fb92f3da3f15d28e22c9295655787f280577f8a363581e18918
7
+ data.tar.gz: c5b98c8fe3985efd2dc849e84e39c751e469678585bc71fcc6cca09483bb52c4983cc22dba5173b0a12c05ae4c3288995ba1c84f718fdcce3e4fb520867f6aee
data/CHANGELOG.md CHANGED
@@ -3,6 +3,11 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
5
5
 
6
+ ## [4.1.6]
7
+ - update bin/deploy starter wrapper
8
+ - update quick start with note about ecr image
9
+ - update ufo init help
10
+
6
11
  ## [4.1.5]
7
12
  - provide error message and instructions for case of missing default vpc, pull request #49
8
13
 
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- ufo (4.1.5)
4
+ ufo (4.1.6)
5
5
  aws-sdk-cloudformation
6
6
  aws-sdk-cloudwatchlogs
7
7
  aws-sdk-ec2
@@ -25,41 +25,41 @@ GEM
25
25
  minitest (~> 5.1)
26
26
  tzinfo (~> 1.1)
27
27
  aws-eventstream (1.0.1)
28
- aws-partitions (1.102.0)
29
- aws-sdk-cloudformation (1.6.0)
30
- aws-sdk-core (~> 3)
28
+ aws-partitions (1.107.0)
29
+ aws-sdk-cloudformation (1.10.0)
30
+ aws-sdk-core (~> 3, >= 3.26.0)
31
31
  aws-sigv4 (~> 1.0)
32
- aws-sdk-cloudwatchlogs (1.5.0)
33
- aws-sdk-core (~> 3)
32
+ aws-sdk-cloudwatchlogs (1.10.0)
33
+ aws-sdk-core (~> 3, >= 3.26.0)
34
34
  aws-sigv4 (~> 1.0)
35
- aws-sdk-core (3.25.0)
35
+ aws-sdk-core (3.36.0)
36
36
  aws-eventstream (~> 1.0)
37
37
  aws-partitions (~> 1.0)
38
38
  aws-sigv4 (~> 1.0)
39
39
  jmespath (~> 1.0)
40
- aws-sdk-ec2 (1.43.0)
41
- aws-sdk-core (~> 3)
40
+ aws-sdk-ec2 (1.54.0)
41
+ aws-sdk-core (~> 3, >= 3.26.0)
42
42
  aws-sigv4 (~> 1.0)
43
- aws-sdk-ecr (1.4.0)
44
- aws-sdk-core (~> 3)
43
+ aws-sdk-ecr (1.8.0)
44
+ aws-sdk-core (~> 3, >= 3.26.0)
45
45
  aws-sigv4 (~> 1.0)
46
- aws-sdk-ecs (1.17.0)
47
- aws-sdk-core (~> 3)
46
+ aws-sdk-ecs (1.22.0)
47
+ aws-sdk-core (~> 3, >= 3.26.0)
48
48
  aws-sigv4 (~> 1.0)
49
- aws-sdk-elasticloadbalancingv2 (1.12.0)
50
- aws-sdk-core (~> 3)
49
+ aws-sdk-elasticloadbalancingv2 (1.16.0)
50
+ aws-sdk-core (~> 3, >= 3.26.0)
51
51
  aws-sigv4 (~> 1.0)
52
52
  aws-sigv4 (1.0.3)
53
53
  byebug (10.0.2)
54
54
  cli_markdown (0.1.0)
55
- codeclimate-test-reporter (1.0.8)
55
+ codeclimate-test-reporter (1.0.9)
56
56
  simplecov (<= 0.13)
57
57
  colorize (0.8.1)
58
58
  concurrent-ruby (1.0.5)
59
59
  deep_merge (1.2.1)
60
60
  diff-lcs (1.3)
61
61
  docile (1.1.5)
62
- i18n (1.1.0)
62
+ i18n (1.1.1)
63
63
  concurrent-ruby (~> 1.0)
64
64
  jmespath (1.4.0)
65
65
  json (2.1.0)
@@ -77,7 +77,7 @@ GEM
77
77
  rspec-mocks (~> 3.8.0)
78
78
  rspec-core (3.8.0)
79
79
  rspec-support (~> 3.8.0)
80
- rspec-expectations (3.8.1)
80
+ rspec-expectations (3.8.2)
81
81
  diff-lcs (>= 1.2.0, < 2.0)
82
82
  rspec-support (~> 3.8.0)
83
83
  rspec-mocks (3.8.0)
data/docs/_reference/ufo-init.md CHANGED
@@ -20,9 +20,9 @@ The `ufo init` command provides a way to quickly setup a project to be ufo ready
20
20
 
21
21
  For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo) which is a small test sinatra app. Let's run the command in our newly clone project.
22
22
 
23
- $ git clone https://github.com/tongueroo/demo-ufo.git
24
- $ cd demo-ufo
25
- $ ufo init --app=demo --image=tongueroo/demo-ufo
23
+ $ git clone https://github.com/tongueroo/demo-ufo.git demo
24
+ $ cd demo
25
+ $ ufo init --image=tongueroo/demo-ufo
26
26
  Setting up ufo project...
27
27
  create .ufo/settings.yml
28
28
  create .ufo/task_definitions.rb
@@ -37,10 +37,10 @@ For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/d
37
37
 
38
38
  ## More Short Examples
39
39
 
40
- ufo init --image httpd --app demo
41
- ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage --app demo
42
- ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
43
- ufo init --image httpd --app demo --vpc-id vpc-123
40
+ ufo init --image httpd
41
+ ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
42
+ ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
43
+ ufo init --image httpd --vpc-id vpc-123
44
44
 
45
45
  ## Important options
46
46
 
@@ -75,13 +75,11 @@ For a explanation of the folders and files refer to [Structure]({% link _docs/st
75
75
 
76
76
  For ECS Fargate, the ECS task definition structure is a bit different. To initialize a project to support Fargate use the `--launch-type fargate` option. You'll be prompted for a execution role arn. This value gets added to the generated `.ufo/variables/base.rb` and used in the `.ufo/templates/main.json.erb`.
77
77
 
78
- ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate
78
+ ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate
79
79
 
80
80
  You can also generate the init ufo files and bypass the prompt by providing the `--execution-role-arn` option upfront.
81
81
 
82
- ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
83
-
84
- Important: You will need to adjust adjust the generated `.ufo/params.yml` and set the subnet and security_group values which are required for Fargate.
82
+ ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
85
83
 
86
84
  For more information and a demo of Fargate support, check out the [Fargate Docs]({% link _docs/fargate.md %}).
87
85
 
@@ -89,21 +87,21 @@ For more information and a demo of Fargate support, check out the [Fargate Docs]
89
87
 
90
88
  If you would like the `ufo init` command to use your own custom templates, you can achieve this with the `--template` and `--template-mode` options. Example:
91
89
 
92
- ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
90
+ ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
93
91
 
94
92
  This will clone the repo on GitHub into the `~/.ufo/templates/tongueroo/ufo-custom-template` and use that as an additional template source. The default `--template-mode=additive` mode means that if there's a file in `tongueroo/ufo-custom-template` that exists it will use that in place of the default template files.
95
93
 
96
94
  If you do not want to use any of the original default template files within the ufo gem at all, you can use the `--template-mode=replace` mode. Replace mode will only use templates from the provided `--template` option. Example:
97
95
 
98
- ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
96
+ ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
99
97
 
100
98
  You can also specific the full GitHub url. Example:
101
99
 
102
- ufo init --app=demo --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
100
+ ufo init --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
103
101
 
104
102
  If you would like to use a local template that is not on GitHub, then created a top-level folder in `~/.ufo/templates` without a subfolder. Example:
105
103
 
106
- ufo init --app=demo --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
104
+ ufo init --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
107
105
 
108
106
 
109
107
  ## Options
data/docs/bin/web CHANGED
@@ -1,4 +1,4 @@
1
1
  #!/bin/bash -ex
2
2
 
3
3
  bundle exec jekyll clean
4
- exec bundle exec jekyll serve
4
+ exec bundle exec jekyll serve "$@"
data/docs/quick-start.md CHANGED
@@ -4,16 +4,20 @@ title: Quick Start
4
4
 
5
5
  In a hurry? No sweat! Here's a quick start to using ufo that takes only a few minutes. For this example, we will use a sinatra app from [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo). The `ufo init` command sets up the ufo directory structure in your project. The `ufo ship` command deploys your code to an AWS ECS service. The `ufo ps` and `ufo scale` command shows you how to verify and scale additional containers.
6
6
 
7
- ```sh
8
- gem install ufo
9
- git clone https://github.com/tongueroo/demo-ufo.git demo
10
- cd demo
11
- ufo init --image=tongueroo/demo-ufo
12
- ufo current --service demo-web
13
- ufo ship
14
- ufo ps
15
- ufo scale 2
16
- ```
7
+ gem install ufo
8
+ git clone https://github.com/tongueroo/demo-ufo.git demo
9
+ cd demo
10
+ ufo init --image=tongueroo/demo-ufo
11
+ ufo current --service demo-web
12
+ ufo ship
13
+ ufo ps
14
+ ufo scale 2
15
+
16
+ Note: The example pushes the Docker image to Dockerhub. If you are using ECR instead, you can specific an ECR repo with the `--image` option. Example:
17
+
18
+ ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
19
+
20
+ For more info, refer to the [ufo init](http://ufoships.com/reference/ufo-init/) reference docs.
17
21
 
18
22
  ## What Happened
19
23
 
data/lib/template/bin/deploy.tt CHANGED
@@ -1,4 +1,4 @@
1
- #!/bin/bash -xe
1
+ #!/bin/bash
2
2
 
3
3
  # Generated starter bin/deploy script example.
4
4
  # Meant to be overridden.
data/lib/ufo/help/init.md CHANGED
@@ -7,9 +7,9 @@ The `ufo init` command provides a way to quickly setup a project to be ufo ready
7
7
 
8
8
  For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/demo-ufo) which is a small test sinatra app. Let's run the command in our newly clone project.
9
9
 
10
- $ git clone https://github.com/tongueroo/demo-ufo.git
11
- $ cd demo-ufo
12
- $ ufo init --app=demo --image=tongueroo/demo-ufo
10
+ $ git clone https://github.com/tongueroo/demo-ufo.git demo
11
+ $ cd demo
12
+ $ ufo init --image=tongueroo/demo-ufo
13
13
  Setting up ufo project...
14
14
  create .ufo/settings.yml
15
15
  create .ufo/task_definitions.rb
@@ -24,10 +24,10 @@ For this example we will use [tongueroo/demo-ufo](https://github.com/tongueroo/d
24
24
 
25
25
  ## More Short Examples
26
26
 
27
- ufo init --image httpd --app demo
28
- ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage --app demo
29
- ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
30
- ufo init --image httpd --app demo --vpc-id vpc-123
27
+ ufo init --image httpd
28
+ ufo init --image 123456789012.dkr.ecr.us-west-2.amazonaws.com/myimage
29
+ ufo init --image tongueroo/demo-ufo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
30
+ ufo init --image httpd --vpc-id vpc-123
31
31
 
32
32
  ## Important options
33
33
 
@@ -62,13 +62,11 @@ For a explanation of the folders and files refer to [Structure]({% link _docs/st
62
62
 
63
63
  For ECS Fargate, the ECS task definition structure is a bit different. To initialize a project to support Fargate use the `--launch-type fargate` option. You'll be prompted for a execution role arn. This value gets added to the generated `.ufo/variables/base.rb` and used in the `.ufo/templates/main.json.erb`.
64
64
 
65
- ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate
65
+ ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate
66
66
 
67
67
  You can also generate the init ufo files and bypass the prompt by providing the `--execution-role-arn` option upfront.
68
68
 
69
- ufo init --image tongueroo/demo-ufo --app demo --force --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
70
-
71
- Important: You will need to adjust adjust the generated `.ufo/params.yml` and set the subnet and security_group values which are required for Fargate.
69
+ ufo init --image tongueroo/demo-ufo --app demo --launch-type fargate --execution-role-arn arn:aws:iam::123456789012:role/ecsTaskExecutionRole
72
70
 
73
71
  For more information and a demo of Fargate support, check out the [Fargate Docs]({% link _docs/fargate.md %}).
74
72
 
@@ -76,18 +74,18 @@ For more information and a demo of Fargate support, check out the [Fargate Docs]
76
74
 
77
75
  If you would like the `ufo init` command to use your own custom templates, you can achieve this with the `--template` and `--template-mode` options. Example:
78
76
 
79
- ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
77
+ ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template
80
78
 
81
79
  This will clone the repo on GitHub into the `~/.ufo/templates/tongueroo/ufo-custom-template` and use that as an additional template source. The default `--template-mode=additive` mode means that if there's a file in `tongueroo/ufo-custom-template` that exists it will use that in place of the default template files.
82
80
 
83
81
  If you do not want to use any of the original default template files within the ufo gem at all, you can use the `--template-mode=replace` mode. Replace mode will only use templates from the provided `--template` option. Example:
84
82
 
85
- ufo init --app=demo --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
83
+ ufo init --image=tongueroo/demo-ufo --template=tongueroo/ufo-custom-template --template-mode=replace
86
84
 
87
85
  You can also specific the full GitHub url. Example:
88
86
 
89
- ufo init --app=demo --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
87
+ ufo init --image=tongueroo/demo-ufo --template=https://github.com/tongueroo/ufo-custom-template
90
88
 
91
89
  If you would like to use a local template that is not on GitHub, then created a top-level folder in `~/.ufo/templates` without a subfolder. Example:
92
90
 
93
- ufo init --app=demo --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
91
+ ufo init --image=tongueroo/demo-ufo --template=my-custom # uses ~/.ufo/templates/my-custom
data/lib/ufo/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Ufo
2
- VERSION = "4.1.5"
2
+ VERSION = "4.1.6"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ufo
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.5
4
+ version: 4.1.6
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tung Nguyen
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-08-30 00:00:00.000000000 Z
11
+ date: 2018-10-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-cloudformation