catalog/openshift-client

OpenShift Client Task

OpenShift is a Kubernetes distribution from Red Hat which provides oc, the OpenShift CLI that complements kubectl for simplifying deployment and configuration applications on OpenShift.

There are two tasks provided for the OpenShift CLI which differ only in their target clusters:

• openshift-client: runs commands against the cluster where the task run is being executed
• openshift-client-kubecfg: runs commands against any cluster that is provided to it as an input

Install the Tasks

Install openshift-client task:

kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-client/openshift-client-task.yaml

Install openshift-client-kubecfg task:

kubectl apply -f https://raw.githubusercontent.com/tektoncd/catalog/master/openshift-client/openshift-client-kubecfg-task.yaml

Inputs openshift-client

Parameters

• ARGS: args to execute which are appended to oc e.g. start-build myapp (default: help)

• SCRIPT: script of oc commands to execute e.g. oc get pod $1 -0 yaml This will take the first value of ARGS as pod name (default: oc $@)

Inputs openshift-client-kubecfg

Parameters

• ARGS: args to execute which are appended to oc e.g. start-build myapp (default: help)

• SCRIPT: script of oc commands to execute e.g. oc get pod $1 -o yaml This will take the first value of ARGS as pod name (default: oc $@)

Resources

• cluster: a cluster-type PipelineResource specifying the target OpenShift cluster to execute the commands against it

ServiceAccount

If you don't specify a service account to be used for running the TaskRun or PipelineRun, the default service account. OpenShift by default does not allow the default service account to modify objects in the namespace. Therefore you should either explicitly grant permission to the default service account (by creating rolebindings) or create a new service account with sufficient privileges and specify it on the TaskRun or PipelineRun.

You can do the former via oc and running the following command, replacing <namespace> with your target namespace:

oc policy add-role-to-user edit -z default -n <namespace>

Usage

This TaskRun runs an oc rollout command to deploy the latest image version for myapp on OpenShift.

apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  name: deploy-myapp
spec:
  taskRef:
    name: openshift-client
  params:
  - name: ARGS
    value:
      - "rollout"
      - "latest"
      - "myapp"

The following TaskRun runs the commands against a different cluster than the one the TaskRun is running on. The cluster credentials are provided via a PipelineResource called stage-cluster.

apiVersion: tekton.dev/v1beta1
kind: TaskRun
metadata:
  name: deploy-myapp-stage
spec:
  taskRef:
    name: openshift-client-kubecfg
  resources:
    inputs:
    - name: cluster
      resourceRef:
        name: stage-cluster
  params:
  - name: ARGS
    value:
      - "rollout"
      - "latest"
      - "myapp"