Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. SatelliteCluster
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.SatelliteCluster

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, or delete IBM Cloud Satellite Cluster. Set up an Red Hat OpenShift® on IBM Cloud clusters in an IBM Cloud Satellite location, and use the hosts of your own infrastructure that you added to your location as the worker nodes for the cluster.

Example Usage

Create satellite cluster

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  createCluster:
    type: ibm:SatelliteCluster
    properties:
      location: ${var.location}
      enableConfigAdmin: true
      kubeVersion: 4.6_openshift
      resourceGroupId: ${data.ibm_resource_group.rg.id}
      waitForWorkerUpdate: true
      dynamic:
        - forEach: ${var.zones}
          content:
            - id: ${zones.value}
Copy

Create SatelliteCluster Resource

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

Constructor syntax

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

@overload
def SatelliteCluster(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     location: Optional[str] = None,
                     patch_version: Optional[str] = None,
                     crn_token: Optional[str] = None,
                     disable_public_service_endpoint: Optional[bool] = None,
                     enable_config_admin: Optional[bool] = None,
                     entitlement: Optional[str] = None,
                     host_labels: Optional[Sequence[str]] = None,
                     infrastructure_topology: Optional[str] = None,
                     pod_subnet: Optional[str] = None,
                     calico_ip_autodetection: Optional[Mapping[str, str]] = None,
                     name: Optional[str] = None,
                     default_worker_pool_labels: Optional[Mapping[str, str]] = None,
                     operating_system: Optional[str] = None,
                     kube_version: Optional[str] = None,
                     pull_secret: Optional[str] = None,
                     resource_group_id: Optional[str] = None,
                     retry_patch_version: Optional[float] = None,
                     satellite_cluster_id: Optional[str] = None,
                     service_subnet: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None,
                     timeouts: Optional[SatelliteClusterTimeoutsArgs] = None,
                     wait_for_worker_update: Optional[bool] = None,
                     worker_count: Optional[float] = None,
                     zones: Optional[Sequence[SatelliteClusterZoneArgs]] = None)
func NewSatelliteCluster(ctx *Context, name string, args SatelliteClusterArgs, opts ...ResourceOption) (*SatelliteCluster, error)
public SatelliteCluster(string name, SatelliteClusterArgs args, CustomResourceOptions? opts = null)
public SatelliteCluster(String name, SatelliteClusterArgs args)
public SatelliteCluster(String name, SatelliteClusterArgs args, CustomResourceOptions options)

