IBM Cloud Docs
Schematics worker runtime

Schematics worker runtime

The Schematics worker runs your automation workload. The workload is deployed as a Kubernetes job pod that run only one Schematics automation command and self-destructs on completion. All your Schematics command such as schematics plan, schematics apply, schematics run, and schematics destroy runs by using the Schematics worker pods. In addition to the core Terraform CLI and Ansible CLI, the Schematics worker job images include several utilities and executables.

Following are the Schematics type of workers.

Schematics workers types
Worker Description
runtime-terraform-job Used to run the Terraform CLI.
This worker is used to run the Schematics workspace jobs.
runtime-ansible-job Used to run the Ansible playbook CLI.
This worker is used to run the Schematics Action jobs.

The Schematics worker images are built by using the Universal Base Image (UBI-8) as the base image. The Schematics worker images used by the multi-tenant Schematics service instance and the corresponding Schematics agents are not the same.

In the multi-tenant Schematics service instance, your Terraform or Ansible automation cannot install any software or tools in the Schematics worker pods. It is blocked by design.

For more information about deprecation note, see Schematics announcement.

Schematics deprecation note
From date Deprecation notice
21 September 2022 Support for Python v3.6 in runtime-ansible-job is deprecated. Instead the runtime-ansible job image uses Python v3.8.

The following table enlists the preinstalled software and tools in the Schematics worker images.

Runtime-terraform-job image

Schematics runtime terraform job image
Software Versions In agent Description
Terraform CLI 1.0.x, 1.1.x,
1.2.x, 1.3.x, 1.4.x
1.5.x Terraform CLI
Ansible v2.9.27 v2.9.27 For use by the ansible-provisioner for Terraform.
It is recommended to use the Schematics actions to run your Ansible automation.
IBM Cloud CLI Latest Latest Latest version of the IBM Cloud CLI plug-ins are pre-installed. For your Terraform automation, it is recommended to use the Terraform provider plugi-ns for IBM Cloud.
JQ v1.6 Yes As the JSON processor in your Terraform automation.
Kubectl client Yes For use in your Terraform automation. It is recommended to use the Terraform provider plug-ins for Kubernetes.
OpenShift client Yes Red Hat OpenShift CLI for your Terraform automation. It is recommended to use the Terraform provider plug-ins for IBM Cloud and Kubernetes.
Python v3.6 No For use in your Terraform automation.
Python libraries netaddr No Red Hat OpenShift CLI for your Terraform automation. It is recommended to use the Terraform provider plug-ins for IBM Cloud and Kubernetes.

Runtime-ansible-job image

The Schematics actions use the Ansible v2.9.27 in the Ansible-runtime-job image. The current minor version of the Ansible CLI is used in the Schematics.

Schematics runtime ansible job image
Software Versions In agent Description
Ansible v2.9.27 v2.9.27 Ansible CLI
IBM Cloud CLI Latest Latest Latest version of the IBM Cloud CLI plug-ins are pre-installed, to use in your Ansible automation.
JQ v1.6 v1.6 As the JSON processor in your Ansible automation.
Kubectl client Latest Yes For use in your Ansible automation.
OpenShift client Latest Yes Red Hat OpenShift CLI for your Ansible automation.
Python v3.8 v3.8 For use in your Ansible automation.
Python libraries netaddr,
kubernetes,
openshift,
pywinrm,
boto3,
boto,
botocore,
PyVmomi
No For use in your Ansible automation.