talos v0.4.1, Nov 5 24

talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse

talos.cluster.getHealth

Explore with Pulumi AI

talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse

Using getHealth

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 getHealth(args: GetHealthArgs, opts?: InvokeOptions): Promise<GetHealthResult>
function getHealthOutput(args: GetHealthOutputArgs, opts?: InvokeOptions): Output<GetHealthResult>

def get_health(client_configuration: Optional[GetHealthClientConfiguration] = None,
               control_plane_nodes: Optional[Sequence[str]] = None,
               endpoints: Optional[Sequence[str]] = None,
               skip_kubernetes_checks: Optional[bool] = None,
               timeouts: Optional[GetHealthTimeouts] = None,
               worker_nodes: Optional[Sequence[str]] = None,
               opts: Optional[InvokeOptions] = None) -> GetHealthResult
def get_health_output(client_configuration: Optional[pulumi.Input[GetHealthClientConfigurationArgs]] = None,
               control_plane_nodes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               endpoints: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               skip_kubernetes_checks: Optional[pulumi.Input[bool]] = None,
               timeouts: Optional[pulumi.Input[GetHealthTimeoutsArgs]] = None,
               worker_nodes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetHealthResult]

func GetHealth(ctx *Context, args *GetHealthArgs, opts ...InvokeOption) (*GetHealthResult, error)
func GetHealthOutput(ctx *Context, args *GetHealthOutputArgs, opts ...InvokeOption) GetHealthResultOutput

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