type: ibm:SatelliteCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SatelliteClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SatelliteClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SatelliteClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SatelliteClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SatelliteClusterArgs
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 satelliteClusterResource = new Ibm.SatelliteCluster("satelliteClusterResource", new()
{
    Location = "string",
    PatchVersion = "string",
    CrnToken = "string",
    DisablePublicServiceEndpoint = false,
    EnableConfigAdmin = false,
    Entitlement = "string",
    HostLabels = new[]
    {
        "string",
    },
    InfrastructureTopology = "string",
    PodSubnet = "string",
    CalicoIpAutodetection = 
    {
        { "string", "string" },
    },
    Name = "string",
    DefaultWorkerPoolLabels = 
    {
        { "string", "string" },
    },
    OperatingSystem = "string",
    KubeVersion = "string",
    PullSecret = "string",
    ResourceGroupId = "string",
    RetryPatchVersion = 0,
    SatelliteClusterId = "string",
    ServiceSubnet = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.SatelliteClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Read = "string",
        Update = "string",
    },
    WaitForWorkerUpdate = false,
    WorkerCount = 0,
    Zones = new[]
    {
        new Ibm.Inputs.SatelliteClusterZoneArgs
        {
            Id = "string",
        },
    },
});
Copy
example, err := ibm.NewSatelliteCluster(ctx, "satelliteClusterResource", &ibm.SatelliteClusterArgs{
	Location:                     pulumi.String("string"),
	PatchVersion:                 pulumi.String("string"),
	CrnToken:                     pulumi.String("string"),
	DisablePublicServiceEndpoint: pulumi.Bool(false),
	EnableConfigAdmin:            pulumi.Bool(false),
	Entitlement:                  pulumi.String("string"),
	HostLabels: pulumi.StringArray{
		pulumi.String("string"),
	},
	InfrastructureTopology: pulumi.String("string"),
	PodSubnet:              pulumi.String("string"),
	CalicoIpAutodetection: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	DefaultWorkerPoolLabels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	OperatingSystem:    pulumi.String("string"),
	KubeVersion:        pulumi.String("string"),
	PullSecret:         pulumi.String("string"),
	ResourceGroupId:    pulumi.String("string"),
	RetryPatchVersion:  pulumi.Float64(0),
	SatelliteClusterId: pulumi.String("string"),
	ServiceSubnet:      pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.SatelliteClusterTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Read:   pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	WaitForWorkerUpdate: pulumi.Bool(false),
	WorkerCount:         pulumi.Float64(0),
	Zones: ibm.SatelliteClusterZoneArray{
		&ibm.SatelliteClusterZoneArgs{
			Id: pulumi.String("string"),
		},
	},
})
Copy
var satelliteClusterResource = new SatelliteCluster("satelliteClusterResource", SatelliteClusterArgs.builder()
    .location("string")
    .patchVersion("string")
    .crnToken("string")
    .disablePublicServiceEndpoint(false)
    .enableConfigAdmin(false)
    .entitlement("string")
    .hostLabels("string")
    .infrastructureTopology("string")
    .podSubnet("string")
    .calicoIpAutodetection(Map.of("string", "string"))
    .name("string")
    .defaultWorkerPoolLabels(Map.of("string", "string"))
    .operatingSystem("string")
    .kubeVersion("string")
    .pullSecret("string")
    .resourceGroupId("string")
    .retryPatchVersion(0)
    .satelliteClusterId("string")
    .serviceSubnet("string")
    .tags("string")
    .timeouts(SatelliteClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .read("string")
        .update("string")
        .build())
    .waitForWorkerUpdate(false)
    .workerCount(0)
    .zones(SatelliteClusterZoneArgs.builder()
        .id("string")
        .build())
    .build());
Copy
satellite_cluster_resource = ibm.SatelliteCluster("satelliteClusterResource",
    location="string",
    patch_version="string",
    crn_token="string",
    disable_public_service_endpoint=False,
    enable_config_admin=False,
    entitlement="string",
    host_labels=["string"],
    infrastructure_topology="string",
    pod_subnet="string",
    calico_ip_autodetection={
        "string": "string",
    },
    name="string",
    default_worker_pool_labels={
        "string": "string",
    },
    operating_system="string",
    kube_version="string",
    pull_secret="string",
    resource_group_id="string",
    retry_patch_version=0,
    satellite_cluster_id="string",
    service_subnet="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "read": "string",
        "update": "string",
    },
    wait_for_worker_update=False,
    worker_count=0,
    zones=[{
        "id": "string",
    }])
Copy
const satelliteClusterResource = new ibm.SatelliteCluster("satelliteClusterResource", {
    location: "string",
    patchVersion: "string",
    crnToken: "string",
    disablePublicServiceEndpoint: false,
    enableConfigAdmin: false,
    entitlement: "string",
    hostLabels: ["string"],
    infrastructureTopology: "string",
    podSubnet: "string",
    calicoIpAutodetection: {
        string: "string",
    },
    name: "string",
    defaultWorkerPoolLabels: {
        string: "string",
    },
    operatingSystem: "string",
    kubeVersion: "string",
    pullSecret: "string",
    resourceGroupId: "string",
    retryPatchVersion: 0,
    satelliteClusterId: "string",
    serviceSubnet: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        read: "string",
        update: "string",
    },
    waitForWorkerUpdate: false,
    workerCount: 0,
    zones: [{
        id: "string",
    }],
});
Copy
type: ibm:SatelliteCluster
properties:
    calicoIpAutodetection:
        string: string
    crnToken: string
    defaultWorkerPoolLabels:
        string: string
    disablePublicServiceEndpoint: false
    enableConfigAdmin: false
    entitlement: string
    hostLabels:
        - string
    infrastructureTopology: string
    kubeVersion: string
    location: string
    name: string
    operatingSystem: string
    patchVersion: string
    podSubnet: string
    pullSecret: string
    resourceGroupId: string
    retryPatchVersion: 0
    satelliteClusterId: string
    serviceSubnet: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        read: string
        update: string
    waitForWorkerUpdate: false
    workerCount: 0
    zones:
        - id: string
