Openshift Pods Driver

Selecting the openshift pods driver adds the following options to the providers section of the configuration.

Type: list

The Openshift Pods driver is similar to the Openshift driver, but it only supports pod label. This enables using an unprivileged service account that doesn’t require the self-provisioner role.


  - name: cluster
    driver: openshiftpods
    context: unprivileged-context-name
      - name: main
          - name: openshift-pod
providers.[openshiftpods].context (required)

Name of the context configured in kube/config.

Before using the driver, Nodepool services need a kube/config file manually installed. Make sure the context is present in oc config get-contexts command output.

Default: 3

The number of times to retry launching a pod before considering the job failed.

Default: infinite
Type: int

Maximum number of pods that can be used.

Type: list

A pool defines a group of resources from an Openshift provider.

providers.[openshiftpods] (required)

The project’s (namespace) name that will be used to create the pods.

Type: dict

A dictionary of key-value pairs that will be stored with the node data in ZooKeeper. The keys and values can be any arbitrary string.

Type: list

Each entry in a pool`s labels section indicates that the corresponding label is available for use in this pool.

Each entry is a dictionary with the following keys

providers.[openshiftpods] (required)

Identifier for this label; references an entry in the labels section.


The image name.

Default: IfNotPresent
Type: str

The ImagePullPolicy, can be IfNotPresent, Always or Never.

Type: int

The number of cpu to request for the pod.

Type: int

The amount of memory in MB to request for the pod.

providers.[openshiftpods].labels.:type: str
providers.[openshiftpods].labels.:default: auto

The path of the default python interpreter. Used by Zuul to set ansible_python_interpreter. The special value auto will direct Zuul to use inbuilt Ansible logic to select the interpreter on Ansible >=2.8, and default to /usr/bin/python2 for earlier versions.

Default: sh
Type: str

The shell type of the node’s default shell executable. Used by Zuul to set ansible_shell_type. This setting should only be used

  • For a windows pod with the experimental connection-type ssh, in which case cmd or powershell should be set and reflect the node’s DefaultShell configuration.

  • If the default shell is not Bourne compatible (sh), but instead e.g. csh or fish, and the user is aware that there is a long-standing issue with ansible_shell_type in combination with become

Default: []
Type: list

A list of environment variables to pass to the Pod.

providers.[openshiftpods] (required)
Type: str

The name of the environment variable passed to the Pod.

providers.[openshiftpods].labels.env.value (required)
Type: str

The value of the environment variable passed to the Pod.

Type: dict

A map of key-value pairs to ensure the OpenShift scheduler places the Pod on a node with specific node labels.