Class: EY::Serverside::DeployBase
- Defined in:
- lib/engineyard-serverside/deploy.rb
Direct Known Subclasses
Instance Attribute Summary
Attributes inherited from Task
Instance Method Summary collapse
- #abort_on_bad_paths_in_release_directory ⇒ Object
- #bundle ⇒ Object
- #cached_deploy ⇒ Object
- #callback(what) ⇒ Object
- #check_dependencies ⇒ Object
- #check_repository ⇒ Object
-
#clean_release_directory(dir, count) ⇒ Object
Remove all but the most-recent
count
releases from the specified release directory. -
#cleanup_old_releases ⇒ Object
task.
-
#copy_repository_cache ⇒ Object
task.
- #create_revision_file ⇒ Object
- #create_revision_file_command ⇒ Object
-
#deploy ⇒ Object
default task.
- #disable_maintenance_page ⇒ Object
- #enable_maintenance_page ⇒ Object
- #ensure_git_ssh_wrapper ⇒ Object
- #ensure_ownership(*targets) ⇒ Object
- #gc_repository_cache ⇒ Object
-
#generate_ssh_wrapper ⇒ Object
We specify ‘IdentitiesOnly’ to avoid failures on systems with > 5 private keys available.
- #install_dependencies ⇒ Object
-
#migrate ⇒ Object
task.
-
#move_symlink(source, link, name) ⇒ Object
Move a symlink as atomically as we can.
- #new_release(&block) ⇒ Object
-
#push_code ⇒ Object
task.
- #rails_application? ⇒ Boolean
-
#restart ⇒ Object
task.
- #restart_command ⇒ Object
- #restart_with_maintenance_page ⇒ Object
-
#rollback ⇒ Object
task.
- #run_with_callbacks(task) ⇒ Object
- #setup_services ⇒ Object
- #setup_sqlite3_if_necessary ⇒ Object
- #short_log_message(revision) ⇒ Object
- #source ⇒ Object
-
#ssh_executable ⇒ Object
create ssh wrapper on all servers.
-
#symlink ⇒ Object
task.
- #symlink_configs ⇒ Object
- #symlink_tasks ⇒ Object
- #unchanged_diff_between_revisions?(previous_revision, active_revision, asset_dependencies) ⇒ Boolean
- #update_repository_cache ⇒ Object
Methods inherited from Task
#initialize, #load_ey_yml, #paths, #require_custom_tasks, #roles, #run, #sudo
Constructor Details
This class inherits a constructor from EY::Serverside::Task
Instance Method Details
#abort_on_bad_paths_in_release_directory ⇒ Object
211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/engineyard-serverside/deploy.rb', line 211 def abort_on_bad_paths_in_release_directory shell.substatus "Checking for disruptive files in #{paths.releases}" bad_paths = paths.all_releases.reject do |path| path.basename.to_s =~ /^[\d]+$/ end if bad_paths.any? shell.fatal "Bad paths found in #{paths.releases}:\n\t#{bad_paths.join("\n\t")}\nStoring files in this directory will disrupt latest_release, diff detection, rollback, and possibly other features." raise end end |
#bundle ⇒ Object
93 94 95 |
# File 'lib/engineyard-serverside/deploy.rb', line 93 def bundle install_dependencies end |
#cached_deploy ⇒ Object
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 53 54 55 56 57 58 59 |
# File 'lib/engineyard-serverside/deploy.rb', line 21 def cached_deploy shell.status "Deploying app from cached copy at #{Time.now.asctime}" load_ey_yml require_custom_tasks push_code shell.status "Starting full deploy" new_release do callback(:before_deploy) check_repository create_revision_file run_with_callbacks(:bundle) setup_services symlink_configs setup_sqlite3_if_necessary run_with_callbacks(:compile_assets) # defined in RailsAssetSupport enable_maintenance_page run_with_callbacks(:migrate) callback(:before_symlink) # We don't use run_with_callbacks for symlink because we need # to clean up manually if it fails. symlink end callback(:after_symlink) run_with_callbacks(:restart) disable_maintenance_page cleanup_old_releases gc_repository_cache callback(:after_deploy) shell.status "Finished deploy at #{Time.now.asctime}" rescue Exception => e shell.status "Finished failing to deploy at #{Time.now.asctime}" shell.error "Exception during deploy: #{e.inspect}\n#{e.backtrace}" puts_deploy_failure raise end |
#callback(what) ⇒ Object
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/engineyard-serverside/deploy.rb', line 398 def callback(what) @callbacks_reached ||= true if paths.deploy_hook(what).exist? shell.status "Running deploy hook: deploy/#{what}.rb" run Escape.shell_command(base_callback_command_for(what)) do |server, cmd| per_instance_args = [] per_instance_args << '--current-roles' << server.roles.to_a.join(' ') per_instance_args << '--current-name' << server.name.to_s if server.name per_instance_args << '--config' << config.to_json cmd << " " << Escape.shell_command(per_instance_args) end elsif paths.executable_deploy_hook(what).executable? shell.status "Running deploy hook: deploy/#{what}" run [About.hook_executor, what.to_s].join(' ') do |server, cmd| cmd = hook_env_vars(server).reject{|k,v| v.nil?}.map{|k,v| "#{k}=#{Escape.shell_command([v])}" }.join(' ') + ' ' + config.framework_envs + ' ' + cmd end elsif paths.executable_deploy_hook(what).exist? shell.warning "Skipping possible deploy hook deploy/#{what} because it is not executable." end end |
#check_dependencies ⇒ Object
85 86 87 |
# File 'lib/engineyard-serverside/deploy.rb', line 85 def check_dependencies dependency_manager.check end |
#check_repository ⇒ Object
81 82 83 |
# File 'lib/engineyard-serverside/deploy.rb', line 81 def check_repository check_dependencies end |
#clean_release_directory(dir, count) ⇒ Object
Remove all but the most-recent count
releases from the specified release directory. IMPORTANT: This expects the release directory naming convention to be something with a sensible lexical order. Violate that at your peril.
203 204 205 206 207 208 209 |
# File 'lib/engineyard-serverside/deploy.rb', line 203 def clean_release_directory(dir, count) @cleanup_failed = true ordinal = count.succ.to_s shell.status "Cleaning release directory: #{dir}" sudo "ls -r #{dir} | tail -n +#{ordinal} | xargs -I@ rm -rf #{dir}/@" @cleanup_failed = false end |
#cleanup_old_releases ⇒ Object
task
189 190 191 192 193 194 195 196 197 |
# File 'lib/engineyard-serverside/deploy.rb', line 189 def cleanup_old_releases count = config.keep_releases.to_i if count < 1 shell.error "Refusing to delete all releases! keep_releases must be >= 1 (got #{count})" count = EY::Serverside::Deploy::Configuration::DEFAULT_KEEP_RELEASES shell.warning "Running instead with default value for keep_releases: #{count}" end clean_release_directory(paths.releases, count) end |
#copy_repository_cache ⇒ Object
task
274 275 276 277 278 279 |
# File 'lib/engineyard-serverside/deploy.rb', line 274 def copy_repository_cache paths.new_release! shell.status "Copying to #{paths.active_release}" exclusions = Array(config.copy_exclude).map { |e| %|--exclude="#{e}"| }.join(' ') run("mkdir -p #{paths.active_release} #{paths.shared_config} && rsync -aq #{exclusions} #{paths.repository_cache}/ #{paths.active_release}") end |
#create_revision_file ⇒ Object
281 282 283 |
# File 'lib/engineyard-serverside/deploy.rb', line 281 def create_revision_file run create_revision_file_command end |
#create_revision_file_command ⇒ Object
69 70 71 |
# File 'lib/engineyard-serverside/deploy.rb', line 69 def create_revision_file_command source.create_revision_file_command(paths.active_revision) end |
#deploy ⇒ Object
default task
15 16 17 18 19 |
# File 'lib/engineyard-serverside/deploy.rb', line 15 def deploy shell.status "Starting deploy at #{shell.start_time.asctime}" update_repository_cache cached_deploy end |
#disable_maintenance_page ⇒ Object
113 114 115 |
# File 'lib/engineyard-serverside/deploy.rb', line 113 def disable_maintenance_page maintenance.conditionally_disable end |
#enable_maintenance_page ⇒ Object
109 110 111 |
# File 'lib/engineyard-serverside/deploy.rb', line 109 def enable_maintenance_page maintenance.conditionally_enable end |
#ensure_git_ssh_wrapper ⇒ Object
153 154 155 |
# File 'lib/engineyard-serverside/deploy.rb', line 153 def ensure_git_ssh_wrapper ENV['GIT_SSH'] = ssh_executable.to_s end |
#ensure_ownership(*targets) ⇒ Object
383 384 385 |
# File 'lib/engineyard-serverside/deploy.rb', line 383 def ensure_ownership(*targets) sudo %|find #{targets.join(' ')} \\( -not -user #{config.user} -or -not -group #{config.group} \\) -exec chown #{config.user}:#{config.group} "{}" +| end |
#gc_repository_cache ⇒ Object
65 66 67 |
# File 'lib/engineyard-serverside/deploy.rb', line 65 def gc_repository_cache source.gc_repository_cache if config.gc? end |
#generate_ssh_wrapper ⇒ Object
We specify ‘IdentitiesOnly’ to avoid failures on systems with > 5 private keys available. We set UserKnownHostsFile to /dev/null because StrickHostKeyChecking no doesn’t ignore existing entries in known_hosts; we want to actively ignore all such. Learned this at lists.mindrot.org/pipermail/openssh-unix-dev/2009-February/027271.html (Thanks Jim L.)
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/engineyard-serverside/deploy.rb', line 172 def generate_ssh_wrapper path = paths.ssh_wrapper <<-SCRIPT mkdir -p #{path.dirname} [ -x #{path} ] || cat > #{path} <<'SSH' #!/bin/sh unset SSH_AUTH_SOCK # Filter command mangling by git when using `GIT_SSH` and the string `plink` command=$(echo "$*" | sed -e "s/^-batch //") ssh -o CheckHostIP=no -o StrictHostKeyChecking=no -o PasswordAuthentication=no -o LogLevel=INFO -o IdentityFile=#{paths.deploy_key} -o IdentitiesOnly=yes ${command} SSH chmod 0700 #{path} SCRIPT end |
#install_dependencies ⇒ Object
97 98 99 |
# File 'lib/engineyard-serverside/deploy.rb', line 97 def install_dependencies dependency_manager.install end |
#migrate ⇒ Object
task
254 255 256 257 258 259 260 261 262 |
# File 'lib/engineyard-serverside/deploy.rb', line 254 def migrate return unless config.migrate? @migrations_reached = true cmd = "cd #{paths.active_release} && PATH=#{paths.binstubs}:$PATH #{config.framework_envs} #{config.migration_command}" roles :app_master, :solo do shell.status "Migrating: #{cmd}" run(cmd) end end |
#move_symlink(source, link, name) ⇒ Object
Move a symlink as atomically as we can.
mv -T renames ‘next’ to ‘current’ instead of moving ‘next’ to current/next’ mv -T isn’t available on OS X and maybe elsewhere, so fallback to rm && ln
391 392 393 394 395 396 |
# File 'lib/engineyard-serverside/deploy.rb', line 391 def move_symlink(source, link, name) next_link = link.dirname.join(name) mv_t = "ln -nfs #{source} #{next_link} && mv -T #{next_link} #{link} >/dev/null 2>&1" rm_ln = "rm -rf #{next_link} #{link} && ln -nfs #{source} #{link}" "((#{mv_t}) || (#{rm_ln}))" end |
#new_release(&block) ⇒ Object
264 265 266 267 268 269 270 271 |
# File 'lib/engineyard-serverside/deploy.rb', line 264 def new_release(&block) copy_repository_cache with_failed_release_cleanup do shell.status "Ensuring proper ownership." ensure_ownership(paths.active_release) block.call end end |
#push_code ⇒ Object
task
124 125 126 127 128 129 |
# File 'lib/engineyard-serverside/deploy.rb', line 124 def push_code shell.status "Pushing code to all servers" servers.remote.run_for_each do |server| server.sync_directory_command(paths.repository_cache) end end |
#rails_application? ⇒ Boolean
89 90 91 |
# File 'lib/engineyard-serverside/deploy.rb', line 89 def rails_application? dependency_manager.rails_version end |
#restart ⇒ Object
task
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/engineyard-serverside/deploy.rb', line 132 def restart @restart_failed = true if config.restart_groups.to_i > 1 shell.status "Restarting app servers in #{config.restart_groups.to_i} groups" else shell.status "Restarting app servers" end servers.roles(:app_master, :app, :solo).in_groups(config.restart_groups.to_i) do |group| shell.substatus "Restarting #{group.size} server#{group.size == 1 ? '' : 's'}" group.run(restart_command) end shell.status "Finished restarting app servers" @restart_failed = false end |
#restart_command ⇒ Object
149 150 151 |
# File 'lib/engineyard-serverside/deploy.rb', line 149 def restart_command %{LANG="en_US.UTF-8" /engineyard/bin/app_#{config.app} deploy} end |
#restart_with_maintenance_page ⇒ Object
101 102 103 104 105 106 107 |
# File 'lib/engineyard-serverside/deploy.rb', line 101 def restart_with_maintenance_page load_ey_yml require_custom_tasks enable_maintenance_page restart disable_maintenance_page end |
#rollback ⇒ Object
task
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
# File 'lib/engineyard-serverside/deploy.rb', line 226 def rollback if config.rollback_paths! begin load_ey_yml require_custom_tasks rolled_back_release = paths.latest_release shell.status "Rolling back to previous release: #{(config.active_revision)}" abort_on_bad_paths_in_release_directory run_with_callbacks(:symlink) sudo "rm -rf #{rolled_back_release}" bundle shell.status "Restarting with previous release." enable_maintenance_page run_with_callbacks(:restart) disable_maintenance_page shell.status "Finished rollback at #{Time.now.asctime}" rescue Exception shell.status "Failed to rollback at #{Time.now.asctime}" puts_deploy_failure raise end else shell.fatal "Already at oldest release, nothing to roll back to." exit(1) end end |
#run_with_callbacks(task) ⇒ Object
117 118 119 120 121 |
# File 'lib/engineyard-serverside/deploy.rb', line 117 def run_with_callbacks(task) callback("before_#{task}") send(task) callback("after_#{task}") end |
#setup_services ⇒ Object
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/engineyard-serverside/deploy.rb', line 285 def setup_services shell.status "Setting up external services." previously_configured_services = config.configured_services begin sudo(config.services_check_command) rescue EY::Serverside::RemoteFailure shell.info "Could not setup services. Upgrade your environment to get services configuration." return end begin sudo(config.services_setup_command) rescue EY::Serverside::RemoteFailure => e if previously_configured_services shell.warning <<-WARNING External services configuration not updated. Using previous version. Deploy again if your services configuration appears incomplete or out of date. #{e} WARNING end end if services = config.configured_services shell.status "Services configured: #{services.join(', ')}" dependency_manager.show_ey_config_instructions end end |
#setup_sqlite3_if_necessary ⇒ Object
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 |
# File 'lib/engineyard-serverside/deploy.rb', line 314 def setup_sqlite3_if_necessary if dependency_manager.uses_sqlite3? shell.status "Setting up SQLite3 Database for compatibility with application's chosen adapter" shell.warning "SQLite3 cannot persist across servers. Please upgrade to a supported database." shell.substatus "Create databases directory if needed" run "mkdir -p #{paths.shared}/databases" shell.substatus "Create SQLite database if needed" run "touch #{paths.shared}/databases/#{config.framework_env}.sqlite3" shell.substatus "Create config directory if needed" run "mkdir -p #{paths.active_release_config}" shell.substatus "Generating SQLite config" run <<-WRAP cat > #{paths.shared_config}/database.sqlite3.yml<<'YML' #{config.framework_env}: adapter: sqlite3 database: #{paths.shared}/databases/#{config.framework_env}.sqlite3 pool: 5 timeout: 5000 YML WRAP shell.substatus "Symlink database.yml" run "ln -nfs #{paths.shared_config}/database.sqlite3.yml #{paths.active_release_config}/database.yml" end end |
#short_log_message(revision) ⇒ Object
73 74 75 |
# File 'lib/engineyard-serverside/deploy.rb', line 73 def (revision) source.(revision) end |
#source ⇒ Object
422 423 424 425 |
# File 'lib/engineyard-serverside/deploy.rb', line 422 def source ensure_git_ssh_wrapper @source ||= config.source(shell) end |
#ssh_executable ⇒ Object
create ssh wrapper on all servers
158 159 160 161 162 163 164 165 |
# File 'lib/engineyard-serverside/deploy.rb', line 158 def ssh_executable @ssh_executable ||= begin roles :app_master, :app, :solo, :util do run(generate_ssh_wrapper) end paths.ssh_wrapper end end |
#symlink ⇒ Object
task
371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/engineyard-serverside/deploy.rb', line 371 def symlink shell.status "Symlinking code." run move_symlink(paths.active_release, paths.current, "deploying") ensure_ownership(paths.current) @symlink_changed = true rescue Exception sudo move_symlink(paths.previous_release(paths.active_release), paths.current, "reverting") ensure_ownership(paths.current) @symlink_changed = false raise end |
#symlink_configs ⇒ Object
344 345 346 347 348 349 350 |
# File 'lib/engineyard-serverside/deploy.rb', line 344 def symlink_configs shell.status "Preparing shared resources for release." symlink_tasks.each do |what, cmd| shell.substatus what run(cmd) end end |
#symlink_tasks ⇒ Object
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 |
# File 'lib/engineyard-serverside/deploy.rb', line 352 def symlink_tasks [ ["Set group write permissions", "chmod -R g+w #{paths.active_release}"], ["Remove public/system if symlinked", "if [ -L \"#{paths.public_system}\" ]; then rm -rf #{paths.public_system}; fi"], ["Remove symlinked shared directories", "rm -rf #{paths.active_log} #{paths.active_release}/tmp/pids"], ["Create tmp directory", "mkdir -p #{paths.active_release}/tmp"], ["Create public directory", "mkdir -p #{paths.public}"], ["Create config directory", "mkdir -p #{paths.active_release_config}"], ["Symlink shared log directory", "ln -nfs #{paths.shared_log} #{paths.active_log}"], ["Symlink public system directory", "if [ ! -e \"#{paths.public_system}\" ]; then ln -ns #{paths.shared_system} #{paths.public_system}; fi"], ["Symlink shared pids directory", "ln -nfs #{paths.shared}/pids #{paths.active_release}/tmp/pids"], ["Symlink other shared config files", "find #{paths.shared_config} -maxdepth 1 -type f -not -name 'database.yml' -exec ln -s {} #{paths.active_release_config} \\;"], ["Symlink database.yml if needed", "if [ -f \"#{paths.shared_config}/database.yml\" ]; then ln -nfs #{paths.shared_config}/database.yml #{paths.active_release_config}/database.yml; fi"], ["Symlink newrelic.yml if needed", "if [ -f \"#{paths.shared_config}/newrelic.yml\" ]; then ln -nfs #{paths.shared_config}/newrelic.yml #{paths.active_release_config}/newrelic.yml; fi"], ["Symlink mongrel_cluster.yml if needed", "if [ -f \"#{paths.shared_config}/mongrel_cluster.yml\" ]; then ln -nfs #{paths.shared_config}/mongrel_cluster.yml #{paths.active_release_config}/mongrel_cluster.yml; fi"], ] end |
#unchanged_diff_between_revisions?(previous_revision, active_revision, asset_dependencies) ⇒ Boolean
77 78 79 |
# File 'lib/engineyard-serverside/deploy.rb', line 77 def unchanged_diff_between_revisions?(previous_revision, active_revision, asset_dependencies) source.same?(previous_revision, active_revision, asset_dependencies) end |
#update_repository_cache ⇒ Object
61 62 63 |
# File 'lib/engineyard-serverside/deploy.rb', line 61 def update_repository_cache source.update_repository_cache end |