Copy

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

Location This property is required. string
The name or ID of the Satellite location.
CalicoIpAutodetection Dictionary<string, string>
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
CrnToken string
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
DefaultWorkerPoolLabels Dictionary<string, string>
The labels on all the workers in the default worker pool.
DisablePublicServiceEndpoint bool
Boolean value true if Public service endpoint to be disabled
EnableConfigAdmin bool
User provided value to indicate opt-in agreement to SatCon admin agent.
Entitlement string
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
HostLabels List<string>
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
InfrastructureTopology string

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

KubeVersion string
The Red Hart OpenShift Container Platform version.
Name string
The unique name for the new IBM Cloud Satellite cluster.
OperatingSystem string
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
PatchVersion string
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
PodSubnet string
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
PullSecret string
The Red Hat pull secret to create the OpenShift cluster.
ResourceGroupId string
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
RetryPatchVersion double
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
SatelliteClusterId string
ServiceSubnet string
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
Tags List<string>
Tags associated with the container cluster instance.
Timeouts SatelliteClusterTimeouts
WaitForWorkerUpdate bool
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
WorkerCount double
The number of worker nodes to create per zone in the default worker pool.
Zones List<SatelliteClusterZone>
The name of the zones to create the default worker pool.
Location This property is required. string
The name or ID of the Satellite location.
CalicoIpAutodetection map[string]string
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
CrnToken string
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
DefaultWorkerPoolLabels map[string]string
The labels on all the workers in the default worker pool.
DisablePublicServiceEndpoint bool
Boolean value true if Public service endpoint to be disabled
EnableConfigAdmin bool
User provided value to indicate opt-in agreement to SatCon admin agent.
Entitlement string
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
HostLabels []string
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
InfrastructureTopology string

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

KubeVersion string
The Red Hart OpenShift Container Platform version.
Name string
The unique name for the new IBM Cloud Satellite cluster.
OperatingSystem string
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
PatchVersion string
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
PodSubnet string
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
PullSecret string
The Red Hat pull secret to create the OpenShift cluster.
ResourceGroupId string
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
RetryPatchVersion float64
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
SatelliteClusterId string
ServiceSubnet string
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
Tags []string
Tags associated with the container cluster instance.
Timeouts SatelliteClusterTimeoutsArgs
WaitForWorkerUpdate bool
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
WorkerCount float64
The number of worker nodes to create per zone in the default worker pool.
Zones []SatelliteClusterZoneArgs
The name of the zones to create the default worker pool.
location This property is required. String
The name or ID of the Satellite location.
calicoIpAutodetection Map<String,String>
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crnToken String
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
defaultWorkerPoolLabels Map<String,String>
The labels on all the workers in the default worker pool.
disablePublicServiceEndpoint Boolean
Boolean value true if Public service endpoint to be disabled
enableConfigAdmin Boolean
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement String
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
hostLabels List<String>
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructureTopology String

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

kubeVersion String
The Red Hart OpenShift Container Platform version.
name String
The unique name for the new IBM Cloud Satellite cluster.
operatingSystem String
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patchVersion String
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
podSubnet String
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
pullSecret String
The Red Hat pull secret to create the OpenShift cluster.
resourceGroupId String
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
retryPatchVersion Double
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satelliteClusterId String
serviceSubnet String
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
tags List<String>
Tags associated with the container cluster instance.
timeouts SatelliteClusterTimeouts
waitForWorkerUpdate Boolean
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
workerCount Double
The number of worker nodes to create per zone in the default worker pool.
zones List<SatelliteClusterZone>
The name of the zones to create the default worker pool.
location This property is required. string
The name or ID of the Satellite location.
calicoIpAutodetection {[key: string]: string}
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crnToken string
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
defaultWorkerPoolLabels {[key: string]: string}
The labels on all the workers in the default worker pool.
disablePublicServiceEndpoint boolean
Boolean value true if Public service endpoint to be disabled
enableConfigAdmin boolean
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement string
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
hostLabels string[]
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructureTopology string

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

