Using redeployment hooks

Overview

Redeployment hooks allow you to achieve continuous deployment by deploying your application whenever you push a change to your Git repository or when your continuous integration pipeline builds successfully.

Cloud 66 offers several methods for achieving continuous integration. Please read our continuous integration guide to compare and select the ideal method to suit your requirements.

Accessing redeployment hooks

A unique redeployment hook URL is automatically generated for each Cloud 66 application. To access it:

1. Open the application from your Dashboard
2. Click on ⚙️ Settings in the left-hand nav
3. Click on Deployment in the sub nav
4. Copy the hook URL from the Redeployment Hook row

You can use the Redeployment Hook URL to trigger automated deployments via your preferred Git or CI service.

Usage example

An example of a standard redeployment hook:

https://hooks.cloud66.com/stacks/redeploy/xxxx/yyyy

Calling a deployment profile via a redeployment hook

Deployment profiles allow you to customise the deployment process depending on your requirements - for example deploying some components and not others. You can also call deployment profiles directly via redeployment hooks using the following syntax:

https://hooks.cloud66.com/stacks/redeploy/xxxx/yyyy/?deployment_profile=name_of_deployment_profile

The name of the profile can be found via your app Dashboard under ⚙️ Settings → Build & Deployment Profiles. If your deployment profile's name has spaces in it, you should replace each space with either + or %20.

Github integration

Users who have signed in through Github (and who have enough access to create and edit deployment events for their applications on GitHub) can activate continuous deployments on GitHub.

To do this: access your Application settings via the toolbelt and set continuous.deploy to true.

$ cx settings set -s my_app_name continuous.deploy true

This will create a new webhook for your repository on GitHub or simply modify an existing one to let Cloud 66 receive deployment events as well.

With this feature enabled, whenever you push a new commit, Cloud 66 will automatically generate a new deployment event based on receiving the push event from GitHub. We will also send deployment status events on different deployment statuses, such as started, canceled, succeeded and failed.

Adding redeployment hooks to your pipeline

The process of adding the hook differs by Git host, so we will guide you through doing this with GitHub, Bitbucket and a generic solution.

GitHub Setup

On your application, click Settings in the right sidebar and then the Information tab. Then copy the URL provided in the Redeployment hook field.

Next, visit your GitHub repository, click Settings in the right sidebar, and then Webhooks & Services in the left sidebar.

In the Webhooks window, click Add webhook and paste the redeployment hook URL into the Payload URL field. When you confirm by clicking Add webhook, GitHub will automatically test your hook with a Ping and you should get a green HTTP200 response.

Bitbucket Setup

On your application, click Settings in the right sidebar and then the Information tab. Then copy the URL provided in the Redeployment hook field.

Next, visit your Bitbucket repository, click Settings in the left sidebar, and then Hooks in the settings menu that appears. In the Select a hook field, select a POST hook, click Add hook and paste your redeployment hook URL into the field provided. Click Save to confirm.

Generic Setup

Most Git providers have a commit hook mechanism that you can use to post to the Cloud 66 redeployment hook URL. Please check your Git provider documentation for this information. If your Git provider has a non-conforming payload format (not compatible with Github or BitBucket formats) then please get in touch and we can extend our payload support!

Invoking your redeployment hook manually

To invoke the redeployment hook manually, you can POST an HTTP request to your redeployment hook URL. You can do this in curl like this:

curl -X POST [your redeployment hook URL]

You can also use your redeployment hook to deploy a specific git ref/SHA as with the following example:

curl -X POST [your redeployment hook URL]?git_ref=...