Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SatelliteClusterWorkerPool
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SatelliteClusterWorkerPool

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create, update, or delete the Satellite cluster worker pool. The worker pool will be attached to the specified clusterIBM Cloud Satellite Cluster Worker Pool.

    Example Usage

    Create satellite cluster worker pool

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  createClusterWp:
    type: ibm:SatelliteClusterWorkerPool
    properties:
      cluster: ${var.cluster}
      workerCount: ${var.worker_count}
      resourceGroupId: ${data.ibm_resource_group.rg.id}
      dynamic:
        - forEach: ${var.zones}
          content:
            - id: ${zones.value}
      hostLabels: ${var.host_labels}

    Create satellite cluster worker pool without workers

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  createClusterWp:
    type: ibm:SatelliteClusterWorkerPool
    properties:
      cluster: ${data.ibm_satellite_cluster.read_cluster.id}
      dynamic:
        - forEach: ${var.zones}
          content:
            - id: ${zones.value}

    Create SatelliteClusterWorkerPool Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SatelliteClusterWorkerPool(name: string, args: SatelliteClusterWorkerPoolArgs, opts?: CustomResourceOptions);
    @overload
def SatelliteClusterWorkerPool(resource_name: str,
                               args: SatelliteClusterWorkerPoolArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def SatelliteClusterWorkerPool(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               cluster: Optional[str] = None,
                               disk_encryption: Optional[bool] = None,
                               entitlement: Optional[str] = None,
                               flavor: Optional[str] = None,
                               host_labels: Optional[Sequence[str]] = None,
                               isolation: Optional[str] = None,
                               name: Optional[str] = None,
                               operating_system: Optional[str] = None,
                               resource_group_id: Optional[str] = None,
                               satellite_cluster_worker_pool_id: Optional[str] = None,
                               timeouts: Optional[SatelliteClusterWorkerPoolTimeoutsArgs] = None,
                               worker_count: Optional[float] = None,
                               worker_pool_labels: Optional[Mapping[str, str]] = None,
                               zones: Optional[Sequence[SatelliteClusterWorkerPoolZoneArgs]] = None)
    func NewSatelliteClusterWorkerPool(ctx *Context, name string, args SatelliteClusterWorkerPoolArgs, opts ...ResourceOption) (*SatelliteClusterWorkerPool, error)
    public SatelliteClusterWorkerPool(string name, SatelliteClusterWorkerPoolArgs args, CustomResourceOptions? opts = null)
    public SatelliteClusterWorkerPool(String name, SatelliteClusterWorkerPoolArgs args)
public SatelliteClusterWorkerPool(String name, SatelliteClusterWorkerPoolArgs args, CustomResourceOptions options)

    type: ibm:SatelliteClusterWorkerPool
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 SatelliteClusterWorkerPoolArgs
    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 SatelliteClusterWorkerPoolArgs
    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 SatelliteClusterWorkerPoolArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SatelliteClusterWorkerPoolArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SatelliteClusterWorkerPoolArgs
    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 satelliteClusterWorkerPoolResource = new Ibm.SatelliteClusterWorkerPool("satelliteClusterWorkerPoolResource", new()
{
    Cluster = "string",
    DiskEncryption = false,
    Entitlement = "string",
    Flavor = "string",
    HostLabels = new[]
    {
        "string",
    },
    Isolation = "string",
    Name = "string",
    OperatingSystem = "string",
    ResourceGroupId = "string",
    SatelliteClusterWorkerPoolId = "string",
    Timeouts = new Ibm.Inputs.SatelliteClusterWorkerPoolTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
    WorkerCount = 0,
    WorkerPoolLabels = 
    {
        { "string", "string" },
    },
    Zones = new[]
    {
        new Ibm.Inputs.SatelliteClusterWorkerPoolZoneArgs
        {
            Id = "string",
        },
    },
});

    example, err := ibm.NewSatelliteClusterWorkerPool(ctx, "satelliteClusterWorkerPoolResource", &ibm.SatelliteClusterWorkerPoolArgs{
	Cluster:        pulumi.String("string"),
	DiskEncryption: pulumi.Bool(false),
	Entitlement:    pulumi.String("string"),
	Flavor:         pulumi.String("string"),
	HostLabels: pulumi.StringArray{
		pulumi.String("string"),
	},
	Isolation:                    pulumi.String("string"),
	Name:                         pulumi.String("string"),
	OperatingSystem:              pulumi.String("string"),
	ResourceGroupId:              pulumi.String("string"),
	SatelliteClusterWorkerPoolId: pulumi.String("string"),
	Timeouts: &ibm.SatelliteClusterWorkerPoolTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
	},
	WorkerCount: pulumi.Float64(0),
	WorkerPoolLabels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zones: ibm.SatelliteClusterWorkerPoolZoneArray{
		&ibm.SatelliteClusterWorkerPoolZoneArgs{
			Id: pulumi.String("string"),
		},
	},
})

    var satelliteClusterWorkerPoolResource = new SatelliteClusterWorkerPool("satelliteClusterWorkerPoolResource", SatelliteClusterWorkerPoolArgs.builder()
    .cluster("string")
    .diskEncryption(false)
    .entitlement("string")
    .flavor("string")
    .hostLabels("string")
    .isolation("string")
    .name("string")
    .operatingSystem("string")
    .resourceGroupId("string")
    .satelliteClusterWorkerPoolId("string")
    .timeouts(SatelliteClusterWorkerPoolTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .workerCount(0)
    .workerPoolLabels(Map.of("string", "string"))
    .zones(SatelliteClusterWorkerPoolZoneArgs.builder()
        .id("string")
        .build())
    .build());

    satellite_cluster_worker_pool_resource = ibm.SatelliteClusterWorkerPool("satelliteClusterWorkerPoolResource",
    cluster="string",
    disk_encryption=False,
    entitlement="string",
    flavor="string",
    host_labels=["string"],
    isolation="string",
    name="string",
    operating_system="string",
    resource_group_id="string",
    satellite_cluster_worker_pool_id="string",
    timeouts={
        "create": "string",
        "delete": "string",
    },
    worker_count=0,
    worker_pool_labels={
        "string": "string",
    },
    zones=[{
        "id": "string",
    }])

    const satelliteClusterWorkerPoolResource = new ibm.SatelliteClusterWorkerPool("satelliteClusterWorkerPoolResource", {
    cluster: "string",
    diskEncryption: false,
    entitlement: "string",
    flavor: "string",
    hostLabels: ["string"],
    isolation: "string",
    name: "string",
    operatingSystem: "string",
    resourceGroupId: "string",
    satelliteClusterWorkerPoolId: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
    workerCount: 0,
    workerPoolLabels: {
        string: "string",
    },
    zones: [{
        id: "string",
    }],
});

    type: ibm:SatelliteClusterWorkerPool
properties:
    cluster: string
    diskEncryption: false
    entitlement: string
    flavor: string
    hostLabels:
        - string
    isolation: string
    name: string
    operatingSystem: string
    resourceGroupId: string
    satelliteClusterWorkerPoolId: string
    timeouts:
        create: string
        delete: string
    workerCount: 0
    workerPoolLabels:
        string: string
    zones:
        - id: string

    SatelliteClusterWorkerPool 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 SatelliteClusterWorkerPool resource accepts the following input properties:

    Cluster string
    The name or id of the cluster.
    DiskEncryption bool
    Disk encryption for worker node.
    Entitlement string
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    Flavor string
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    HostLabels List<string>
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    Isolation string
    Isolation for the worker node.
    Name string
    The name of the worker pool.
    OperatingSystem string
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    ResourceGroupId string
    The ID of the resource group. You can retrieve the value from data source
    SatelliteClusterWorkerPoolId string
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    Timeouts SatelliteClusterWorkerPoolTimeouts
    WorkerCount double
    The number of worker nodes per zone in the worker pool.
    WorkerPoolLabels Dictionary<string, string>
    Labels on all the workers in the worker pool.
    Zones List<SatelliteClusterWorkerPoolZone>

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    Cluster string
    The name or id of the cluster.
    DiskEncryption bool
    Disk encryption for worker node.
    Entitlement string
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    Flavor string
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    HostLabels []string
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    Isolation string
    Isolation for the worker node.
    Name string
    The name of the worker pool.
    OperatingSystem string
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    ResourceGroupId string
    The ID of the resource group. You can retrieve the value from data source
    SatelliteClusterWorkerPoolId string
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    Timeouts SatelliteClusterWorkerPoolTimeoutsArgs
    WorkerCount float64
    The number of worker nodes per zone in the worker pool.
    WorkerPoolLabels map[string]string
    Labels on all the workers in the worker pool.
    Zones []SatelliteClusterWorkerPoolZoneArgs

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster String
    The name or id of the cluster.
    diskEncryption Boolean
    Disk encryption for worker node.
    entitlement String
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor String
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    hostLabels List<String>
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation String
    Isolation for the worker node.
    name String
    The name of the worker pool.
    operatingSystem String
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resourceGroupId String
    The ID of the resource group. You can retrieve the value from data source
    satelliteClusterWorkerPoolId String
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts SatelliteClusterWorkerPoolTimeouts
    workerCount Double
    The number of worker nodes per zone in the worker pool.
    workerPoolLabels Map<String,String>
    Labels on all the workers in the worker pool.
    zones List<SatelliteClusterWorkerPoolZone>

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster string
    The name or id of the cluster.
    diskEncryption boolean
    Disk encryption for worker node.
    entitlement string
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor string
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    hostLabels string[]
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation string
    Isolation for the worker node.
    name string
    The name of the worker pool.
    operatingSystem string
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resourceGroupId string
    The ID of the resource group. You can retrieve the value from data source
    satelliteClusterWorkerPoolId string
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts SatelliteClusterWorkerPoolTimeouts
    workerCount number
    The number of worker nodes per zone in the worker pool.
    workerPoolLabels {[key: string]: string}
    Labels on all the workers in the worker pool.
    zones SatelliteClusterWorkerPoolZone[]

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster str
    The name or id of the cluster.
    disk_encryption bool
    Disk encryption for worker node.
    entitlement str
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor str
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    host_labels Sequence[str]
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation str
    Isolation for the worker node.
    name str
    The name of the worker pool.
    operating_system str
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resource_group_id str
    The ID of the resource group. You can retrieve the value from data source
    satellite_cluster_worker_pool_id str
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts SatelliteClusterWorkerPoolTimeoutsArgs
    worker_count float
    The number of worker nodes per zone in the worker pool.
    worker_pool_labels Mapping[str, str]
    Labels on all the workers in the worker pool.
    zones Sequence[SatelliteClusterWorkerPoolZoneArgs]

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster String
    The name or id of the cluster.
    diskEncryption Boolean
    Disk encryption for worker node.
    entitlement String
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor String
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    hostLabels List<String>
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation String
    Isolation for the worker node.
    name String
    The name of the worker pool.
    operatingSystem String
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resourceGroupId String
    The ID of the resource group. You can retrieve the value from data source
    satelliteClusterWorkerPoolId String
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts Property Map
    workerCount Number
    The number of worker nodes per zone in the worker pool.
    workerPoolLabels Map<String>
    Labels on all the workers in the worker pool.
    zones List<Property Map>

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SatelliteClusterWorkerPool resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SatelliteClusterWorkerPool Resource

    Get an existing SatelliteClusterWorkerPool 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?: SatelliteClusterWorkerPoolState, opts?: CustomResourceOptions): SatelliteClusterWorkerPool
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster: Optional[str] = None,
        disk_encryption: Optional[bool] = None,
        entitlement: Optional[str] = None,
        flavor: Optional[str] = None,
        host_labels: Optional[Sequence[str]] = None,
        isolation: Optional[str] = None,
        name: Optional[str] = None,
        operating_system: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        satellite_cluster_worker_pool_id: Optional[str] = None,
        timeouts: Optional[SatelliteClusterWorkerPoolTimeoutsArgs] = None,
        worker_count: Optional[float] = None,
        worker_pool_labels: Optional[Mapping[str, str]] = None,
        zones: Optional[Sequence[SatelliteClusterWorkerPoolZoneArgs]] = None) -> SatelliteClusterWorkerPool
    func GetSatelliteClusterWorkerPool(ctx *Context, name string, id IDInput, state *SatelliteClusterWorkerPoolState, opts ...ResourceOption) (*SatelliteClusterWorkerPool, error)
    public static SatelliteClusterWorkerPool Get(string name, Input<string> id, SatelliteClusterWorkerPoolState? state, CustomResourceOptions? opts = null)
    public static SatelliteClusterWorkerPool get(String name, Output<String> id, SatelliteClusterWorkerPoolState state, CustomResourceOptions options)
    resources:  _:    type: ibm:SatelliteClusterWorkerPool    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.
    The following state arguments are supported:
    Cluster string
    The name or id of the cluster.
    DiskEncryption bool
    Disk encryption for worker node.
    Entitlement string
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    Flavor string
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    HostLabels List<string>
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    Isolation string
    Isolation for the worker node.
    Name string
    The name of the worker pool.
    OperatingSystem string
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    ResourceGroupId string
    The ID of the resource group. You can retrieve the value from data source
    SatelliteClusterWorkerPoolId string
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    Timeouts SatelliteClusterWorkerPoolTimeouts
    WorkerCount double
    The number of worker nodes per zone in the worker pool.
    WorkerPoolLabels Dictionary<string, string>
    Labels on all the workers in the worker pool.
    Zones List<SatelliteClusterWorkerPoolZone>

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    Cluster string
    The name or id of the cluster.
    DiskEncryption bool
    Disk encryption for worker node.
    Entitlement string
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    Flavor string
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    HostLabels []string
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    Isolation string
    Isolation for the worker node.
    Name string
    The name of the worker pool.
    OperatingSystem string
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    ResourceGroupId string
    The ID of the resource group. You can retrieve the value from data source
    SatelliteClusterWorkerPoolId string
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    Timeouts SatelliteClusterWorkerPoolTimeoutsArgs
    WorkerCount float64
    The number of worker nodes per zone in the worker pool.
    WorkerPoolLabels map[string]string
    Labels on all the workers in the worker pool.
    Zones []SatelliteClusterWorkerPoolZoneArgs

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster String
    The name or id of the cluster.
    diskEncryption Boolean
    Disk encryption for worker node.
    entitlement String
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor String
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    hostLabels List<String>
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation String
    Isolation for the worker node.
    name String
    The name of the worker pool.
    operatingSystem String
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resourceGroupId String
    The ID of the resource group. You can retrieve the value from data source
    satelliteClusterWorkerPoolId String
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts SatelliteClusterWorkerPoolTimeouts
    workerCount Double
    The number of worker nodes per zone in the worker pool.
    workerPoolLabels Map<String,String>
    Labels on all the workers in the worker pool.
    zones List<SatelliteClusterWorkerPoolZone>

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster string
    The name or id of the cluster.
    diskEncryption boolean
    Disk encryption for worker node.
    entitlement string
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor string
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    hostLabels string[]
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation string
    Isolation for the worker node.
    name string
    The name of the worker pool.
    operatingSystem string
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resourceGroupId string
    The ID of the resource group. You can retrieve the value from data source
    satelliteClusterWorkerPoolId string
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts SatelliteClusterWorkerPoolTimeouts
    workerCount number
    The number of worker nodes per zone in the worker pool.
    workerPoolLabels {[key: string]: string}
    Labels on all the workers in the worker pool.
    zones SatelliteClusterWorkerPoolZone[]

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster str
    The name or id of the cluster.
    disk_encryption bool
    Disk encryption for worker node.
    entitlement str
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor str
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    host_labels Sequence[str]
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation str
    Isolation for the worker node.
    name str
    The name of the worker pool.
    operating_system str
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resource_group_id str
    The ID of the resource group. You can retrieve the value from data source
    satellite_cluster_worker_pool_id str
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts SatelliteClusterWorkerPoolTimeoutsArgs
    worker_count float
    The number of worker nodes per zone in the worker pool.
    worker_pool_labels Mapping[str, str]
    Labels on all the workers in the worker pool.
    zones Sequence[SatelliteClusterWorkerPoolZoneArgs]

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    cluster String
    The name or id of the cluster.
    diskEncryption Boolean
    Disk encryption for worker node.
    entitlement String
    The openshift cluster entitlement avoids the OCP licence charges incurred. Use cloud paks with OCP Licence entitlement to add the Openshift cluster worker pool.
    flavor String
    The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node.
    hostLabels List<String>
    ) Labels to add to the worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
    isolation String
    Isolation for the worker node.
    name String
    The name of the worker pool.
    operatingSystem String
    Operating system of the worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
    resourceGroupId String
    The ID of the resource group. You can retrieve the value from data source
    satelliteClusterWorkerPoolId String
    The unique identifier of the worker pool resource. The id is composed of <cluster_name_id>/<worker_pool_id>.
    timeouts Property Map
    workerCount Number
    The number of worker nodes per zone in the worker pool.
    workerPoolLabels Map<String>
    Labels on all the workers in the worker pool.
    zones List<Property Map>

    A nested block describing the zones of this worker_pool.

    Nested scheme for zones:

    Supporting Types

    SatelliteClusterWorkerPoolTimeouts, SatelliteClusterWorkerPoolTimeoutsArgs

    Create string
    Delete string
    Create string
    Delete string
    create String
    delete String
    create string
    delete string
    create str
    delete str
    create String
    delete String

    SatelliteClusterWorkerPoolZone, SatelliteClusterWorkerPoolZoneArgs

    Id string
    The name of the zone.
    Id string
    The name of the zone.
    id String
    The name of the zone.
    id string
    The name of the zone.
    id str
    The name of the zone.
    id String
    The name of the zone.

    Import

    The ibm_satellite_cluster_worker_pool can be imported by using cluster_name_id and worker_pool_id.

    Example

    $ pulumi import ibm:index/satelliteClusterWorkerPool:SatelliteClusterWorkerPool 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 ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm