Track OpenShift API Objects in Git

This repository delivers two shell scripts to you, that allow you to easily maintain your OpenShift API object in Git.

Installation

On most Linux systems, where /usr/local/bin is in your $PATH, just run

./install.sh

Otherwise you have to manually add symlinks of following files to your $PATH:

• oc-sync-git -> oc-sync-git.sh
• oc-edit -> oc-edit.sh
• oc-apply -> oc-apply.sh

Usage

When using the default install script, three commands should be available to you system wide:

• oc-sync-git will export all OpenShift API objects but secrets of your current active project to the api-objects.yaml file and create a git commit if changes occur
• oc-edit will
  • first call oc-sync-git to gather all externally made changes
  • second open an editor for changing all your OpenShift API objects but secrets
  • finally call oc-sync-git again to commit your changes to Git
• oc-apply will import the previously exported API objects to the current logged in OpenShift project again

To setup a new project you need to fullfill following prerequisites:

• Having an OpenShift project meaningfully containing some API objects
• Having the oc binary installed and beeing logged into the cluster and project
• Beeing inside the (empty) git repository clone you want the API objects being committed to

Then you can call

• oc-edit whenenver you want to edit the API objects and commit them to git
• oc-sync-git whenever you have intentionally made changes to your OpenShift project 'from outside' and want to commit them to git

None of the scripts will do a git push. This you have to do explicitly!

Use the oc-apply to import the objects back to the current OpenShift project.

Using labels

The scripts oc-sync-git and oc-edit support labels. With labels you can commit just parts of your OpenShift project to the git repository. An example:

oc-sync-git app=myapplication

.