This integration sends a notification every time a deployment is made in an OpenShift instance.

1. Create the channel you'd like to use for OpenShift notifications.

2. Download and install our Python bindings and example scripts on the system where the OpenShift integration script will be run from.

3. Then, create a new commit including all the changes made to the repository, and push it to your app.

4. After that, connect to the application through SSH. If you don’t know how to do this, log in to your OpenShift Online account, go to your application’s dashboard, and click Want to log in to your application?. There you’ll find the app’s SSH user, address, and further information on SSH, in case you need it.

   

5. Open /usr/local/share/zulip/integrations/openshift/zulip_openshift_config.py with your favorite editor, and change the following lines to specify the email address and API key for your OpenShift bot:

   ZULIP_USER = "openshift-bot@chat.zulip.org"
   ZULIP_API_KEY = "0123456789abcdef0123456789abcdef"
   ZULIP_SITE = "https://chat.zulip.org"
   

6. You can also specify which pushes will result in notifications and to what stream the notifications will be sent by modifying the deployment_notice_destination function in zulip_openshift_config.py. By default, deployments triggered by commits pushed to the main, master, and test-post-receive branches will result in a notification to stream deployments.

7. Save the file, and symlink $OPENSHIFT_PYTHON_DIR/virtenv/share/zulip/integrations/openshift/post-receive into the ~/app-root/repo/.openshift/action_hooks directory.

8. Whenever you make a push to the main branch of your application’s repository (or whichever branch you configured above), or if you force a deployment, the Zulip OpenShift plugin will send an automated notification.

You're done! Your OpenShift notifications may look like this:

Testing

You can test the plugin without changing your main branch by pushing to the test-post-receive branch.