Class: Jets::Cfn::Ship
- Inherits:
-
Object
show all
- Extended by:
- Memoist
- Includes:
- AwsServices
- Defined in:
- lib/jets/cfn/ship.rb
Instance Method Summary
collapse
#apigateway, #aws_lambda, #aws_options, #cfn, #dynamodb, #logs, #s3, #s3_resource, #sns, #sqs, #sts
#lookup, #stack_exists?, #stack_in_progress?
included
Constructor Details
#initialize(options) ⇒ Ship
Returns a new instance of Ship.
6
7
8
9
|
# File 'lib/jets/cfn/ship.rb', line 6
def initialize(options)
@options = options
@parent_stack_name = Jets::Names.parent_stack_name
end
|
Instance Method Details
#api_gateway ⇒ Object
Do not memoize this because on first stack run it will be nil It only gets called one more time so just let it get called.
139
140
141
142
143
|
# File 'lib/jets/cfn/ship.rb', line 139
def api_gateway
resp = cfn.describe_stack_resources(stack_name: @parent_stack_name)
resources = resp.stack_resources
resources.find { |resource| resource.logical_resource_id == "ApiGateway" }
end
|
#capabilities ⇒ Object
193
194
195
|
# File 'lib/jets/cfn/ship.rb', line 193
def capabilities
["CAPABILITY_IAM", "CAPABILITY_NAMED_IAM"]
end
|
#clean_deploy_logs ⇒ Object
125
126
127
|
# File 'lib/jets/cfn/ship.rb', line 125
def clean_deploy_logs
Jets::Commands::Clean::Log.new(@options).clean_deploys
end
|
#command_with_iam(capabilities) ⇒ Object
189
190
191
|
# File 'lib/jets/cfn/ship.rb', line 189
def command_with_iam(capabilities)
"#{File.basename($0)} #{ARGV.join(' ')} --capabilities #{capabilities}"
end
|
#create_deployment_record ⇒ Object
54
55
56
57
58
59
60
61
|
# File 'lib/jets/cfn/ship.rb', line 54
def create_deployment_record
return if @options[:stack_type] == :minimal
resp = Jets::Cfn::Deployment.new(@options.merge(stack_name: @parent_stack_name)).create
if resp
version = resp["version"]
Jets::Cfn::Upload.new.upload_cfn_templates(version) if version
end
end
|
#create_stack ⇒ Object
75
76
77
78
|
# File 'lib/jets/cfn/ship.rb', line 75
def create_stack
cfn.create_stack(stack_options)
end
|
#endpoint_available? ⇒ Boolean
146
147
148
|
# File 'lib/jets/cfn/ship.rb', line 146
def endpoint_available?
!endpoint_unavailable?
end
|
#endpoint_unavailable? ⇒ Boolean
129
130
131
132
133
134
135
|
# File 'lib/jets/cfn/ship.rb', line 129
def endpoint_unavailable?
return true unless @options[:stack_type] == :full return true if Jets::Router.no_routes?
_, status = stack_status
return true if status.include?("ROLLBACK")
return true unless api_gateway
end
|
#prewarm ⇒ Object
112
113
114
115
116
117
118
119
120
121
122
123
|
# File 'lib/jets/cfn/ship.rb', line 112
def prewarm
if ENV['SKIP_PREWARMING']
puts "Skipping prewarming" return
end
return unless @options[:stack_type] == :full return unless Jets.config.prewarm.enable
return unless Jets.gem_layer?
puts "Prewarming application."
Jets::PreheatJob.prewarm!
end
|
#prompt_for_iam(capabilities) ⇒ Object
181
182
183
184
185
186
187
|
# File 'lib/jets/cfn/ship.rb', line 181
def prompt_for_iam(capabilities)
puts "This stack will create IAM resources. Please approve to run the command again with #{capabilities} capabilities."
puts " #{command_with_iam(capabilities)}"
puts "Please confirm (y/n)"
$stdin.gets end
|
#run ⇒ Object
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# File 'lib/jets/cfn/ship.rb', line 11
def run
upload_to_s3 if @options[:stack_type] == :full
stack_in_progress?(@parent_stack_name)
puts "Deploying CloudFormation stack with jets app!"
begin
set_resource_tags
save_stack
rescue Aws::CloudFormation::Errors::InsufficientCapabilitiesException => e
capabilities = e.message.match(/\[(.*)\]/)[1]
confirm = prompt_for_iam(capabilities)
if confirm =~ /^y/
@options.merge!(capabilities: [capabilities])
puts "Re-running: #{command_with_iam(capabilities).color(:green)}"
retry
else
puts "Exited"
exit 1
end
end
success = wait_for_stack
unless success
puts <<~EOL
The Jets application failed to deploy. Jets creates a few CloudFormation stacks to deploy your application.
The logs above show the CloudFormation parent stack events and points to the stack with the error.
Please go to the CloudFormation console and look for the specific stack with the error.
The specific child stack usually shows more detailed information and can be used to resolve the issue.
Example of checking the CloudFormation console: https://rubyonjets.com/docs/debugging/cloudformation/
EOL
exit 1
end
save_apigw_state
prewarm
clean_deploy_logs
show_api_endpoint
show_custom_domain
create_deployment_record
end
|
#save_apigw_state ⇒ Object
#save_stack ⇒ Object
67
68
69
70
71
72
73
|
# File 'lib/jets/cfn/ship.rb', line 67
def save_stack
if stack_exists?(@parent_stack_name)
update_stack
else
create_stack
end
end
|
63
64
65
|
# File 'lib/jets/cfn/ship.rb', line 63
def set_resource_tags
@tags = Jets.config.cfn.build.resource_tags.map { |key, value| { key: key, value: value } }
end
|
#show_api_endpoint ⇒ Object
150
151
152
153
154
155
156
157
158
159
160
|
# File 'lib/jets/cfn/ship.rb', line 150
def show_api_endpoint
return unless endpoint_available?
stack_id = api_gateway["physical_resource_id"]
resp = cfn.describe_stacks(stack_name: stack_id)
stack = resp["stacks"].first
output = stack["outputs"].find { |o| o["output_key"] == "RestApiUrl" }
endpoint = output["output_value"]
puts "API Gateway Endpoint: #{endpoint}"
end
|
#show_custom_domain ⇒ Object
162
163
164
165
166
167
168
169
170
171
|
# File 'lib/jets/cfn/ship.rb', line 162
def show_custom_domain
return unless endpoint_available? && Jets.custom_domain? && Jets.config.domain.route53
domain_name = Jets::Cfn::Resource::ApiGateway::DomainName.new
url = "https://#{domain_name.domain_name}"
puts "Custom Domain: #{url}"
puts "App Domain: https://#{Jets.config.app.domain}" if Jets.config.app.domain
end
|
#stack_options ⇒ Object
options common to both create_stack and update_stack
90
91
92
93
94
95
96
97
|
# File 'lib/jets/cfn/ship.rb', line 90
def stack_options
{
stack_name: @parent_stack_name,
capabilities: capabilities, tags: @tags,
}.merge!(template.stack_option)
end
|
#stack_status ⇒ Object
175
176
177
178
179
|
# File 'lib/jets/cfn/ship.rb', line 175
def stack_status
resp = cfn.describe_stacks(stack_name: @parent_stack_name)
status = resp.stacks[0].stack_status
[resp, status]
end
|
#update_stack ⇒ Object
80
81
82
83
84
85
86
87
|
# File 'lib/jets/cfn/ship.rb', line 80
def update_stack
begin
cfn.update_stack(stack_options)
rescue Aws::CloudFormation::Errors::ValidationError => e
puts "ERROR: #{e.message}".color(:red)
true end
end
|
#upload_to_s3 ⇒ Object
Upload both code and child templates to s3
198
199
200
|
# File 'lib/jets/cfn/ship.rb', line 198
def upload_to_s3
Upload.new.upload
end
|
#wait_for_stack ⇒ Object
check for /(_COMPLETE|_FAILED)$/ status
104
105
106
|
# File 'lib/jets/cfn/ship.rb', line 104
def wait_for_stack
Jets::Cfn::Status.new(@options).wait
end
|