kubeVersion string
The Red Hart OpenShift Container Platform version.
name string
The unique name for the new IBM Cloud Satellite cluster.
operatingSystem string
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patchVersion string
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
podSubnet string
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
pullSecret string
The Red Hat pull secret to create the OpenShift cluster.
resourceGroupId string
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
retryPatchVersion number
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satelliteClusterId string
serviceSubnet string
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
tags string[]
Tags associated with the container cluster instance.
timeouts SatelliteClusterTimeouts
waitForWorkerUpdate boolean
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
workerCount number
The number of worker nodes to create per zone in the default worker pool.
zones SatelliteClusterZone[]
The name of the zones to create the default worker pool.
location This property is required. str
The name or ID of the Satellite location.
calico_ip_autodetection Mapping[str, str]
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crn_token str
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
default_worker_pool_labels Mapping[str, str]
The labels on all the workers in the default worker pool.
disable_public_service_endpoint bool
Boolean value true if Public service endpoint to be disabled
enable_config_admin bool
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement str
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
host_labels Sequence[str]
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructure_topology str

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

kube_version str
The Red Hart OpenShift Container Platform version.
name str
The unique name for the new IBM Cloud Satellite cluster.
operating_system str
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patch_version str
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
pod_subnet str
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
pull_secret str
The Red Hat pull secret to create the OpenShift cluster.
resource_group_id str
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
retry_patch_version float
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satellite_cluster_id str
service_subnet str
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
tags Sequence[str]
Tags associated with the container cluster instance.
timeouts SatelliteClusterTimeoutsArgs
wait_for_worker_update bool
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
worker_count float
The number of worker nodes to create per zone in the default worker pool.
zones Sequence[SatelliteClusterZoneArgs]
The name of the zones to create the default worker pool.
location This property is required. String
The name or ID of the Satellite location.
calicoIpAutodetection Map<String>
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crnToken String
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
defaultWorkerPoolLabels Map<String>
The labels on all the workers in the default worker pool.
disablePublicServiceEndpoint Boolean
Boolean value true if Public service endpoint to be disabled
enableConfigAdmin Boolean
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement String
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
hostLabels List<String>
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructureTopology String

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

kubeVersion String
The Red Hart OpenShift Container Platform version.
name String
The unique name for the new IBM Cloud Satellite cluster.
operatingSystem String
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patchVersion String
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
podSubnet String
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
pullSecret String
The Red Hat pull secret to create the OpenShift cluster.
resourceGroupId String
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
retryPatchVersion Number
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satelliteClusterId String
serviceSubnet String
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
tags List<String>
Tags associated with the container cluster instance.
timeouts Property Map
waitForWorkerUpdate Boolean
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
workerCount Number
The number of worker nodes to create per zone in the default worker pool.
zones List<Property Map>
The name of the zones to create the default worker pool.

Outputs

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