public static class GetHealth 
{
    public static Task<GetHealthResult> InvokeAsync(GetHealthArgs args, InvokeOptions? opts = null)
    public static Output<GetHealthResult> Invoke(GetHealthInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHealthResult> getHealth(GetHealthArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: talos:cluster/getHealth:getHealth
  arguments:
    # arguments dictionary

The following arguments are supported:

ClientConfiguration Pulumiverse.Talos.Cluster.Inputs.GetHealthClientConfiguration: The client configuration data
ControlPlaneNodes List<string>: List of control plane nodes to check for health.
Endpoints List<string>: endpoints to use for the health check client. Use at least one control plane endpoint.
SkipKubernetesChecks bool: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
Timeouts Pulumiverse.Talos.Cluster.Inputs.GetHealthTimeouts
WorkerNodes List<string>: List of worker nodes to check for health.

ClientConfiguration GetHealthClientConfiguration: The client configuration data
ControlPlaneNodes []string: List of control plane nodes to check for health.
Endpoints []string: endpoints to use for the health check client. Use at least one control plane endpoint.
SkipKubernetesChecks bool: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
Timeouts GetHealthTimeouts
WorkerNodes []string: List of worker nodes to check for health.

clientConfiguration GetHealthClientConfiguration: The client configuration data
controlPlaneNodes List<String>: List of control plane nodes to check for health.
endpoints List<String>: endpoints to use for the health check client. Use at least one control plane endpoint.
skipKubernetesChecks Boolean: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts GetHealthTimeouts
workerNodes List<String>: List of worker nodes to check for health.

clientConfiguration GetHealthClientConfiguration: The client configuration data
controlPlaneNodes string[]: List of control plane nodes to check for health.
endpoints string[]: endpoints to use for the health check client. Use at least one control plane endpoint.
skipKubernetesChecks boolean: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts GetHealthTimeouts
workerNodes string[]: List of worker nodes to check for health.

client_configuration GetHealthClientConfiguration: The client configuration data
control_plane_nodes Sequence[str]: List of control plane nodes to check for health.
endpoints Sequence[str]: endpoints to use for the health check client. Use at least one control plane endpoint.
skip_kubernetes_checks bool: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts GetHealthTimeouts
worker_nodes Sequence[str]: List of worker nodes to check for health.

clientConfiguration Property Map: The client configuration data
controlPlaneNodes List<String>: List of control plane nodes to check for health.
endpoints List<String>: endpoints to use for the health check client. Use at least one control plane endpoint.
skipKubernetesChecks Boolean: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts Property Map
workerNodes List<String>: List of worker nodes to check for health.

getHealth Result

The following output properties are available:

ClientConfiguration Pulumiverse.Talos.Cluster.Outputs.GetHealthClientConfiguration: The client configuration data
ControlPlaneNodes List<string>: List of control plane nodes to check for health.
Endpoints List<string>: endpoints to use for the health check client. Use at least one control plane endpoint.
Id string: The ID of this resource.
SkipKubernetesChecks bool: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
Timeouts Pulumiverse.Talos.Cluster.Outputs.GetHealthTimeouts
WorkerNodes List<string>: List of worker nodes to check for health.

ClientConfiguration GetHealthClientConfiguration: The client configuration data
ControlPlaneNodes []string: List of control plane nodes to check for health.
Endpoints []string: endpoints to use for the health check client. Use at least one control plane endpoint.
Id string: The ID of this resource.
SkipKubernetesChecks bool: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
Timeouts GetHealthTimeouts
WorkerNodes []string: List of worker nodes to check for health.

clientConfiguration GetHealthClientConfiguration: The client configuration data
controlPlaneNodes List<String>: List of control plane nodes to check for health.
endpoints List<String>: endpoints to use for the health check client. Use at least one control plane endpoint.
id String: The ID of this resource.
skipKubernetesChecks Boolean: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts GetHealthTimeouts
workerNodes List<String>: List of worker nodes to check for health.

clientConfiguration GetHealthClientConfiguration: The client configuration data
controlPlaneNodes string[]: List of control plane nodes to check for health.
endpoints string[]: endpoints to use for the health check client. Use at least one control plane endpoint.
id string: The ID of this resource.
skipKubernetesChecks boolean: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts GetHealthTimeouts
workerNodes string[]: List of worker nodes to check for health.

client_configuration GetHealthClientConfiguration: The client configuration data
control_plane_nodes Sequence[str]: List of control plane nodes to check for health.
endpoints Sequence[str]: endpoints to use for the health check client. Use at least one control plane endpoint.
id str: The ID of this resource.
skip_kubernetes_checks bool: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts GetHealthTimeouts
worker_nodes Sequence[str]: List of worker nodes to check for health.

clientConfiguration Property Map: The client configuration data
controlPlaneNodes List<String>: List of control plane nodes to check for health.
endpoints List<String>: endpoints to use for the health check client. Use at least one control plane endpoint.
id String: The ID of this resource.
skipKubernetesChecks Boolean: Skip Kubernetes component checks, this is useful to check if the nodes has finished booting up and kubelet is running. Default is false.
timeouts Property Map
workerNodes List<String>: List of worker nodes to check for health.

Supporting Types

GetHealthClientConfiguration

CaCertificate string: The client CA certificate
ClientCertificate string: The client certificate
ClientKey string: The client key

CaCertificate string: The client CA certificate
ClientCertificate string: The client certificate
ClientKey string: The client key

caCertificate String: The client CA certificate
clientCertificate String: The client certificate
clientKey String: The client key

caCertificate string: The client CA certificate
clientCertificate string: The client certificate
clientKey string: The client key

ca_certificate str: The client CA certificate
client_certificate str: The client certificate
client_key str: The client key

caCertificate String: The client CA certificate
clientCertificate String: The client certificate
clientKey String: The client key

GetHealthTimeouts

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

Read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read string: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read str: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

read String: A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Read operations occur during any refresh or planning operation when refresh is enabled.

Package Details

Repository: talos pulumiverse/pulumi-talos
License: MPL-2.0
Notes: This Pulumi package is based on the talos Terraform Provider.

talos v0.4.1 published on Tuesday, Nov 5, 2024 by Pulumiverse

pulumiverse/pulumi-talos

talos.cluster.getHealth

On this page

On this page

Using getHealth

getHealth Result

Supporting Types

GetHealthClientConfiguration

GetHealthTimeouts

Package Details

On this page

On this page