1. Packages
  2. Cilium
  3. API Docs
  4. Clustermesh
Cilium v0.0.6 published on Friday, Jan 19, 2024 by littlejo

cilium.Clustermesh

Explore with Pulumi AI

cilium logo
Cilium v0.0.6 published on Friday, Jan 19, 2024 by littlejo

    Cluster Mesh resource. This is equivalent to cilium cli: cilium clustermesh enable and cilium clustermesh disable: It manages the activation of Cluster Mesh on one Kubernetes cluster.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cilium = Littlejo.Cilium;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleInstall = new Cilium.Install("exampleInstall", new()
        {
            Sets = new[]
            {
                "cluster.name=clustermesh1",
                "cluster.id=1",
                "ipam.mode=kubernetes",
            },
            Version = "1.14.5",
        });
    
        var exampleClustermesh = new Cilium.Clustermesh("exampleClustermesh", new()
        {
            ServiceType = "LoadBalancer",
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                exampleInstall,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/littlejo/pulumi-cilium/sdk/go/cilium"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleInstall, err := cilium.NewInstall(ctx, "exampleInstall", &cilium.InstallArgs{
    			Sets: pulumi.StringArray{
    				pulumi.String("cluster.name=clustermesh1"),
    				pulumi.String("cluster.id=1"),
    				pulumi.String("ipam.mode=kubernetes"),
    			},
    			Version: pulumi.String("1.14.5"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = cilium.NewClustermesh(ctx, "exampleClustermesh", &cilium.ClustermeshArgs{
    			ServiceType: pulumi.String("LoadBalancer"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			exampleInstall,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cilium.Install;
    import com.pulumi.cilium.InstallArgs;
    import com.pulumi.cilium.Clustermesh;
    import com.pulumi.cilium.ClustermeshArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleInstall = new Install("exampleInstall", InstallArgs.builder()        
                .sets(            
                    "cluster.name=clustermesh1",
                    "cluster.id=1",
                    "ipam.mode=kubernetes")
                .version("1.14.5")
                .build());
    
            var exampleClustermesh = new Clustermesh("exampleClustermesh", ClustermeshArgs.builder()        
                .serviceType("LoadBalancer")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(exampleInstall)
                    .build());
    
        }
    }
    
    import pulumi
    import littlejo_cilium as cilium
    
    example_install = cilium.Install("exampleInstall",
        sets=[
            "cluster.name=clustermesh1",
            "cluster.id=1",
            "ipam.mode=kubernetes",
        ],
        version="1.14.5")
    example_clustermesh = cilium.Clustermesh("exampleClustermesh", service_type="LoadBalancer",
    opts=pulumi.ResourceOptions(depends_on=[example_install]))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as cilium from "@littlejo/cilium";
    
    const exampleInstall = new cilium.Install("exampleInstall", {
        sets: [
            "cluster.name=clustermesh1",
            "cluster.id=1",
            "ipam.mode=kubernetes",
        ],
        version: "1.14.5",
    });
    const exampleClustermesh = new cilium.Clustermesh("exampleClustermesh", {serviceType: "LoadBalancer"}, {
        dependsOn: [exampleInstall],
    });
    
    resources:
      exampleInstall:
        type: cilium:Install
        properties:
          sets:
            - cluster.name=clustermesh1
            - cluster.id=1
            - ipam.mode=kubernetes
          version: 1.14.5
      exampleClustermesh:
        type: cilium:Clustermesh
        properties:
          serviceType: LoadBalancer
        options:
          dependson:
            - ${exampleInstall}
    

    Create Clustermesh Resource

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

    Constructor syntax

    new Clustermesh(name: string, args?: ClustermeshArgs, opts?: CustomResourceOptions);
    @overload
    def Clustermesh(resource_name: str,
                    args: Optional[ClustermeshArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Clustermesh(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    enable_external_workloads: Optional[bool] = None,
                    enable_kv_store_mesh: Optional[bool] = None,
                    namespace: Optional[str] = None,
                    service_type: Optional[str] = None,
                    wait: Optional[bool] = None)
    func NewClustermesh(ctx *Context, name string, args *ClustermeshArgs, opts ...ResourceOption) (*Clustermesh, error)
    public Clustermesh(string name, ClustermeshArgs? args = null, CustomResourceOptions? opts = null)
    public Clustermesh(String name, ClustermeshArgs args)
    public Clustermesh(String name, ClustermeshArgs args, CustomResourceOptions options)
    
    type: cilium:Clustermesh
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClustermeshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClustermeshArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClustermeshArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClustermeshArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClustermeshArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var clustermeshResource = new Cilium.Clustermesh("clustermeshResource", new()
    {
        EnableExternalWorkloads = false,
        EnableKvStoreMesh = false,
        Namespace = "string",
        ServiceType = "string",
        Wait = false,
    });
    
    example, err := cilium.NewClustermesh(ctx, "clustermeshResource", &cilium.ClustermeshArgs{
    	EnableExternalWorkloads: pulumi.Bool(false),
    	EnableKvStoreMesh:       pulumi.Bool(false),
    	Namespace:               pulumi.String("string"),
    	ServiceType:             pulumi.String("string"),
    	Wait:                    pulumi.Bool(false),
    })
    
    var clustermeshResource = new Clustermesh("clustermeshResource", ClustermeshArgs.builder()        
        .enableExternalWorkloads(false)
        .enableKvStoreMesh(false)
        .namespace("string")
        .serviceType("string")
        .wait(false)
        .build());
    
    clustermesh_resource = cilium.Clustermesh("clustermeshResource",
        enable_external_workloads=False,
        enable_kv_store_mesh=False,
        namespace="string",
        service_type="string",
        wait=False)
    
    const clustermeshResource = new cilium.Clustermesh("clustermeshResource", {
        enableExternalWorkloads: false,
        enableKvStoreMesh: false,
        namespace: "string",
        serviceType: "string",
        wait: false,
    });
    
    type: cilium:Clustermesh
    properties:
        enableExternalWorkloads: false
        enableKvStoreMesh: false
        namespace: string
        serviceType: string
        wait: false
    

    Clustermesh Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Clustermesh resource accepts the following input properties:

    EnableExternalWorkloads bool
    Enable support for external workloads, such as VMs (Default: false).
    EnableKvStoreMesh bool
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    Namespace string
    Namespace in which to install (Default: kube-system).
    ServiceType string
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    Wait bool
    Wait Cluster Mesh status is ok (Default: true).
    EnableExternalWorkloads bool
    Enable support for external workloads, such as VMs (Default: false).
    EnableKvStoreMesh bool
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    Namespace string
    Namespace in which to install (Default: kube-system).
    ServiceType string
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    Wait bool
    Wait Cluster Mesh status is ok (Default: true).
    enableExternalWorkloads Boolean
    Enable support for external workloads, such as VMs (Default: false).
    enableKvStoreMesh Boolean
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace String
    Namespace in which to install (Default: kube-system).
    serviceType String
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait_ Boolean
    Wait Cluster Mesh status is ok (Default: true).
    enableExternalWorkloads boolean
    Enable support for external workloads, such as VMs (Default: false).
    enableKvStoreMesh boolean
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace string
    Namespace in which to install (Default: kube-system).
    serviceType string
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait boolean
    Wait Cluster Mesh status is ok (Default: true).
    enable_external_workloads bool
    Enable support for external workloads, such as VMs (Default: false).
    enable_kv_store_mesh bool
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace str
    Namespace in which to install (Default: kube-system).
    service_type str
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait bool
    Wait Cluster Mesh status is ok (Default: true).
    enableExternalWorkloads Boolean
    Enable support for external workloads, such as VMs (Default: false).
    enableKvStoreMesh Boolean
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace String
    Namespace in which to install (Default: kube-system).
    serviceType String
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait Boolean
    Wait Cluster Mesh status is ok (Default: true).

    Outputs

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

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

    Look up Existing Clustermesh Resource

    Get an existing Clustermesh 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?: ClustermeshState, opts?: CustomResourceOptions): Clustermesh
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enable_external_workloads: Optional[bool] = None,
            enable_kv_store_mesh: Optional[bool] = None,
            namespace: Optional[str] = None,
            service_type: Optional[str] = None,
            wait: Optional[bool] = None) -> Clustermesh
    func GetClustermesh(ctx *Context, name string, id IDInput, state *ClustermeshState, opts ...ResourceOption) (*Clustermesh, error)
    public static Clustermesh Get(string name, Input<string> id, ClustermeshState? state, CustomResourceOptions? opts = null)
    public static Clustermesh get(String name, Output<String> id, ClustermeshState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    EnableExternalWorkloads bool
    Enable support for external workloads, such as VMs (Default: false).
    EnableKvStoreMesh bool
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    Namespace string
    Namespace in which to install (Default: kube-system).
    ServiceType string
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    Wait bool
    Wait Cluster Mesh status is ok (Default: true).
    EnableExternalWorkloads bool
    Enable support for external workloads, such as VMs (Default: false).
    EnableKvStoreMesh bool
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    Namespace string
    Namespace in which to install (Default: kube-system).
    ServiceType string
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    Wait bool
    Wait Cluster Mesh status is ok (Default: true).
    enableExternalWorkloads Boolean
    Enable support for external workloads, such as VMs (Default: false).
    enableKvStoreMesh Boolean
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace String
    Namespace in which to install (Default: kube-system).
    serviceType String
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait_ Boolean
    Wait Cluster Mesh status is ok (Default: true).
    enableExternalWorkloads boolean
    Enable support for external workloads, such as VMs (Default: false).
    enableKvStoreMesh boolean
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace string
    Namespace in which to install (Default: kube-system).
    serviceType string
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait boolean
    Wait Cluster Mesh status is ok (Default: true).
    enable_external_workloads bool
    Enable support for external workloads, such as VMs (Default: false).
    enable_kv_store_mesh bool
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace str
    Namespace in which to install (Default: kube-system).
    service_type str
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait bool
    Wait Cluster Mesh status is ok (Default: true).
    enableExternalWorkloads Boolean
    Enable support for external workloads, such as VMs (Default: false).
    enableKvStoreMesh Boolean
    Enable kvstoremesh, an extension which caches remote cluster information in the local kvstore (Cilium >=1.14 only) (Default: false).
    namespace String
    Namespace in which to install (Default: kube-system).
    serviceType String
    Type of Kubernetes service to expose control plane { LoadBalancer | NodePort | ClusterIP } (Default: autodetected).
    wait Boolean
    Wait Cluster Mesh status is ok (Default: true).

    Package Details

    Repository
    cilium littlejo/pulumi-cilium
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cilium Terraform Provider.
    cilium logo
    Cilium v0.0.6 published on Friday, Jan 19, 2024 by littlejo