Crn string
CRN of resource instance
Id string
The provider-assigned unique ID for this managed resource.
IngressHostname string
IngressSecret string
MasterStatus string
MasterUrl string
PrivateServiceEndpointEnabled bool
PrivateServiceEndpointUrl string
PublicServiceEndpointEnabled bool
PublicServiceEndpointUrl string
ResourceGroupName string
The resource group name in which resource is provisioned
State string
The lifecycle state of the cluster.
Crn string
CRN of resource instance
Id string
The provider-assigned unique ID for this managed resource.
IngressHostname string
IngressSecret string
MasterStatus string
MasterUrl string
PrivateServiceEndpointEnabled bool
PrivateServiceEndpointUrl string
PublicServiceEndpointEnabled bool
PublicServiceEndpointUrl string
ResourceGroupName string
The resource group name in which resource is provisioned
State string
The lifecycle state of the cluster.
crn String
CRN of resource instance
id String
The provider-assigned unique ID for this managed resource.
ingressHostname String
ingressSecret String
masterStatus String
masterUrl String
privateServiceEndpointEnabled Boolean
privateServiceEndpointUrl String
publicServiceEndpointEnabled Boolean
publicServiceEndpointUrl String
resourceGroupName String
The resource group name in which resource is provisioned
state String
The lifecycle state of the cluster.
crn string
CRN of resource instance
id string
The provider-assigned unique ID for this managed resource.
ingressHostname string
ingressSecret string
masterStatus string
masterUrl string
privateServiceEndpointEnabled boolean
privateServiceEndpointUrl string
publicServiceEndpointEnabled boolean
publicServiceEndpointUrl string
resourceGroupName string
The resource group name in which resource is provisioned
state string
The lifecycle state of the cluster.
crn str
CRN of resource instance
id str
The provider-assigned unique ID for this managed resource.
ingress_hostname str
ingress_secret str
master_status str
master_url str
private_service_endpoint_enabled bool
private_service_endpoint_url str
public_service_endpoint_enabled bool
public_service_endpoint_url str
resource_group_name str
The resource group name in which resource is provisioned
state str
The lifecycle state of the cluster.
crn String
CRN of resource instance
id String
The provider-assigned unique ID for this managed resource.
ingressHostname String
ingressSecret String
masterStatus String
masterUrl String
privateServiceEndpointEnabled Boolean
privateServiceEndpointUrl String
publicServiceEndpointEnabled Boolean
publicServiceEndpointUrl String
resourceGroupName String
The resource group name in which resource is provisioned
state String
The lifecycle state of the cluster.

Look up Existing SatelliteCluster Resource

Get an existing SatelliteCluster 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?: SatelliteClusterState, opts?: CustomResourceOptions): SatelliteCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        calico_ip_autodetection: Optional[Mapping[str, str]] = None,
        crn: Optional[str] = None,
        crn_token: Optional[str] = None,
        default_worker_pool_labels: Optional[Mapping[str, str]] = None,
        disable_public_service_endpoint: Optional[bool] = None,
        enable_config_admin: Optional[bool] = None,
        entitlement: Optional[str] = None,
        host_labels: Optional[Sequence[str]] = None,
        infrastructure_topology: Optional[str] = None,
        ingress_hostname: Optional[str] = None,
        ingress_secret: Optional[str] = None,
        kube_version: Optional[str] = None,
        location: Optional[str] = None,
        master_status: Optional[str] = None,
        master_url: Optional[str] = None,
        name: Optional[str] = None,
        operating_system: Optional[str] = None,
        patch_version: Optional[str] = None,
        pod_subnet: Optional[str] = None,
        private_service_endpoint_enabled: Optional[bool] = None,
        private_service_endpoint_url: Optional[str] = None,
        public_service_endpoint_enabled: Optional[bool] = None,
        public_service_endpoint_url: Optional[str] = None,
        pull_secret: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        retry_patch_version: Optional[float] = None,
        satellite_cluster_id: Optional[str] = None,
        service_subnet: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[SatelliteClusterTimeoutsArgs] = None,
        wait_for_worker_update: Optional[bool] = None,
        worker_count: Optional[float] = None,
        zones: Optional[Sequence[SatelliteClusterZoneArgs]] = None) -> SatelliteCluster
