1. Packages
  2. Vultr
  3. API Docs
  4. getKubernetes
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien

vultr.getKubernetes

Explore with Pulumi AI

Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien

Get information about a Vultr Kubernetes Engine (VKE) Cluster.

Example Usage

Create a new VKE cluster:

import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@pulumi/vultr";

const myVke = vultr.getKubernetes({
    filters: [{
        name: "label",
        values: ["my-lb-label"],
    }],
});
Copy
import pulumi
import pulumi_vultr as vultr

my_vke = vultr.get_kubernetes(filters=[{
    "name": "label",
    "values": ["my-lb-label"],
}])
Copy
package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.LookupKubernetes(ctx, &vultr.LookupKubernetesArgs{
			Filters: []vultr.GetKubernetesFilter{
				{
					Name: "label",
					Values: []string{
						"my-lb-label",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = Pulumi.Vultr;

return await Deployment.RunAsync(() => 
{
    var myVke = Vultr.GetKubernetes.Invoke(new()
    {
        Filters = new[]
        {
            new Vultr.Inputs.GetKubernetesFilterInputArgs
            {
                Name = "label",
                Values = new[]
                {
                    "my-lb-label",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vultr.VultrFunctions;
import com.pulumi.vultr.inputs.GetKubernetesArgs;
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 myVke = VultrFunctions.getKubernetes(GetKubernetesArgs.builder()
            .filters(GetKubernetesFilterArgs.builder()
                .name("label")
                .values("my-lb-label")
                .build())
            .build());

    }
}
Copy
variables:
  myVke:
    fn::invoke:
      Function: vultr:getKubernetes
      Arguments:
        filters:
          - name: label
            values:
              - my-lb-label
Copy

Using getKubernetes

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 getKubernetes(args: GetKubernetesArgs, opts?: InvokeOptions): Promise<GetKubernetesResult>
function getKubernetesOutput(args: GetKubernetesOutputArgs, opts?: InvokeOptions): Output<GetKubernetesResult>
Copy
def get_kubernetes(filters: Optional[Sequence[GetKubernetesFilter]] = None,
                   opts: Optional[InvokeOptions] = None) -> GetKubernetesResult
def get_kubernetes_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetKubernetesFilterArgs]]]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetKubernetesResult]
Copy
func LookupKubernetes(ctx *Context, args *LookupKubernetesArgs, opts ...InvokeOption) (*LookupKubernetesResult, error)
func LookupKubernetesOutput(ctx *Context, args *LookupKubernetesOutputArgs, opts ...InvokeOption) LookupKubernetesResultOutput
Copy

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

public static class GetKubernetes 
{
    public static Task<GetKubernetesResult> InvokeAsync(GetKubernetesArgs args, InvokeOptions? opts = null)
    public static Output<GetKubernetesResult> Invoke(GetKubernetesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetKubernetesResult> getKubernetes(GetKubernetesArgs args, InvokeOptions options)
public static Output<GetKubernetesResult> getKubernetes(GetKubernetesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vultr:index/getKubernetes:getKubernetes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters Changes to this property will trigger replacement. List<ediri.Vultr.Inputs.GetKubernetesFilter>
Query parameters for finding VKE.
Filters Changes to this property will trigger replacement. []GetKubernetesFilter
Query parameters for finding VKE.
filters Changes to this property will trigger replacement. List<GetKubernetesFilter>
Query parameters for finding VKE.
filters Changes to this property will trigger replacement. GetKubernetesFilter[]
Query parameters for finding VKE.
filters Changes to this property will trigger replacement. Sequence[GetKubernetesFilter]
Query parameters for finding VKE.
filters Changes to this property will trigger replacement. List<Property Map>
Query parameters for finding VKE.

getKubernetes Result

The following output properties are available:

ClientCertificate string
The base64 encoded public certificate used by clients to access the cluster.
ClientKey string
The base64 encoded private key used by clients to access the cluster.
ClusterCaCertificate string
The base64 encoded public certificate for the cluster's certificate authority.
ClusterSubnet string
IP range that your pods will run on in this cluster.
DateCreated string
Date node was created.
Endpoint string
Domain for your Kubernetes clusters control plane.
FirewallGroupId string
The ID of the firewall group managed by this cluster.
HaControlplanes bool
Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
Id string
ID of node.
Ip string
IP address of VKE cluster control plane.
KubeConfig string
Base64 encoded Kubeconfig for this VKE cluster.
Label string
Label of node.
NodePools List<ediri.Vultr.Outputs.GetKubernetesNodePool>
Contains the default node pool that was deployed.
Region string
The region your VKE cluster is deployed in.
ServiceSubnet string
IP range that services will run on this cluster.
Status string
Status of node.
Version string
The current kubernetes version your VKE cluster is running on.
Filters List<ediri.Vultr.Outputs.GetKubernetesFilter>
ClientCertificate string
The base64 encoded public certificate used by clients to access the cluster.
ClientKey string
The base64 encoded private key used by clients to access the cluster.
ClusterCaCertificate string
The base64 encoded public certificate for the cluster's certificate authority.
ClusterSubnet string
IP range that your pods will run on in this cluster.
DateCreated string
Date node was created.
Endpoint string
Domain for your Kubernetes clusters control plane.
FirewallGroupId string
The ID of the firewall group managed by this cluster.
HaControlplanes bool
Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
Id string
ID of node.
Ip string
IP address of VKE cluster control plane.
KubeConfig string
Base64 encoded Kubeconfig for this VKE cluster.
Label string
Label of node.
NodePools []GetKubernetesNodePool
Contains the default node pool that was deployed.
Region string
The region your VKE cluster is deployed in.
ServiceSubnet string
IP range that services will run on this cluster.
Status string
Status of node.
Version string
The current kubernetes version your VKE cluster is running on.
Filters []GetKubernetesFilter
clientCertificate String
The base64 encoded public certificate used by clients to access the cluster.
clientKey String
The base64 encoded private key used by clients to access the cluster.
clusterCaCertificate String
The base64 encoded public certificate for the cluster's certificate authority.
clusterSubnet String
IP range that your pods will run on in this cluster.
dateCreated String
Date node was created.
endpoint String
Domain for your Kubernetes clusters control plane.
firewallGroupId String
The ID of the firewall group managed by this cluster.
haControlplanes Boolean
Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id String
ID of node.
ip String
IP address of VKE cluster control plane.
kubeConfig String
Base64 encoded Kubeconfig for this VKE cluster.
label String
Label of node.
nodePools List<GetKubernetesNodePool>
Contains the default node pool that was deployed.
region String
The region your VKE cluster is deployed in.
serviceSubnet String
IP range that services will run on this cluster.
status String
Status of node.
version String
The current kubernetes version your VKE cluster is running on.
filters List<GetKubernetesFilter>
clientCertificate string
The base64 encoded public certificate used by clients to access the cluster.
clientKey string
The base64 encoded private key used by clients to access the cluster.
clusterCaCertificate string
The base64 encoded public certificate for the cluster's certificate authority.
clusterSubnet string
IP range that your pods will run on in this cluster.
dateCreated string
Date node was created.
endpoint string
Domain for your Kubernetes clusters control plane.
firewallGroupId string
The ID of the firewall group managed by this cluster.
haControlplanes boolean
Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id string
ID of node.
ip string
IP address of VKE cluster control plane.
kubeConfig string
Base64 encoded Kubeconfig for this VKE cluster.
label string
Label of node.
nodePools GetKubernetesNodePool[]
Contains the default node pool that was deployed.
region string
The region your VKE cluster is deployed in.
serviceSubnet string
IP range that services will run on this cluster.
status string
Status of node.
version string
The current kubernetes version your VKE cluster is running on.
filters GetKubernetesFilter[]
client_certificate str
The base64 encoded public certificate used by clients to access the cluster.
client_key str
The base64 encoded private key used by clients to access the cluster.
cluster_ca_certificate str
The base64 encoded public certificate for the cluster's certificate authority.
cluster_subnet str
IP range that your pods will run on in this cluster.
date_created str
Date node was created.
endpoint str
Domain for your Kubernetes clusters control plane.
firewall_group_id str
The ID of the firewall group managed by this cluster.
ha_controlplanes bool
Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id str
ID of node.
ip str
IP address of VKE cluster control plane.
kube_config str
Base64 encoded Kubeconfig for this VKE cluster.
label str
Label of node.
node_pools Sequence[GetKubernetesNodePool]
Contains the default node pool that was deployed.
region str
The region your VKE cluster is deployed in.
service_subnet str
IP range that services will run on this cluster.
status str
Status of node.
version str
The current kubernetes version your VKE cluster is running on.
filters Sequence[GetKubernetesFilter]
clientCertificate String
The base64 encoded public certificate used by clients to access the cluster.
clientKey String
The base64 encoded private key used by clients to access the cluster.
clusterCaCertificate String
The base64 encoded public certificate for the cluster's certificate authority.
clusterSubnet String
IP range that your pods will run on in this cluster.
dateCreated String
Date node was created.
endpoint String
Domain for your Kubernetes clusters control plane.
firewallGroupId String
The ID of the firewall group managed by this cluster.
haControlplanes Boolean
Boolean indicating whether or not the cluster has multiple, highly available controlplanes.
id String
ID of node.
ip String
IP address of VKE cluster control plane.
kubeConfig String
Base64 encoded Kubeconfig for this VKE cluster.
label String
Label of node.
nodePools List<Property Map>
Contains the default node pool that was deployed.
region String
The region your VKE cluster is deployed in.
serviceSubnet String
IP range that services will run on this cluster.
status String
Status of node.
version String
The current kubernetes version your VKE cluster is running on.
filters List<Property Map>

Supporting Types

GetKubernetesFilter

Name This property is required. string
Attribute name to filter with.
Values This property is required. List<string>
One or more values filter with.
Name This property is required. string
Attribute name to filter with.
Values This property is required. []string
One or more values filter with.
name This property is required. String
Attribute name to filter with.
values This property is required. List<String>
One or more values filter with.
name This property is required. string
Attribute name to filter with.
values This property is required. string[]
One or more values filter with.
name This property is required. str
Attribute name to filter with.
values This property is required. Sequence[str]
One or more values filter with.
name This property is required. String
Attribute name to filter with.
values This property is required. List<String>
One or more values filter with.

GetKubernetesNodePool

DateCreated This property is required. string
Date node was created.
DateUpdated This property is required. string
Date of node pool updates.
Id This property is required. string
ID of node.
Label This property is required. string
Label of node.
NodeQuantity This property is required. int
Number of nodes within node pool.
Nodes This property is required. List<ediri.Vultr.Inputs.GetKubernetesNodePoolNode>
Array that contains information about nodes within this node pool.
Plan This property is required. string
Node plan that nodes are using within this node pool.
Status This property is required. string
Status of node.
Tag This property is required. string
Tag for node pool.
AutoScaler bool
Boolean indicating if the auto scaler for the default node pool is active.
MaxNodes int
The maximum number of nodes used by the auto scaler.
MinNodes int
The minimum number of nodes used by the auto scaler.
DateCreated This property is required. string
Date node was created.
DateUpdated This property is required. string
Date of node pool updates.
Id This property is required. string
ID of node.
Label This property is required. string
Label of node.
NodeQuantity This property is required. int
Number of nodes within node pool.
Nodes This property is required. []GetKubernetesNodePoolNode
Array that contains information about nodes within this node pool.
Plan This property is required. string
Node plan that nodes are using within this node pool.
Status This property is required. string
Status of node.
Tag This property is required. string
Tag for node pool.
AutoScaler bool
Boolean indicating if the auto scaler for the default node pool is active.
MaxNodes int
The maximum number of nodes used by the auto scaler.
MinNodes int
The minimum number of nodes used by the auto scaler.
dateCreated This property is required. String
Date node was created.
dateUpdated This property is required. String
Date of node pool updates.
id This property is required. String
ID of node.
label This property is required. String
Label of node.
nodeQuantity This property is required. Integer
Number of nodes within node pool.
nodes This property is required. List<GetKubernetesNodePoolNode>
Array that contains information about nodes within this node pool.
plan This property is required. String
Node plan that nodes are using within this node pool.
status This property is required. String
Status of node.
tag This property is required. String
Tag for node pool.
autoScaler Boolean
Boolean indicating if the auto scaler for the default node pool is active.
maxNodes Integer
The maximum number of nodes used by the auto scaler.
minNodes Integer
The minimum number of nodes used by the auto scaler.
dateCreated This property is required. string
Date node was created.
dateUpdated This property is required. string
Date of node pool updates.
id This property is required. string
ID of node.
label This property is required. string
Label of node.
nodeQuantity This property is required. number
Number of nodes within node pool.
nodes This property is required. GetKubernetesNodePoolNode[]
Array that contains information about nodes within this node pool.
plan This property is required. string
Node plan that nodes are using within this node pool.
status This property is required. string
Status of node.
tag This property is required. string
Tag for node pool.
autoScaler boolean
Boolean indicating if the auto scaler for the default node pool is active.
maxNodes number
The maximum number of nodes used by the auto scaler.
minNodes number
The minimum number of nodes used by the auto scaler.
date_created This property is required. str
Date node was created.
date_updated This property is required. str
Date of node pool updates.
id This property is required. str
ID of node.
label This property is required. str
Label of node.
node_quantity This property is required. int
Number of nodes within node pool.
nodes This property is required. Sequence[GetKubernetesNodePoolNode]
Array that contains information about nodes within this node pool.
plan This property is required. str
Node plan that nodes are using within this node pool.
status This property is required. str
Status of node.
tag This property is required. str
Tag for node pool.
auto_scaler bool
Boolean indicating if the auto scaler for the default node pool is active.
max_nodes int
The maximum number of nodes used by the auto scaler.
min_nodes int
The minimum number of nodes used by the auto scaler.
dateCreated This property is required. String
Date node was created.
dateUpdated This property is required. String
Date of node pool updates.
id This property is required. String
ID of node.
label This property is required. String
Label of node.
nodeQuantity This property is required. Number
Number of nodes within node pool.
nodes This property is required. List<Property Map>
Array that contains information about nodes within this node pool.
plan This property is required. String
Node plan that nodes are using within this node pool.
status This property is required. String
Status of node.
tag This property is required. String
Tag for node pool.
autoScaler Boolean
Boolean indicating if the auto scaler for the default node pool is active.
maxNodes Number
The maximum number of nodes used by the auto scaler.
minNodes Number
The minimum number of nodes used by the auto scaler.

GetKubernetesNodePoolNode

DateCreated This property is required. string
Date node was created.
Id This property is required. string
ID of node.
Label This property is required. string
Label of node.
Status This property is required. string
Status of node.
DateCreated This property is required. string
Date node was created.
Id This property is required. string
ID of node.
Label This property is required. string
Label of node.
Status This property is required. string
Status of node.
dateCreated This property is required. String
Date node was created.
id This property is required. String
ID of node.
label This property is required. String
Label of node.
status This property is required. String
Status of node.
dateCreated This property is required. string
Date node was created.
id This property is required. string
ID of node.
label This property is required. string
Label of node.
status This property is required. string
Status of node.
date_created This property is required. str
Date node was created.
id This property is required. str
ID of node.
label This property is required. str
Label of node.
status This property is required. str
Status of node.
dateCreated This property is required. String
Date node was created.
id This property is required. String
ID of node.
label This property is required. String
Label of node.
status This property is required. String
Status of node.

Package Details

Repository
vultr dirien/pulumi-vultr
License
Apache-2.0
Notes
This Pulumi package is based on the vultr Terraform Provider.
Vultr v2.23.1 published on Tuesday, Dec 10, 2024 by dirien