Skip to content

private_worker_integration.md

Latest commit

 

History

History
51 lines (34 loc) · 4.01 KB

private_worker_integration.md

File metadata and controls

51 lines (34 loc) · 4.01 KB
copyright
years
2015, 2026
lastupdated 2026-05-08
keywords tool integrations, IBM Cloud Public, Delivery Pipeline Private Worker
subcollection ContinuousDelivery

{{site.data.keyword.attribute-definition-list}}

Configuring {{site.data.keyword.deliverypipeline}} Private Worker

{: #privateworker}

{{site.data.keyword.contdelivery_short}} will be discontinued in the following regions on 12 February 2027: au-syd, ca-mon, ca-tor, us-east. Code Risk Analyzer and {{site.data.keyword.DRA_short}} will also be deprecated in all regions on that date. However, if a region has no active usage of these features, the features in that region may be discontinued earlier and stop accepting new instances. Learn more {: important}

{{site.data.keyword.deliverypipeline}} Private Worker connects with one or more private workers that run {{site.data.keyword.deliverypipeline}} workloads in isolation. {: shortdesc}

Configure the {{site.data.keyword.deliverypipeline}} Private Worker tool integration to make private workers available to pipelines in a toolchain:

  1. If you are configuring this tool integration as you are creating the toolchain, in the Configurable Integrations section, click {{site.data.keyword.deliverypipeline}} Private Worker.

  2. If you have a toolchain and are adding this tool integration to it, from the {{site.data.keyword.cloud_notm}} console, click the Menu icon hamburger icon > Platform Automation > Toolchains. On the Toolchains page, click the toolchain to open its Overview page.

    a. Click Add tool.

    b. In the Tool Integrations section, click {{site.data.keyword.deliverypipeline}} Private Worker.

  3. Type a name for the tool integration. This name identifies a pool of private workers in the Workers tab of the pipeline stage.

  4. 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.

  5. Click Create Integration.

  6. From your toolchain, on the Delivery pipelines card, click the {{site.data.keyword.deliverypipeline}} 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 {{site.data.keyword.deliverypipeline}} Private Worker by using the API

{: #private-worker-config-parameters}

The {{site.data.keyword.deliverypipeline}} Private Worker tool integration supports the following configuration parameters that you can use with the Toolchain HTTP API and SDKs{: external} when you create{: external}, read{: external}, and update{: external} tool integrations.

You must specify the tool_type_id property in the request body with the private_worker value. {: important}

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 {{site.data.keyword.contdelivery_short}}.
workerQueueIdentifier optional, updatable String worker_queue_identifier The service ID that identifies the run request queue for this private worker.
{: caption="{{site.data.keyword.deliverypipeline}} Private Worker tool integration parameters" caption-side="bottom"}