func GetSatelliteCluster(ctx *Context, name string, id IDInput, state *SatelliteClusterState, opts ...ResourceOption) (*SatelliteCluster, error)
public static SatelliteCluster Get(string name, Input<string> id, SatelliteClusterState? state, CustomResourceOptions? opts = null)
public static SatelliteCluster get(String name, Output<String> id, SatelliteClusterState state, CustomResourceOptions options)
resources:  _:    type: ibm:SatelliteCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CalicoIpAutodetection Dictionary<string, string>
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
Crn string
CRN of resource instance
CrnToken string
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
DefaultWorkerPoolLabels Dictionary<string, string>
The labels on all the workers in the default worker pool.
DisablePublicServiceEndpoint bool
Boolean value true if Public service endpoint to be disabled
EnableConfigAdmin bool
User provided value to indicate opt-in agreement to SatCon admin agent.
Entitlement string
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
HostLabels List<string>
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
InfrastructureTopology string

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

IngressHostname string
IngressSecret string
KubeVersion string
The Red Hart OpenShift Container Platform version.
Location string
The name or ID of the Satellite location.
MasterStatus string
MasterUrl string
Name string
The unique name for the new IBM Cloud Satellite cluster.
OperatingSystem string
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
PatchVersion string
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
PodSubnet string
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
PrivateServiceEndpointEnabled bool
PrivateServiceEndpointUrl string
PublicServiceEndpointEnabled bool
PublicServiceEndpointUrl string
PullSecret string
The Red Hat pull secret to create the OpenShift cluster.
ResourceGroupId string
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
ResourceGroupName string
The resource group name in which resource is provisioned
RetryPatchVersion double
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
SatelliteClusterId string
ServiceSubnet string
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
State string
The lifecycle state of the cluster.
Tags List<string>
Tags associated with the container cluster instance.
Timeouts SatelliteClusterTimeouts
WaitForWorkerUpdate bool
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
WorkerCount double
The number of worker nodes to create per zone in the default worker pool.
Zones List<SatelliteClusterZone>
The name of the zones to create the default worker pool.
CalicoIpAutodetection map[string]string
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
Crn string
CRN of resource instance
CrnToken string
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
DefaultWorkerPoolLabels map[string]string
The labels on all the workers in the default worker pool.
DisablePublicServiceEndpoint bool
Boolean value true if Public service endpoint to be disabled
EnableConfigAdmin bool
User provided value to indicate opt-in agreement to SatCon admin agent.
Entitlement string
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
HostLabels []string
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
InfrastructureTopology string

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

IngressHostname string
IngressSecret string
KubeVersion string
The Red Hart OpenShift Container Platform version.
Location string
The name or ID of the Satellite location.
MasterStatus string
MasterUrl string
Name string
The unique name for the new IBM Cloud Satellite cluster.
OperatingSystem string
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
PatchVersion string
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
PodSubnet string
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
PrivateServiceEndpointEnabled bool
PrivateServiceEndpointUrl string
PublicServiceEndpointEnabled bool
PublicServiceEndpointUrl string
PullSecret string
The Red Hat pull secret to create the OpenShift cluster.
ResourceGroupId string
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
ResourceGroupName string
The resource group name in which resource is provisioned
RetryPatchVersion float64
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
SatelliteClusterId string
ServiceSubnet string
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
State string
The lifecycle state of the cluster.
Tags []string
Tags associated with the container cluster instance.
Timeouts SatelliteClusterTimeoutsArgs
WaitForWorkerUpdate bool
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
WorkerCount float64
The number of worker nodes to create per zone in the default worker pool.
Zones []SatelliteClusterZoneArgs
The name of the zones to create the default worker pool.
calicoIpAutodetection Map<String,String>
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crn String
CRN of resource instance
crnToken String
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
defaultWorkerPoolLabels Map<String,String>
The labels on all the workers in the default worker pool.
disablePublicServiceEndpoint Boolean
Boolean value true if Public service endpoint to be disabled
enableConfigAdmin Boolean
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement String
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
hostLabels List<String>
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructureTopology String

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

