1. Packages
  2. Cilium
  3. API Docs
  4. Clustermesh
Cilium v0.1.7 published on Sunday, Sep 29, 2024 by littlejo

cilium.Clustermesh

Explore with Pulumi AI

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,
                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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. String
The unique name of the resource.
args This property is required. ClustermeshArgs
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 clustermeshResource = new Cilium.Clustermesh("clustermeshResource", new()
{
    EnableExternalWorkloads = false,
    EnableKvStoreMesh = false,
    ServiceType = "string",
    Wait = false,
});
Copy
example, err := cilium.NewClustermesh(ctx, "clustermeshResource", &cilium.ClustermeshArgs{
	EnableExternalWorkloads: pulumi.Bool(false),
	EnableKvStoreMesh:       pulumi.Bool(false),
	ServiceType:             pulumi.String("string"),
	Wait:                    pulumi.Bool(false),
})
Copy
var clustermeshResource = new Clustermesh("clustermeshResource", ClustermeshArgs.builder()
    .enableExternalWorkloads(false)
    .enableKvStoreMesh(false)
    .serviceType("string")
    .wait(false)
    .build());
Copy
clustermesh_resource = cilium.Clustermesh("clustermeshResource",
    enable_external_workloads=False,
    enable_kv_store_mesh=False,
    service_type="string",
    wait=False)
Copy
const clustermeshResource = new cilium.Clustermesh("clustermeshResource", {
    enableExternalWorkloads: false,
    enableKvStoreMesh: false,
    serviceType: "string",
    wait: false,
});
Copy
type: cilium:Clustermesh
properties:
    enableExternalWorkloads: false
    enableKvStoreMesh: false
    serviceType: string
    wait: false
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

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).
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).
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).
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).
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).
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).
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,
        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)
resources:  _:    type: cilium:Clustermesh    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:
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).
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).
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).
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).
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).
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).
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.