ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm.getContainerAddons
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
getContainerAddons Result
The following output properties are available:
- Addons
List<Get
Container Addons Addon>  - (String) The details of an enabled add-ons.
 - Cluster string
 - Id string
 - (String) The ID of an add-ons.
 - Resource
Group stringId  - (String) The ID of the cluster resource group in which the 
addonsis installed. 
- Addons
[]Get
Container Addons Addon  - (String) The details of an enabled add-ons.
 - Cluster string
 - Id string
 - (String) The ID of an add-ons.
 - Resource
Group stringId  - (String) The ID of the cluster resource group in which the 
addonsis installed. 
- addons
List<Get
Container Addons Addon>  - (String) The details of an enabled add-ons.
 - cluster String
 - id String
 - (String) The ID of an add-ons.
 - resource
Group StringId  - (String) The ID of the cluster resource group in which the 
addonsis installed. 
- addons
Get
Container Addons Addon[]  - (String) The details of an enabled add-ons.
 - cluster string
 - id string
 - (String) The ID of an add-ons.
 - resource
Group stringId  - (String) The ID of the cluster resource group in which the 
addonsis installed. 
- addons
Sequence[Get
Container Addons Addon]  - (String) The details of an enabled add-ons.
 - cluster str
 - id str
 - (String) The ID of an add-ons.
 - resource_
group_ strid  - (String) The ID of the cluster resource group in which the 
addonsis installed. 
- addons List<Property Map>
 - (String) The details of an enabled add-ons.
 - cluster String
 - id String
 - (String) The ID of an add-ons.
 - resource
Group StringId  - (String) The ID of the cluster resource group in which the 
addonsis installed. 
Supporting Types
GetContainerAddonsAddon   
- Allowed
Upgrade List<string>Versions  - (String) The versions that the add-on is upgraded to.
 - Deprecated bool
 - (String) Determines if the add-on version is deprecated.
 - Health
State string - (String) The health state of an add-on, such as critical or pending.
 - Health
Status string - (String) The health status of an add-on, provides a description of the state in the form of error message.
 - Min
Kube stringVersion  - (String) The minimum Kubernetes version of the add-on.
 - Min
Ocp stringVersion  - (String) The minimum OpenShift version of the add-on.
 - Name string
 - (String) The add-on name such as 
istio. - Supported
Kube stringRange  - (String) The supported Kubernetes version range of the add-on.
 - Target
Version 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.
 - Vlan
Spanning boolRequired  - (String) The VLAN spanning required for multi-zone clusters.
 
- Allowed
Upgrade []stringVersions  - (String) The versions that the add-on is upgraded to.
 - Deprecated bool
 - (String) Determines if the add-on version is deprecated.
 - Health
State string - (String) The health state of an add-on, such as critical or pending.
 - Health
Status string - (String) The health status of an add-on, provides a description of the state in the form of error message.
 - Min
Kube stringVersion  - (String) The minimum Kubernetes version of the add-on.
 - Min
Ocp stringVersion  - (String) The minimum OpenShift version of the add-on.
 - Name string
 - (String) The add-on name such as 
istio. - Supported
Kube stringRange  - (String) The supported Kubernetes version range of the add-on.
 - Target
Version 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.
 - Vlan
Spanning boolRequired  - (String) The VLAN spanning required for multi-zone clusters.
 
- allowed
Upgrade List<String>Versions  - (String) The versions that the add-on is upgraded to.
 - deprecated Boolean
 - (String) Determines if the add-on version is deprecated.
 - health
State String - (String) The health state of an add-on, such as critical or pending.
 - health
Status String - (String) The health status of an add-on, provides a description of the state in the form of error message.
 - min
Kube StringVersion  - (String) The minimum Kubernetes version of the add-on.
 - min
Ocp StringVersion  - (String) The minimum OpenShift version of the add-on.
 - name String
 - (String) The add-on name such as 
istio. - supported
Kube StringRange  - (String) The supported Kubernetes version range of the add-on.
 - target
Version 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.
 - vlan
Spanning BooleanRequired  - (String) The VLAN spanning required for multi-zone clusters.
 
- allowed
Upgrade string[]Versions  - (String) The versions that the add-on is upgraded to.
 - deprecated boolean
 - (String) Determines if the add-on version is deprecated.
 - health
State string - (String) The health state of an add-on, such as critical or pending.
 - health
Status string - (String) The health status of an add-on, provides a description of the state in the form of error message.
 - min
Kube stringVersion  - (String) The minimum Kubernetes version of the add-on.
 - min
Ocp stringVersion  - (String) The minimum OpenShift version of the add-on.
 - name string
 - (String) The add-on name such as 
istio. - supported
Kube stringRange  - (String) The supported Kubernetes version range of the add-on.
 - target
Version 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.
 - vlan
Spanning booleanRequired  - (String) The VLAN spanning required for multi-zone clusters.
 
- allowed_
upgrade_ Sequence[str]versions  - (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_ strversion  - (String) The minimum Kubernetes version of the add-on.
 - min_
ocp_ strversion  - (String) The minimum OpenShift version of the add-on.
 - name str
 - (String) The add-on name such as 
istio. - supported_
kube_ strrange  - (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_ boolrequired  - (String) The VLAN spanning required for multi-zone clusters.
 
- allowed
Upgrade List<String>Versions  - (String) The versions that the add-on is upgraded to.
 - deprecated Boolean
 - (String) Determines if the add-on version is deprecated.
 - health
State String - (String) The health state of an add-on, such as critical or pending.
 - health
Status String - (String) The health status of an add-on, provides a description of the state in the form of error message.
 - min
Kube StringVersion  - (String) The minimum Kubernetes version of the add-on.
 - min
Ocp StringVersion  - (String) The minimum OpenShift version of the add-on.
 - name String
 - (String) The add-on name such as 
istio. - supported
Kube StringRange  - (String) The supported Kubernetes version range of the add-on.
 - target
Version 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.
 - vlan
Spanning BooleanRequired  - (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 
ibmTerraform Provider.