ingressHostname String
ingressSecret String
kubeVersion String
The Red Hart OpenShift Container Platform version.
location String
The name or ID of the Satellite location.
masterStatus String
masterUrl String
name String
The unique name for the new IBM Cloud Satellite cluster.
operatingSystem String
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patchVersion String
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
podSubnet String
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
privateServiceEndpointEnabled Boolean
privateServiceEndpointUrl String
publicServiceEndpointEnabled Boolean
publicServiceEndpointUrl String
pullSecret String
The Red Hat pull secret to create the OpenShift cluster.
resourceGroupId String
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
resourceGroupName String
The resource group name in which resource is provisioned
retryPatchVersion Double
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satelliteClusterId String
serviceSubnet String
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
state String
The lifecycle state of the cluster.
tags List<String>
Tags associated with the container cluster instance.
timeouts SatelliteClusterTimeouts
waitForWorkerUpdate Boolean
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
workerCount Double
The number of worker nodes to create per zone in the default worker pool.
zones List<SatelliteClusterZone>
The name of the zones to create the default worker pool.
calicoIpAutodetection {[key: string]: string}
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crn string
CRN of resource instance
crnToken string
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
defaultWorkerPoolLabels {[key: string]: string}
The labels on all the workers in the default worker pool.
disablePublicServiceEndpoint boolean
Boolean value true if Public service endpoint to be disabled
enableConfigAdmin boolean
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement string
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
hostLabels string[]
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructureTopology string

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

ingressHostname string
ingressSecret string
kubeVersion string
The Red Hart OpenShift Container Platform version.
location string
The name or ID of the Satellite location.
masterStatus string
masterUrl string
name string
The unique name for the new IBM Cloud Satellite cluster.
operatingSystem string
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patchVersion string
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
podSubnet string
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
privateServiceEndpointEnabled boolean
privateServiceEndpointUrl string
publicServiceEndpointEnabled boolean
publicServiceEndpointUrl string
pullSecret string
The Red Hat pull secret to create the OpenShift cluster.
resourceGroupId string
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
resourceGroupName string
The resource group name in which resource is provisioned
retryPatchVersion number
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satelliteClusterId string
serviceSubnet string
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
state string
The lifecycle state of the cluster.
tags string[]
Tags associated with the container cluster instance.
timeouts SatelliteClusterTimeouts
waitForWorkerUpdate boolean
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
workerCount number
The number of worker nodes to create per zone in the default worker pool.
zones SatelliteClusterZone[]
The name of the zones to create the default worker pool.
calico_ip_autodetection Mapping[str, str]
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crn str
CRN of resource instance
crn_token str
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
default_worker_pool_labels Mapping[str, str]
The labels on all the workers in the default worker pool.
disable_public_service_endpoint bool
Boolean value true if Public service endpoint to be disabled
enable_config_admin bool
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement str
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
host_labels Sequence[str]
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructure_topology str

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

ingress_hostname str
ingress_secret str
kube_version str
The Red Hart OpenShift Container Platform version.
location str
The name or ID of the Satellite location.
master_status str
master_url str
name str
The unique name for the new IBM Cloud Satellite cluster.
operating_system str
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patch_version str
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
pod_subnet str
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
private_service_endpoint_enabled bool
private_service_endpoint_url str
public_service_endpoint_enabled bool
public_service_endpoint_url str
pull_secret str
The Red Hat pull secret to create the OpenShift cluster.
resource_group_id str
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
resource_group_name str
The resource group name in which resource is provisioned
retry_patch_version float
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satellite_cluster_id str
service_subnet str
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
state str
The lifecycle state of the cluster.
tags Sequence[str]
Tags associated with the container cluster instance.
timeouts SatelliteClusterTimeoutsArgs
wait_for_worker_update bool
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
worker_count float
The number of worker nodes to create per zone in the default worker pool.
zones Sequence[SatelliteClusterZoneArgs]
The name of the zones to create the default worker pool.
calicoIpAutodetection Map<String>
"Set IP autodetection to use correct interface for Calico, works only with RHCOS"
crn String
CRN of resource instance
crnToken String
The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster.
defaultWorkerPoolLabels Map<String>
The labels on all the workers in the default worker pool.
disablePublicServiceEndpoint Boolean
Boolean value true if Public service endpoint to be disabled
enableConfigAdmin Boolean
User provided value to indicate opt-in agreement to SatCon admin agent.
entitlement String
Entitlement reduces additional OCP Licence cost in OpenShift clusters. Use Cloud Pak with OCP Licence entitlement to create the OpenShift cluster. Note It is set only when the first time creation of the cluster, further modifications are not impacted. Set this argument to cloud_pak only if you use the cluster with a Cloud Pak that has an OpenShift entitlement..
hostLabels List<String>
) Labels to add to the default worker pool, formatted as cpu:4 key-value pairs. Satellite uses host labels to automatically assign hosts to worker pools with matching labels.
infrastructureTopology String

