1. Packages
  2. Ibm Provider
  3. API Docs
  4. getContainerAddons
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.getContainerAddons

Explore with Pulumi AI

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

    Retrieve information about all the add-ons that are enables on a cluster. For more information, see Cluster addons.

    Example Usage

    The following example retrieves information of an add-ons.

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const addons = ibm.getContainerAddons({
        cluster: ibm_container_addons.addons.cluster,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    addons = ibm.get_container_addons(cluster=ibm_container_addons["addons"]["cluster"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupContainerAddons(ctx, &ibm.LookupContainerAddonsArgs{
    			Cluster: ibm_container_addons.Addons.Cluster,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var addons = Ibm.GetContainerAddons.Invoke(new()
        {
            Cluster = ibm_container_addons.Addons.Cluster,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetContainerAddonsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var addons = IbmFunctions.getContainerAddons(GetContainerAddonsArgs.builder()
                .cluster(ibm_container_addons.addons().cluster())
                .build());
    
        }
    }
    
    variables:
      addons:
        fn::invoke:
          function: ibm:getContainerAddons
          arguments:
            cluster: ${ibm_container_addons.addons.cluster}
    

    Using getContainerAddons

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getContainerAddons(args: GetContainerAddonsArgs, opts?: InvokeOptions): Promise<GetContainerAddonsResult>
    function getContainerAddonsOutput(args: GetContainerAddonsOutputArgs, opts?: InvokeOptions): Output<GetContainerAddonsResult>
    def get_container_addons(cluster: Optional[str] = None,
                             id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetContainerAddonsResult
    def get_container_addons_output(cluster: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetContainerAddonsResult]
    func LookupContainerAddons(ctx *Context, args *LookupContainerAddonsArgs, opts ...InvokeOption) (*LookupContainerAddonsResult, error)
    func LookupContainerAddonsOutput(ctx *Context, args *LookupContainerAddonsOutputArgs, opts ...InvokeOption) LookupContainerAddonsResultOutput

    > Note: This function is named LookupContainerAddons in the Go SDK.

    public static class GetContainerAddons 
    {
        public static Task<GetContainerAddonsResult> InvokeAsync(GetContainerAddonsArgs args, InvokeOptions? opts = null)
        public static Output<GetContainerAddonsResult> Invoke(GetContainerAddonsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetContainerAddonsResult> getContainerAddons(GetContainerAddonsArgs args, InvokeOptions options)
    public static Output<GetContainerAddonsResult> getContainerAddons(GetContainerAddonsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getContainerAddons:getContainerAddons
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Cluster string
    The name or ID of the cluster.
    Id string
    (String) The ID of an add-ons.
    Cluster string
    The name or ID of the cluster.
    Id string
    (String) The ID of an add-ons.
    cluster String
    The name or ID of the cluster.
    id String
    (String) The ID of an add-ons.
    cluster string
    The name or ID of the cluster.
    id string
    (String) The ID of an add-ons.
    cluster str
    The name or ID of the cluster.
    id str
    (String) The ID of an add-ons.
    cluster String
    The name or ID of the cluster.
    id String
    (String) The ID of an add-ons.

    getContainerAddons Result

    The following output properties are available:

    Addons List<GetContainerAddonsAddon>
    (String) The details of an enabled add-ons.
    Cluster string
    Id string
    (String) The ID of an add-ons.
    ResourceGroupId string
    (String) The ID of the cluster resource group in which the addons is installed.
    Addons []GetContainerAddonsAddon
    (String) The details of an enabled add-ons.
    Cluster string
    Id string
    (String) The ID of an add-ons.
    ResourceGroupId string
    (String) The ID of the cluster resource group in which the addons is installed.
    addons List<GetContainerAddonsAddon>
    (String) The details of an enabled add-ons.
    cluster String
    id String
    (String) The ID of an add-ons.
    resourceGroupId String
    (String) The ID of the cluster resource group in which the addons is installed.
    addons GetContainerAddonsAddon[]
    (String) The details of an enabled add-ons.
    cluster string
    id string
    (String) The ID of an add-ons.
    resourceGroupId string
    (String) The ID of the cluster resource group in which the addons is installed.
    addons Sequence[GetContainerAddonsAddon]
    (String) The details of an enabled add-ons.
    cluster str
    id str
    (String) The ID of an add-ons.
    resource_group_id str
    (String) The ID of the cluster resource group in which the addons is installed.
    addons List<Property Map>
    (String) The details of an enabled add-ons.
    cluster String
    id String
    (String) The ID of an add-ons.
    resourceGroupId String
    (String) The ID of the cluster resource group in which the addons is installed.

    Supporting Types

    GetContainerAddonsAddon

    AllowedUpgradeVersions List<string>
    (String) The versions that the add-on is upgraded to.
    Deprecated bool
    (String) Determines if the add-on version is deprecated.
    HealthState string
    (String) The health state of an add-on, such as critical or pending.
    HealthStatus string
    (String) The health status of an add-on, provides a description of the state in the form of error message.
    MinKubeVersion string
    (String) The minimum Kubernetes version of the add-on.
    MinOcpVersion string
    (String) The minimum OpenShift version of the add-on.
    Name string
    (String) The add-on name such as istio.
    SupportedKubeRange string
    (String) The supported Kubernetes version range of the add-on.
    TargetVersion string
    (String) The add-on target version.
    Version string
    (String) The add-on version. Omit the version, if you need to use the default version.
    VlanSpanningRequired bool
    (String) The VLAN spanning required for multi-zone clusters.
    AllowedUpgradeVersions []string
    (String) The versions that the add-on is upgraded to.
    Deprecated bool
    (String) Determines if the add-on version is deprecated.
    HealthState string
    (String) The health state of an add-on, such as critical or pending.
    HealthStatus string
    (String) The health status of an add-on, provides a description of the state in the form of error message.
    MinKubeVersion string
    (String) The minimum Kubernetes version of the add-on.
    MinOcpVersion string
    (String) The minimum OpenShift version of the add-on.
    Name string
    (String) The add-on name such as istio.
    SupportedKubeRange string
    (String) The supported Kubernetes version range of the add-on.
    TargetVersion string
    (String) The add-on target version.
    Version string
    (String) The add-on version. Omit the version, if you need to use the default version.
    VlanSpanningRequired bool
    (String) The VLAN spanning required for multi-zone clusters.
    allowedUpgradeVersions List<String>
    (String) The versions that the add-on is upgraded to.
    deprecated Boolean
    (String) Determines if the add-on version is deprecated.
    healthState String
    (String) The health state of an add-on, such as critical or pending.
    healthStatus String
    (String) The health status of an add-on, provides a description of the state in the form of error message.
    minKubeVersion String
    (String) The minimum Kubernetes version of the add-on.
    minOcpVersion String
    (String) The minimum OpenShift version of the add-on.
    name String
    (String) The add-on name such as istio.
    supportedKubeRange String
    (String) The supported Kubernetes version range of the add-on.
    targetVersion String
    (String) The add-on target version.
    version String
    (String) The add-on version. Omit the version, if you need to use the default version.
    vlanSpanningRequired Boolean
    (String) The VLAN spanning required for multi-zone clusters.
    allowedUpgradeVersions string[]
    (String) The versions that the add-on is upgraded to.
    deprecated boolean
    (String) Determines if the add-on version is deprecated.
    healthState string
    (String) The health state of an add-on, such as critical or pending.
    healthStatus string
    (String) The health status of an add-on, provides a description of the state in the form of error message.
    minKubeVersion string
    (String) The minimum Kubernetes version of the add-on.
    minOcpVersion string
    (String) The minimum OpenShift version of the add-on.
    name string
    (String) The add-on name such as istio.
    supportedKubeRange string
    (String) The supported Kubernetes version range of the add-on.
    targetVersion string
    (String) The add-on target version.
    version string
    (String) The add-on version. Omit the version, if you need to use the default version.
    vlanSpanningRequired boolean
    (String) The VLAN spanning required for multi-zone clusters.
    allowed_upgrade_versions Sequence[str]
    (String) The versions that the add-on is upgraded to.
    deprecated bool
    (String) Determines if the add-on version is deprecated.
    health_state str
    (String) The health state of an add-on, such as critical or pending.
    health_status str
    (String) The health status of an add-on, provides a description of the state in the form of error message.
    min_kube_version str
    (String) The minimum Kubernetes version of the add-on.
    min_ocp_version str
    (String) The minimum OpenShift version of the add-on.
    name str
    (String) The add-on name such as istio.
    supported_kube_range str
    (String) The supported Kubernetes version range of the add-on.
    target_version str
    (String) The add-on target version.
    version str
    (String) The add-on version. Omit the version, if you need to use the default version.
    vlan_spanning_required bool
    (String) The VLAN spanning required for multi-zone clusters.
    allowedUpgradeVersions List<String>
    (String) The versions that the add-on is upgraded to.
    deprecated Boolean
    (String) Determines if the add-on version is deprecated.
    healthState String
    (String) The health state of an add-on, such as critical or pending.
    healthStatus String
    (String) The health status of an add-on, provides a description of the state in the form of error message.
    minKubeVersion String
    (String) The minimum Kubernetes version of the add-on.
    minOcpVersion String
    (String) The minimum OpenShift version of the add-on.
    name String
    (String) The add-on name such as istio.
    supportedKubeRange String
    (String) The supported Kubernetes version range of the add-on.
    targetVersion String
    (String) The add-on target version.
    version String
    (String) The add-on version. Omit the version, if you need to use the default version.
    vlanSpanningRequired Boolean
    (String) The VLAN spanning required for multi-zone clusters.

    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