Disclaimer

Your use of this download is governed by Stonebranch’s Terms of Use, which are available at Stonebranch Integration Hub - Terms of Use.

Overview

OpenShift Jobs in the context of Kubernetes are resources designed for running finite tasks or batch jobs. They create and manage pods to execute these tasks, ensuring completion and termination upon success. Commonly used for operations like batch processing or periodic tasks.

This integration acts as an interface to OpenShift CLI (oc) enabling users to trigger the execution of OpenShift Jobs from the Universal Controller. OpenShift CLI (oc) is bundled within this integration and does not require separate installation.

Version Information

Template Name	Extension Name	Version	Status
OpenShift Jobs	ue-openshift-jobs	1 (Current 1.2.0)	Fixes and new Features are introduced.

Refer to the Changelog for version history information.

Key Features

Feature	Description
Run OpenShift Jobs	Run a single OpenShift Job using a resource file or a job resource URL and monitor its completion.
Delete OpenShift Jobs	Jobs can be deleted automatically after completion, manually during runtime, or as a single action.
Authentication Options	The supported authentication methods are Basic Authentication, Session Token Authentication, and Webconsole Token Authentication.
Containerization Support	Integration can be deployed on agents that live inside an OpenShift cluster.
Container Log Retrieval	Option to retrieve logs for all containers pertaining to a specific job.

Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Area	Details
Universal Agent & Python version	Requires Python version 3.11, 3.9 or 3.7. Only Agents of version >= 7.5 are supported.
Universal Controller	Universal Controller Version >= 7.5.0.0.
OpenShift and OpenShift CLI	This integration is bundled with Openshift CLI version 4.13.14, removing the need for manual installation of it. It is tested against the same OpenShift version. It should be compatible with later versions as long as backward compatibility is preserved.
Network and Connectivity	Connectivity towards OpenShift.

Supported Actions

Action: Run Job

The “Run Job” Action is used to run a job using a specific Job Resource Definition representing the definition of an OpenShift Job. The job definition resource can be a UC script, a local job definition file, or a URL pointing to a job definition.

Configuration examples

Scenario A

Connect to a local OpenShift server with basic authentication, select the project “my_project” and run a job by applying a locally stored job definition. After, start the job poll for the job’s status for 10 poll cycles. If the job fails, retrieve container logs and print them to standard output.

Scenario B

Connect to a local OpenShift server using a session token, select the project “my_project” and run a job by applying a job definition saved as a UC script. After starting the job, poll for the job’s status till it finishes, and then delete it. If the job gets stuck, the dynamic command "Delete Job" can be used to delete the job from the cluster.