Wednesday, January 4, 2017

OpenShift Origin template for GitLab Runner

OpenShift Origin template for GitLab Runner

his is a template for easy deployment of GitLab Runner CI into OpenShift cluster



  1. Create new project/namespace
    oc login -u developer
    oc new-project prj-gitlab-runner
  2. Import template
    oc create -f -n prj-gitlab-runner
  3. Setup Security Context Constraints (SCC) for service accounts used for running containers (anyuid means commands inside containers can run as root)
    oc login -u system:admin
    oc adm policy add-scc-to-user anyuid -z sa-gitlab-runner -n prj-gitlab-runner
    oc adm policy add-scc-to-user anyuid -z sa-minio -n prj-gitlab-runner
  4. Go to web console https://MASTER-IP:8443/console/project/prj-gitlab-runner/overview (where MASTER-IP is IP where cluster is bound) and press "Add to Project" and select "gitlab-runner" template
  5. Fill required fields
    • GitLab Runner Token : one from /etc/gitlab-runner/config.toml
    • GitLab Runners Namespace : prj-gitlab-runner
  6. As well there are some additional options you may configure - docker hub tags for GitLab-Runner and Minio, login/password for Minio etc, though defaults will work as well
  7. After pressing update the deployment will start, it may take few minutes to download required images and preconfigure them
  8. In your Gitlab Project check "Runners" page to have runner activated
  9. Run some CI job , there will be something like
    Waiting for pod prj-gitlab-runner/runner-86251ae3-project-1142978-concurrent-0uzqax to be running, status is Pending
    in log output of CI

Persistent cache in directory of your host (optional)

Minio server is not attached to any permanent storage and uses an ephemeral storage - emptyDir. When Minio Service/Pod is stopped or restarted all data will be deleted. Though, while Minio is running, cache is available locally via some path like '/var/lib/origin/openshift.local.volumes/pods/de1d0ff7-d2bb-11e6-8d5b-74d02b8fa488/volumes/'
So, you may need to point vol-minio-data-store volume to persistent storage or periodically backup data.
While you can use any storage - NFC/Ceph RDB/GlusterFS and more, for simple cluster setup (with small number of nodes) host path is the simplest. Though if you have more then one Node you should mantain cleanup/sync between nodes by self.
Next steps allow to use local directory /cache/gitlab-runner as storage for Minio
  1. Setup Security Context Constraints (SCC) for Minio container to access Node's filesystem
    oc login -u system:admin
    oc adm policy add-scc-to-user hostmount-anyuid -z sa-minio -n prj-gitlab-runner
  2. Edit dc-minio-service deployment config via OpenSift Web console at https://MASTER-IP:8443/console/project/prj-gitlab-runner/edit/yaml?kind=DeploymentConfig&name=dc-minio-service or from console
    oc project prj-gitlab-runner
    oc edit dc/dc-minio-service
        - emptyDir: {}
          name: vol-minio-data-store
        - hostPath: 
            path: /cache/gitlab-runner
          name: vol-minio-data-store
    After saving, Minio server will be automatically restarted and you can access cache via Minio Web console http://minio-service.prj-gitlab-runner.svc.cluster.local/minio/bkt-gitlab-runner/, you can try to upload file and check if it exists at the /cache/gitlab-runner as well you can force new deploy (restart) of minio and see if it keeps files on restart


  • You can additionally configure gitlab runner via web console at https://MASTER-IP:8443/console/project/prj-gitlab-runner/browse/config-maps/cm-gitlab-runner , by example count of concurent jobs etc, see all possible options at GitLab Runner docs.
    Alternatively you can use console for editing:
    oc project prj-gitlab-runner
    oc edit configmap/cm-gitlab-runner
    After editing you will need to manually "Deploy" gitlab-runner deployment - https://MASTER-IP:8443/console/project/prj-gitlab-runner/browse/dc/dc-gitlab-runner-service or via console
    oc project prj-gitlab-runner
    oc deploy dc-gitlab-runner-service --latest --follow=true
  • Minio Web console is available at http://minio-service.prj-gitlab-runner.svc.cluster.local/ or just grab IP under https://MASTER-IP:8443/console/project/prj-gitlab-runner/browse/services/minio-service and access/secret keys under https://MASTER-IP:8443/console/project/prj-gitlab-runner/browse/dc/dc-minio-service?tab=environment
Source :

No comments:

Post a Comment