The Cloud Platform user interface automates the most common tasks involved in developing a Drupal application: deploying code from a version control system, and migrating code, databases, and files across your development, staging, and production environments. Cloud Hooks are scripts in your code repository Cloud Platform executes on your behalf when a triggering action occurs. With Cloud Hooks, you can automate other tasks, including the following:
Your Cloud Hooks are located in your Cloud Platform code repository. Each branch
of your repository has a docroot
directory with your application’s source
code. Cloud Hooks are in the hooks
directory next to docroot
, not
inside of docroot
.
You can find the Cloud Hooks directory structure, sample hook scripts, and documentation at https://github.com/acquia/cloud-hooks. To start using Cloud Hooks with your application, copy the current version of the Cloud Hooks repository on GitHub into your Cloud Platform repository.
Using Git, you can copy the Cloud Hooks repository with the following commands:
cd /my/repo
curl -L -o hooks.tar.gz https://github.com/acquia/cloud-hooks/tarball/master
tar xzf hooks.tar.gz
mv acquia-cloud-hooks-* hooks
git add hooks
git commit -m 'Import Cloud hooks directory and sample scripts.'
git push
You must set the Unix executable bit for Hook scripts to allow Cloud Platform to run them. Although scripts with the executable bit already set when initially added to your repository will retain the executable bit, you must run the following commands to set the executable bit for files already in your Git repository:
chmod a+x ./my-hook.sh
git add ./my-hook.sh
git commit -m 'Add executable bit to my-hook.sh'
git push
To demonstrate the power of Cloud Hooks in action, you can run a “Hello, Cloud!” script when deploying new code in your development environment after installing Cloud Hooks. To do this, complete the following steps:
Note
The following example assumes that your development environment is running the master branch.
Install the hello-world.sh
script to run on code deployments to
development.
cd /my/repo
git checkout master
cp hooks/samples/hello-world.sh hooks/dev/post-code-deploy
git commit -a 'Run the hello-world script on post-code-deploy to Dev.'
git push
Sign in to the Cloud Platform user interface, and then select your application.
In the Dev environment code section, click the code switch button and select the master branch. If your Dev environment is already running master, select any other tag, and then select master again.
Click Continue.
Click Switch to confirm the switch to the master branch.
View the task log. After the code deployment task completes, click its Details link to view the hook’s output. The output will appear similar to the following example:
Started
Updating s1.dev to deploy master
Deploying master on s1.dev
[05:28:33] Starting hook: post-code-deploy
Executing: /var/www/html/s1.dev/hooks/dev/post-code-deploy/hello-world.sh
s1 dev master master [email protected]:s1.git git (as [email protected])
Hello, Cloud!
[05:28:34] Finished hook: post-code-deploy
You can use the code switch button on the Environments page to restore your development environment to an already-deployed branch.
If you have a Cloud Platform Enterprise application with a Remote Administration (RA) environment, Cloud Hooks in the RA environment may result in unexpected behaviors or task failures, which can cause the RA automated update process to fail. For more information, see Deploy hooks.
If your application uses both Live Development and Cloud Hooks, you may encounter Cloud Hooks triggered on your environment using Live Development, if that environment uses the same Git branch as another environment you’re developing in.
For complete documentation about Cloud Hooks and the latest sample and community-contributed hook scripts, visit https://github.com/acquia/cloud-hooks. By browsing the GitHub repository, you can do the following tasks:
For more information about how some Cloud Platform users have taken advantage of Cloud Hooks, see Using Cloud Hooks on Cloud Platform Hosting.