Configuring Delivery Pipeline Private Worker

Delivery Pipeline Private Worker connects with one or more private workers that run Delivery Pipeline workloads in isolation.

Configure the Delivery Pipeline Private Worker tool integration to make private workers available to pipelines in a toolchain:

If you are configuring this tool integration as you are creating the toolchain, in the Configurable Integrations section, click Delivery Pipeline Private Worker.
If you have a toolchain and are adding this tool integration to it, from the IBM Cloud console, click the Menu icon > Platform Automation > Toolchains. On the Toolchains page, click the toolchain to open its Overview page. Alternatively, on your app's Overview page, on the Continuous delivery card, click View toolchain. Then, click Overview.

a. Click Add tool.

b. In the Tool Integrations section, click Delivery Pipeline Private Worker.
Type a name for the tool integration. This name identifies a pool of private workers in the Workers tab of the pipeline stage.
Type your Service ID API key to authenticate access to the work queue where one or more private workers can look for work. If you don't have a Service ID API key, click Create to generate one for this private worker.
Click Create Integration.
From your toolchain, on the Delivery pipelines card, click the Delivery Pipeline Private Worker to view a list of all of the workers that are registered by using an API key that is associated with this Service ID.

Configuring Delivery Pipeline Private Worker by using the API

The Delivery Pipeline Private Worker tool integration supports the following configuration parameters that you can use with the Toolchain HTTP API and SDKs when you create, read, and update tool integrations.

You must specify the tool_type_id property in the request body with the private_worker value.

Delivery Pipeline Private Worker tool integration parameters
Parameter	Usage	Type	Terraform argument	Description
name	required, updatable	String	name	The name of this tool integration.
workerQueueCredentials	required, updatable	Password	worker_queue_credentials	The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information about secret references, see Protecting your sensitive data in Continuous Delivery.
workerQueueIdentifier	optional, updatable	String	worker_queue_identifier	The service ID that identifies the run request queue for this private worker.