Specify whether the cluster should run a single worker node or the default number of worker nodes. Only works with kube version 4.11 and newer. To create a single-node cluster, specify 'single-replica'. To create a default cluster with multiple worker nodes, specify 'highly-available'. The 'highly-available' option is applied by default. Available options: single-replica, highly-available (default: "highly-available")

Nested scheme for zone:

ingressHostname String
ingressSecret String
kubeVersion String
The Red Hart OpenShift Container Platform version.
location String
The name or ID of the Satellite location.
masterStatus String
masterUrl String
name String
The unique name for the new IBM Cloud Satellite cluster.
operatingSystem String
Operating system of the default worker pool. Options are REDHAT_7_64, REDHAT_8_64, or RHCOS.
patchVersion String
Set this to update the worker nodes with the required patch version. The patch_version should be in the format - patch_version_fixpack_version. For more information, see Kuberentes version. NOTE: To update the patch/fixpack versions of the worker nodes, Run the command ibmcloud ks workers -c <cluster_name_or_id> --output json, fetch the required patch & fixpack versions from kubeVersion.target and set the patch_version parameter.
podSubnet String
Specify a custom subnet CIDR to provide private IP addresses for pods. The subnet must be at least /23 or larger. For more information, see Configuring VPC subnets.
privateServiceEndpointEnabled Boolean
privateServiceEndpointUrl String
publicServiceEndpointEnabled Boolean
publicServiceEndpointUrl String
pullSecret String
The Red Hat pull secret to create the OpenShift cluster.
resourceGroupId String
The ID of the resource group. You can retrieve the value from data source ibm.ResourceGroup.
resourceGroupName String
The resource group name in which resource is provisioned
retryPatchVersion Number
This argument helps to retry the update of patch_version if the previous update fails. Increment the value to retry the update of patch_version on worker nodes.
satelliteClusterId String
serviceSubnet String
Specify a custom subnet CIDR to provide private IP addresses for services. The subnet must be at least /24 or larger. For more information, see Configuring VPC subnets.
state String
The lifecycle state of the cluster.
tags List<String>
Tags associated with the container cluster instance.
timeouts Property Map
waitForWorkerUpdate Boolean
Set to true to wait for kube version of woker nodes to update during the worker node kube version update. NOTE setting wait_for_worker_update to false is not recommended. This results in upgrading all the worker nodes in the cluster at the same time causing the cluster downtime.
workerCount Number
The number of worker nodes to create per zone in the default worker pool.
zones List<Property Map>
The name of the zones to create the default worker pool.

Supporting Types

SatelliteClusterTimeouts
, SatelliteClusterTimeoutsArgs

Create string
Delete string
Read string
Update string
Create string
Delete string
Read string
Update string
create String
delete String
read String
update String
create string
delete string
read string
update string
create str
delete str
read str
update str
create String
delete String
read String
update String

SatelliteClusterZone
, SatelliteClusterZoneArgs

Id This property is required. string
Zone for the worker pool in a multizone cluster
Id This property is required. string
Zone for the worker pool in a multizone cluster
id This property is required. String
Zone for the worker pool in a multizone cluster
id This property is required. string
Zone for the worker pool in a multizone cluster
id This property is required. str
Zone for the worker pool in a multizone cluster
id This property is required. String
Zone for the worker pool in a multizone cluster

Import

The ibm_satellite_cluster can be imported using the location id or name.

Example:

$ pulumi import ibm:index/satelliteCluster:SatelliteCluster cluster cluster
Copy

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 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm