Docs Home
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.ContainerWorkerPool
Explore with Pulumi AI
Create, update, or delete a worker pool. For more information, about container worker pool, see adding worker nodes and zones to clusters.
Example Usage
The following example creates the worker pool mypool for the cluster that is named mycluster.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerWorkerPool;
import com.pulumi.ibm.ContainerWorkerPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testaccWorkerpool = new ContainerWorkerPool("testaccWorkerpool", ContainerWorkerPoolArgs.builder()
.workerPoolName("terraform_test_pool")
.machineType("u2c.2x4")
.cluster("my_cluster")
.sizePerZone(1)
.hardware("shared")
.diskEncryption("true")
.labels(Map.of("test", "test-pool"))
.timeouts(ContainerWorkerPoolTimeoutsArgs.builder()
.update("180m")
.build())
.build());
}
}
resources:
testaccWorkerpool:
type: ibm:ContainerWorkerPool
properties:
workerPoolName: terraform_test_pool
machineType: u2c.2x4
cluster: my_cluster
sizePerZone: 1
hardware: shared
diskEncryption: 'true'
labels:
test: test-pool
# User can increase timeouts
timeouts:
- update: 180m
Create the Openshift cluster worker Pool with entitlement:
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const testPool = new ibm.ContainerWorkerPool("testPool", {
cluster: "openshift_cluster_example",
diskEncryption: true,
entitlement: "cloud_pak",
hardware: "shared",
labels: {
test: "oc-pool",
},
machineType: "b3c.4x16",
sizePerZone: 3,
workerPoolName: "test_openshift_wpool",
});
import pulumi
import pulumi_ibm as ibm
test_pool = ibm.ContainerWorkerPool("testPool",
cluster="openshift_cluster_example",
disk_encryption=True,
entitlement="cloud_pak",
hardware="shared",
labels={
"test": "oc-pool",
},
machine_type="b3c.4x16",
size_per_zone=3,
worker_pool_name="test_openshift_wpool")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.NewContainerWorkerPool(ctx, "testPool", &ibm.ContainerWorkerPoolArgs{
Cluster: pulumi.String("openshift_cluster_example"),
DiskEncryption: pulumi.Bool(true),
Entitlement: pulumi.String("cloud_pak"),
Hardware: pulumi.String("shared"),
Labels: pulumi.StringMap{
"test": pulumi.String("oc-pool"),
},
MachineType: pulumi.String("b3c.4x16"),
SizePerZone: pulumi.Float64(3),
WorkerPoolName: pulumi.String("test_openshift_wpool"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var testPool = new Ibm.ContainerWorkerPool("testPool", new()
{
Cluster = "openshift_cluster_example",
DiskEncryption = true,
Entitlement = "cloud_pak",
Hardware = "shared",
Labels =
{
{ "test", "oc-pool" },
},
MachineType = "b3c.4x16",
SizePerZone = 3,
WorkerPoolName = "test_openshift_wpool",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.ContainerWorkerPool;
import com.pulumi.ibm.ContainerWorkerPoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testPool = new ContainerWorkerPool("testPool", ContainerWorkerPoolArgs.builder()
.cluster("openshift_cluster_example")
.diskEncryption("true")
.entitlement("cloud_pak")
.hardware("shared")
.labels(Map.of("test", "oc-pool"))
.machineType("b3c.4x16")
.sizePerZone(3)
.workerPoolName("test_openshift_wpool")
.build());
}
}
resources:
testPool:
type: ibm:ContainerWorkerPool
properties:
cluster: openshift_cluster_example
diskEncryption: 'true'
entitlement: cloud_pak
hardware: shared
labels:
test: oc-pool
machineType: b3c.4x16
sizePerZone: 3
workerPoolName: test_openshift_wpool
Create ContainerWorkerPool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ContainerWorkerPool(name: string, args: ContainerWorkerPoolArgs, opts?: CustomResourceOptions);@overload
def ContainerWorkerPool(resource_name: str,
args: ContainerWorkerPoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ContainerWorkerPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster: Optional[str] = None,
worker_pool_name: Optional[str] = None,
size_per_zone: Optional[float] = None,
machine_type: Optional[str] = None,
hardware: Optional[str] = None,
import_on_create: Optional[bool] = None,
labels: Optional[Mapping[str, str]] = None,
entitlement: Optional[str] = None,
operating_system: Optional[str] = None,
orphan_on_delete: Optional[bool] = None,
region: Optional[str] = None,
resource_group_id: Optional[str] = None,
disk_encryption: Optional[bool] = None,
taints: Optional[Sequence[ContainerWorkerPoolTaintArgs]] = None,
timeouts: Optional[ContainerWorkerPoolTimeoutsArgs] = None,
container_worker_pool_id: Optional[str] = None)func NewContainerWorkerPool(ctx *Context, name string, args ContainerWorkerPoolArgs, opts ...ResourceOption) (*ContainerWorkerPool, error)public ContainerWorkerPool(string name, ContainerWorkerPoolArgs args, CustomResourceOptions? opts = null)
public ContainerWorkerPool(String name, ContainerWorkerPoolArgs args)
public ContainerWorkerPool(String name, ContainerWorkerPoolArgs args, CustomResourceOptions options)
type: ibm:ContainerWorkerPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ContainerWorkerPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ContainerWorkerPoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ContainerWorkerPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ContainerWorkerPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ContainerWorkerPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var containerWorkerPoolResource = new Ibm.ContainerWorkerPool("containerWorkerPoolResource", new()
{
Cluster = "string",
WorkerPoolName = "string",
SizePerZone = 0,
MachineType = "string",
Hardware = "string",
ImportOnCreate = false,
Labels =
{
{ "string", "string" },
},
Entitlement = "string",
OperatingSystem = "string",
OrphanOnDelete = false,
ResourceGroupId = "string",
DiskEncryption = false,
Taints = new[]
{
new Ibm.Inputs.ContainerWorkerPoolTaintArgs
{
Effect = "string",
Key = "string",
Value = "string",
},
},
Timeouts = new Ibm.Inputs.ContainerWorkerPoolTimeoutsArgs
{
Update = "string",
},
ContainerWorkerPoolId = "string",
});
example, err := ibm.NewContainerWorkerPool(ctx, "containerWorkerPoolResource", &ibm.ContainerWorkerPoolArgs{
Cluster: pulumi.String("string"),
WorkerPoolName: pulumi.String("string"),
SizePerZone: pulumi.Float64(0),
MachineType: pulumi.String("string"),
Hardware: pulumi.String("string"),
ImportOnCreate: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Entitlement: pulumi.String("string"),
OperatingSystem: pulumi.String("string"),
OrphanOnDelete: pulumi.Bool(false),
ResourceGroupId: pulumi.String("string"),
DiskEncryption: pulumi.Bool(false),
Taints: ibm.ContainerWorkerPoolTaintArray{
&ibm.ContainerWorkerPoolTaintArgs{
Effect: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Timeouts: &ibm.ContainerWorkerPoolTimeoutsArgs{
Update: pulumi.String("string"),
},
ContainerWorkerPoolId: pulumi.String("string"),
})
var containerWorkerPoolResource = new ContainerWorkerPool("containerWorkerPoolResource", ContainerWorkerPoolArgs.builder()
.cluster("string")
.workerPoolName("string")
.sizePerZone(0)
.machineType("string")
.hardware("string")
.importOnCreate(false)
.labels(Map.of("string", "string"))
.entitlement("string")
.operatingSystem("string")
.orphanOnDelete(false)
.resourceGroupId("string")
.diskEncryption(false)
.taints(ContainerWorkerPoolTaintArgs.builder()
.effect("string")
.key("string")
.value("string")
.build())
.timeouts(ContainerWorkerPoolTimeoutsArgs.builder()
.update("string")
.build())
.containerWorkerPoolId("string")
.build());
container_worker_pool_resource = ibm.ContainerWorkerPool("containerWorkerPoolResource",
cluster="string",
worker_pool_name="string",
size_per_zone=0,
machine_type="string",
hardware="string",
import_on_create=False,
labels={
"string": "string",
},
entitlement="string",
operating_system="string",
orphan_on_delete=False,
resource_group_id="string",
disk_encryption=False,
taints=[{
"effect": "string",
"key": "string",
"value": "string",
}],
timeouts={
"update": "string",
},
container_worker_pool_id="string")
const containerWorkerPoolResource = new ibm.ContainerWorkerPool("containerWorkerPoolResource", {
cluster: "string",
workerPoolName: "string",
sizePerZone: 0,
machineType: "string",
hardware: "string",
importOnCreate: false,
labels: {
string: "string",
},
entitlement: "string",
operatingSystem: "string",
orphanOnDelete: false,
resourceGroupId: "string",
diskEncryption: false,
taints: [{
effect: "string",
key: "string",
value: "string",
}],
timeouts: {
update: "string",
},
containerWorkerPoolId: "string",
});
type: ibm:ContainerWorkerPool
properties:
cluster: string
containerWorkerPoolId: string
diskEncryption: false
entitlement: string
hardware: string
importOnCreate: false
labels:
string: string
machineType: string
operatingSystem: string
orphanOnDelete: false
resourceGroupId: string
sizePerZone: 0
taints:
- effect: string
key: string
value: string
timeouts:
update: string
workerPoolName: string
ContainerWorkerPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ContainerWorkerPool resource accepts the following input properties:
- Cluster string
- The name or ID of the cluster where you want to enable or disable the feature.
- Machine
Type string - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- Size
Per doubleZone - The number of worker nodes per zone that you want to add to the worker pool.
- Worker
Pool stringName - worker pool name
- Container
Worker stringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - Disk
Encryption bool - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- Entitlement string
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - Hardware string
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - Import
On boolCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- Labels Dictionary<string, string>
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- Operating
System string - The operating system of the workers in the worker pool.
- Orphan
On boolDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- Region string
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- Resource
Group stringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - Taints
List<Container
Worker Pool Taint> A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- Timeouts
Container
Worker Pool Timeouts
- Cluster string
- The name or ID of the cluster where you want to enable or disable the feature.
- Machine
Type string - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- Size
Per float64Zone - The number of worker nodes per zone that you want to add to the worker pool.
- Worker
Pool stringName - worker pool name
- Container
Worker stringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - Disk
Encryption bool - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- Entitlement string
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - Hardware string
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - Import
On boolCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- Labels map[string]string
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- Operating
System string - The operating system of the workers in the worker pool.
- Orphan
On boolDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- Region string
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- Resource
Group stringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - Taints
[]Container
Worker Pool Taint Args A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- Timeouts
Container
Worker Pool Timeouts Args
- cluster String
- The name or ID of the cluster where you want to enable or disable the feature.
- machine
Type String - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- size
Per DoubleZone - The number of worker nodes per zone that you want to add to the worker pool.
- worker
Pool StringName - worker pool name
- container
Worker StringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk
Encryption Boolean - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement String
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware String
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import
On BooleanCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels Map<String,String>
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- operating
System String - The operating system of the workers in the worker pool.
- orphan
On BooleanDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region String
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource
Group StringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - taints
List<Container
Worker Pool Taint> A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts
Container
Worker Pool Timeouts
- cluster string
- The name or ID of the cluster where you want to enable or disable the feature.
- machine
Type string - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- size
Per numberZone - The number of worker nodes per zone that you want to add to the worker pool.
- worker
Pool stringName - worker pool name
- container
Worker stringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk
Encryption boolean - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement string
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware string
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import
On booleanCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels {[key: string]: string}
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- operating
System string - The operating system of the workers in the worker pool.
- orphan
On booleanDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region string
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource
Group stringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - taints
Container
Worker Pool Taint[] A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts
Container
Worker Pool Timeouts
- cluster str
- The name or ID of the cluster where you want to enable or disable the feature.
- machine_
type str - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- size_
per_ floatzone - The number of worker nodes per zone that you want to add to the worker pool.
- worker_
pool_ strname - worker pool name
- container_
worker_ strpool_ id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk_
encryption bool - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement str
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware str
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import_
on_ boolcreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels Mapping[str, str]
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- operating_
system str - The operating system of the workers in the worker pool.
- orphan_
on_ booldelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region str
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource_
group_ strid - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - taints
Sequence[Container
Worker Pool Taint Args] A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts
Container
Worker Pool Timeouts Args
- cluster String
- The name or ID of the cluster where you want to enable or disable the feature.
- machine
Type String - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- size
Per NumberZone - The number of worker nodes per zone that you want to add to the worker pool.
- worker
Pool StringName - worker pool name
- container
Worker StringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk
Encryption Boolean - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement String
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware String
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import
On BooleanCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels Map<String>
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- operating
System String - The operating system of the workers in the worker pool.
- orphan
On BooleanDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region String
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource
Group StringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - taints List<Property Map>
A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the ContainerWorkerPool resource produces the following output properties:
- Autoscale
Enabled bool - (Bool) Autoscaling is enabled on the workerpool
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- State string
- (String) The state of the worker pool.
- Worker
Pool stringId - (String) The unique identifier of the worker pool.
- Zones
List<Container
Worker Pool Zone> - List - A list of zones that are attached to the worker pool.
- Autoscale
Enabled bool - (Bool) Autoscaling is enabled on the workerpool
- Id string
- The provider-assigned unique ID for this managed resource.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- State string
- (String) The state of the worker pool.
- Worker
Pool stringId - (String) The unique identifier of the worker pool.
- Zones
[]Container
Worker Pool Zone - List - A list of zones that are attached to the worker pool.
- autoscale
Enabled Boolean - (Bool) Autoscaling is enabled on the workerpool
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- state String
- (String) The state of the worker pool.
- worker
Pool StringId - (String) The unique identifier of the worker pool.
- zones
List<Container
Worker Pool Zone> - List - A list of zones that are attached to the worker pool.
- autoscale
Enabled boolean - (Bool) Autoscaling is enabled on the workerpool
- id string
- The provider-assigned unique ID for this managed resource.
- resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- state string
- (String) The state of the worker pool.
- worker
Pool stringId - (String) The unique identifier of the worker pool.
- zones
Container
Worker Pool Zone[] - List - A list of zones that are attached to the worker pool.
- autoscale_
enabled bool - (Bool) Autoscaling is enabled on the workerpool
- id str
- The provider-assigned unique ID for this managed resource.
- resource_
controller_ strurl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- state str
- (String) The state of the worker pool.
- worker_
pool_ strid - (String) The unique identifier of the worker pool.
- zones
Sequence[Container
Worker Pool Zone] - List - A list of zones that are attached to the worker pool.
- autoscale
Enabled Boolean - (Bool) Autoscaling is enabled on the workerpool
- id String
- The provider-assigned unique ID for this managed resource.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- state String
- (String) The state of the worker pool.
- worker
Pool StringId - (String) The unique identifier of the worker pool.
- zones List<Property Map>
- List - A list of zones that are attached to the worker pool.
Look up Existing ContainerWorkerPool Resource
Get an existing ContainerWorkerPool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ContainerWorkerPoolState, opts?: CustomResourceOptions): ContainerWorkerPool@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
autoscale_enabled: Optional[bool] = None,
cluster: Optional[str] = None,
container_worker_pool_id: Optional[str] = None,
disk_encryption: Optional[bool] = None,
entitlement: Optional[str] = None,
hardware: Optional[str] = None,
import_on_create: Optional[bool] = None,
labels: Optional[Mapping[str, str]] = None,
machine_type: Optional[str] = None,
operating_system: Optional[str] = None,
orphan_on_delete: Optional[bool] = None,
region: Optional[str] = None,
resource_controller_url: Optional[str] = None,
resource_group_id: Optional[str] = None,
size_per_zone: Optional[float] = None,
state: Optional[str] = None,
taints: Optional[Sequence[ContainerWorkerPoolTaintArgs]] = None,
timeouts: Optional[ContainerWorkerPoolTimeoutsArgs] = None,
worker_pool_id: Optional[str] = None,
worker_pool_name: Optional[str] = None,
zones: Optional[Sequence[ContainerWorkerPoolZoneArgs]] = None) -> ContainerWorkerPoolfunc GetContainerWorkerPool(ctx *Context, name string, id IDInput, state *ContainerWorkerPoolState, opts ...ResourceOption) (*ContainerWorkerPool, error)public static ContainerWorkerPool Get(string name, Input<string> id, ContainerWorkerPoolState? state, CustomResourceOptions? opts = null)public static ContainerWorkerPool get(String name, Output<String> id, ContainerWorkerPoolState state, CustomResourceOptions options)resources: _: type: ibm:ContainerWorkerPool get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Autoscale
Enabled bool - (Bool) Autoscaling is enabled on the workerpool
- Cluster string
- The name or ID of the cluster where you want to enable or disable the feature.
- Container
Worker stringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - Disk
Encryption bool - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- Entitlement string
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - Hardware string
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - Import
On boolCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- Labels Dictionary<string, string>
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- Machine
Type string - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- Operating
System string - The operating system of the workers in the worker pool.
- Orphan
On boolDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- Region string
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- Resource
Group stringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - Size
Per doubleZone - The number of worker nodes per zone that you want to add to the worker pool.
- State string
- (String) The state of the worker pool.
- Taints
List<Container
Worker Pool Taint> A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- Timeouts
Container
Worker Pool Timeouts - Worker
Pool stringId - (String) The unique identifier of the worker pool.
- Worker
Pool stringName - worker pool name
- Zones
List<Container
Worker Pool Zone> - List - A list of zones that are attached to the worker pool.
- Autoscale
Enabled bool - (Bool) Autoscaling is enabled on the workerpool
- Cluster string
- The name or ID of the cluster where you want to enable or disable the feature.
- Container
Worker stringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - Disk
Encryption bool - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- Entitlement string
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - Hardware string
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - Import
On boolCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- Labels map[string]string
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- Machine
Type string - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- Operating
System string - The operating system of the workers in the worker pool.
- Orphan
On boolDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- Region string
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- Resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- Resource
Group stringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - Size
Per float64Zone - The number of worker nodes per zone that you want to add to the worker pool.
- State string
- (String) The state of the worker pool.
- Taints
[]Container
Worker Pool Taint Args A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- Timeouts
Container
Worker Pool Timeouts Args - Worker
Pool stringId - (String) The unique identifier of the worker pool.
- Worker
Pool stringName - worker pool name
- Zones
[]Container
Worker Pool Zone Args - List - A list of zones that are attached to the worker pool.
- autoscale
Enabled Boolean - (Bool) Autoscaling is enabled on the workerpool
- cluster String
- The name or ID of the cluster where you want to enable or disable the feature.
- container
Worker StringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk
Encryption Boolean - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement String
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware String
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import
On BooleanCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels Map<String,String>
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- machine
Type String - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- operating
System String - The operating system of the workers in the worker pool.
- orphan
On BooleanDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region String
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- resource
Group StringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - size
Per DoubleZone - The number of worker nodes per zone that you want to add to the worker pool.
- state String
- (String) The state of the worker pool.
- taints
List<Container
Worker Pool Taint> A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts
Container
Worker Pool Timeouts - worker
Pool StringId - (String) The unique identifier of the worker pool.
- worker
Pool StringName - worker pool name
- zones
List<Container
Worker Pool Zone> - List - A list of zones that are attached to the worker pool.
- autoscale
Enabled boolean - (Bool) Autoscaling is enabled on the workerpool
- cluster string
- The name or ID of the cluster where you want to enable or disable the feature.
- container
Worker stringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk
Encryption boolean - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement string
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware string
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import
On booleanCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels {[key: string]: string}
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- machine
Type string - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- operating
System string - The operating system of the workers in the worker pool.
- orphan
On booleanDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region string
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource
Controller stringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- resource
Group stringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - size
Per numberZone - The number of worker nodes per zone that you want to add to the worker pool.
- state string
- (String) The state of the worker pool.
- taints
Container
Worker Pool Taint[] A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts
Container
Worker Pool Timeouts - worker
Pool stringId - (String) The unique identifier of the worker pool.
- worker
Pool stringName - worker pool name
- zones
Container
Worker Pool Zone[] - List - A list of zones that are attached to the worker pool.
- autoscale_
enabled bool - (Bool) Autoscaling is enabled on the workerpool
- cluster str
- The name or ID of the cluster where you want to enable or disable the feature.
- container_
worker_ strpool_ id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk_
encryption bool - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement str
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware str
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import_
on_ boolcreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels Mapping[str, str]
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- machine_
type str - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- operating_
system str - The operating system of the workers in the worker pool.
- orphan_
on_ booldelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region str
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource_
controller_ strurl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- resource_
group_ strid - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - size_
per_ floatzone - The number of worker nodes per zone that you want to add to the worker pool.
- state str
- (String) The state of the worker pool.
- taints
Sequence[Container
Worker Pool Taint Args] A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts
Container
Worker Pool Timeouts Args - worker_
pool_ strid - (String) The unique identifier of the worker pool.
- worker_
pool_ strname - worker pool name
- zones
Sequence[Container
Worker Pool Zone Args] - List - A list of zones that are attached to the worker pool.
- autoscale
Enabled Boolean - (Bool) Autoscaling is enabled on the workerpool
- cluster String
- The name or ID of the cluster where you want to enable or disable the feature.
- container
Worker StringPool Id - (String) The unique identifier of the worker pool in the format
<cluster_name_id>/<worker_pool_id>. Note To reference the worker pool ID in other resources use below interpolation syntax. For example,: ${element(split("/",ibm_container_worker_pool.testacc_workerpool.id),1)} - disk
Encryption Boolean - Optional-If set to true, the worker node disks are set up with an AES 256-bit encryption. If set to false, the disk encryption for the worker node is disabled. For more information, see Encrypted disks.Yes.
- entitlement String
- If you purchased an IBM Cloud Cloud Pak that includes an entitlement to run worker nodes that are installed with OpenShift Container Platform, enter
entitlementto create your worker pool with that entitlement so that you are not charged twice for the OpenShift license. Note that this option can be set only when you create the worker pool. After the worker pool is created, the cost for the OpenShift license automates when you add worker nodes to your worker pool. Note It is set only for the first time creation of the worker pool, modification in the further executes will not have any impacts. Set this argument tocloud_pakonly if you use this cluster with a cloud pak that has an OpenShift entitlement. - hardware String
- The level of hardware isolation for your worker node. Use
dedicatedto have available physical resources dedicated to you only, orsharedto allow physical resources to be shared with other IBM customers. This option is available for virtual machine worker node flavors only. - import
On BooleanCreate - Import an existing WorkerPool from the cluster, instead of creating a new.
- labels Map<String>
- A list of labels that you want to add to your worker pool. The labels can help you find the worker pool more easily later.
- machine
Type String - The machine type for your worker node. The machine type determines the amount of memory, CPU, and disk space that is available to the worker node. For an overview of supported machine types, see Planning your worker node setup.
- operating
System String - The operating system of the workers in the worker pool.
- orphan
On BooleanDelete Orphan the Worker Pool resource, instead of deleting it. The argument allows the user to remove the worker pool from the state, without deleting the actual cloud resource. The worker pool can be re-imported into the state using the
import_on_createargument.Deprecated reference
- region String
- The region where the cluster is provisioned. If the region is not specified it will be defaulted to provider region(IC_REGION/IBMCLOUD_REGION). To get the list of supported regions please access this link and use the alias.
- resource
Controller StringUrl - The URL of the IBM Cloud dashboard that can be used to explore and view details about this cluster
- resource
Group StringId - The ID of the resource group where your cluster is provisioned into. To list resource groups, run
ibmcloud resource groupsor use theibm.ResourceGroupdata source. - size
Per NumberZone - The number of worker nodes per zone that you want to add to the worker pool.
- state String
- (String) The state of the worker pool.
- taints List<Property Map>
A nested block that sets or removes Kubernetes taints for all worker nodes in a worker pool
Nested scheme for
taints:- timeouts Property Map
- worker
Pool StringId - (String) The unique identifier of the worker pool.
- worker
Pool StringName - worker pool name
- zones List<Property Map>
- List - A list of zones that are attached to the worker pool.
Supporting Types
ContainerWorkerPoolTaint, ContainerWorkerPoolTaintArgs
ContainerWorkerPoolTimeouts, ContainerWorkerPoolTimeoutsArgs
- Update string
- Update string
- update String
- update string
- update str
- update String
ContainerWorkerPoolZone, ContainerWorkerPoolZoneArgs
- Private
Vlan string - (String) The ID of the private VLAN that is used in the zone.
- Public
Vlan string - (String) The ID of the public VLAN that is used in the zone.
- Worker
Count double - (Integer) The number of worker nodes that are attached to the zone.
- Zone string
- (String) The name of the zone.
- Private
Vlan string - (String) The ID of the private VLAN that is used in the zone.
- Public
Vlan string - (String) The ID of the public VLAN that is used in the zone.
- Worker
Count float64 - (Integer) The number of worker nodes that are attached to the zone.
- Zone string
- (String) The name of the zone.
- private
Vlan String - (String) The ID of the private VLAN that is used in the zone.
- public
Vlan String - (String) The ID of the public VLAN that is used in the zone.
- worker
Count Double - (Integer) The number of worker nodes that are attached to the zone.
- zone String
- (String) The name of the zone.
- private
Vlan string - (String) The ID of the private VLAN that is used in the zone.
- public
Vlan string - (String) The ID of the public VLAN that is used in the zone.
- worker
Count number - (Integer) The number of worker nodes that are attached to the zone.
- zone string
- (String) The name of the zone.
- private_
vlan str - (String) The ID of the private VLAN that is used in the zone.
- public_
vlan str - (String) The ID of the public VLAN that is used in the zone.
- worker_
count float - (Integer) The number of worker nodes that are attached to the zone.
- zone str
- (String) The name of the zone.
- private
Vlan String - (String) The ID of the private VLAN that is used in the zone.
- public
Vlan String - (String) The ID of the public VLAN that is used in the zone.
- worker
Count Number - (Integer) The number of worker nodes that are attached to the zone.
- zone String
- (String) The name of the zone.
Import
The ibm_container_worker_pool can be imported by using cluster_name_id, worker_pool_id.
Example
$ pulumi import ibm:index/containerWorkerPool:ContainerWorkerPool example mycluster/5c4f4d06e0dc402084922dea70850e3b-7cafe35
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibmTerraform Provider.