Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reload/deployotron
Reload! deploy script
https://github.com/reload/deployotron
drush-commands
Last synced: 4 months ago
JSON representation
Reload! deploy script
- Host: GitHub
- URL: https://github.com/reload/deployotron
- Owner: reload
- Archived: true
- Created: 2013-12-10T09:34:28.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2018-11-23T09:51:16.000Z (almost 6 years ago)
- Last Synced: 2024-07-21T05:37:16.670Z (4 months ago)
- Topics: drush-commands
- Language: PHP
- Homepage: http://reload.github.io/deployotron
- Size: 561 KB
- Stars: 25
- Watchers: 18
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.txt
Awesome Lists containing this project
README
Deployotron
===========
Deployotron is a Drush command to simplify deploying new code to a
Drupal site.
There's already a lot of ways to deploy ones Drupal site, from FTPing
up the files to having Capistrano deploy the site when the build
passes in Jenkins. Deployotron aims to be simple to use, but also
usable as a part of a bigger setup.
[](https://travis-ci.org/reload/deployotron)
[](https://scrutinizer-ci.com/g/reload/deployotron/)
[](https://scrutinizer-ci.com/g/reload/deployotron/)
Overview
========
In order to keep things simple, we're working with a few assumptions:
That the code is in GIT, and that the root of the site is checked in.
That you can run Drush commands and GIT on the live webserver and the
root of the site on the webserver is a git checkout, and
That you've set up Drush aliases to reach the live webserver.
For everyone's sanity, we suggest having a Drush alias file in
`sites/all/drush/.aliases.drushrc.php` that defines
relevant environments (production, dev, etc.), so that everybody is
using the same settings.
And we suggest that deployotron is installed by copying it into the
`sites/all/drush` folder and committed to the site repository. This
ensures that everyone is running the exact same version of deployotron
when deploying.
Setup
=====
Clone Deployotron into `sites/all/drush`.
Create a `.aliases.drushrc.php` file in the same directory,
with the definition of the different environments.
Deployotron is configured for each alias by adding an array of options
in the `'deployotron'` key of the alias array (see the example later,
if that didn't make any sense). All the double-dash options the deploy
command takes can be specified this way, and it's recommended to at
least define the `'branch'` option to select a default branch to
deploy.
Initialize the environments by doing an initial git clone of the
codebase in the destination directories.
Usage
=====
Deploying
---------
To run the deployment, use a command like:
/var/www/site$ drush deploy @alias
To get a listing of all supported command line options, do a `drush
help deploy`.
Example configuration:
$aliases['staging'] = array(
'remote-host' => 'example.com',
'remote-user' => 'deploy_user',
'uri' => 'default',
'root' => '/path',
'deployotron' => array(
'branch' => 'develop',
'dump-dir' => '/backups', // Defaults to /tmp.
'num-dumps' => 3, // Defaults to 5. 0 for unlimited.
'post-deploy' => array(
'sudo apache2 graceful',
'drush -y fra',
),
),
);
As demonstrated, you can add external commands to be run before (pre-)
or after (post-) the individual actions. All the possible options is
listed in `drush help deploy` and `drush deployotron-actions`.
In addition to command line options you can add messages to be
displayed to the deploying user by using the following keys:
* `message`: Shown at confirmation and after deployment.
* `confirm_message`: Shown at confirmation.
* `done_message`: Shown after deployment.
* `confirm_message_`: Shown at confirmation for the
``.
* `done_message_`: Shown after deployment for the
``.
These can be useful to remind the user of extra manual steps, or other
things they should be aware.
Recovering
----------
In case everything goes to hell after a deployment, you can do another
deployment using a known good revision, or use:
/var/www/site$ drush omg @alias
This will try to find recent database dumps, ask which to use and
attempt to import the database and revert the codebase to the previous
revision. It will not attempt to clear caches or restarting any
services.
Help
----
Running `drush deployotron-actions` will give a full list of which
commands uses which actions, and the options of all actions.
Sudo setup
==========
To run sudo commands in pre/post hooks, you need to configure sudo to
allow the command without a password.
Run:
sudo visudo -f /etc/sudoers.d/deployotron
And add something like following to the file (replacing `deploy_user`
with the `remote-user` of the alias used for deployment):
deploy_user ALL=(root) NOPASSWD: /usr/sbin/service apache2 graceful,/usr/sbin/service varnish restart
This allows deployotron to run "sudo service apache2 graceful" and
"sudo service varnish restart".