Webhooks and Action Hooks

Overview

This topic reviews the differences in webhooks and action hooks between OpenShift version 2 (v2) and OpenShift version 3 (v3) and how to migrate these applications into the v3 environment.

Webhooks

  1. After creating a **BuildConfig** from a GitHub repository, run:

    1. $ oc describe bc/<name-of-your-BuildConfig>

    This will output a webhook GitHub URL that looks like:

    1. <https://api.starter-us-east-1.openshift.com:443/oapi/v1/namespaces/nsname/buildconfigs/bcname/webhooks/secret/github>.

  2. Cut and paste this URL into GitHub, from the GitHub web console.

  3. In your GitHub repository, select Add Webhook from Settings → Webhooks & Services.

  4. Paste the URL output (similar to above) into the Payload URL field.

  5. Set the Content Type to application/json.

  6. Click Add webhook.

You should see a message from GitHub stating that your webhook was successfully configured.

Now, whenever you push a change to your GitHub repository, a new build will automatically start, and upon a successful build a new deployment will start.

If you delete or recreate your application, you will have to update the Payload URL field in GitHub with the new BuildConfig webhook url.

Action Hooks

In OpenShift version 2 (v2), there are build, deploy, post_deploy, and pre_build scripts or action_hooks that are located in the .openshift/action_hooks directory. While there is no one-to-one mapping of function for these in v3, the S2I tool in v3 does have the option of adding customizable scripts, either in a designated URL or in the .s2i/bin directory of your source repository.

OpenShift version 3 (v3) also offers a post-build hook for running basic testing of an image after it is built and before it is pushed to the registry. Deployment hooks are configured in the deployment configuration.

In v2, action_hooks are commonly used to set up environment variables. In v2, any environment variables should be passed with:

  1. $ oc new-app <source-url> -e ENV_VAR=env_var

or:

  1. $ oc new-app <template-name> -p ENV_VAR=env_var

Also, environment variables can be added or changed using:

  1. $ oc set env dc/<name-of-dc>
  2. ENV_VAR1=env_var1 ENV_VAR2=env_var2’