Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. Rancher 2
  5. getCluster

getCluster

Use this data source to retrieve information about a Rancher v2 cluster.

Example Usage

using Pulumi;
using Rancher2 = Pulumi.Rancher2;

class MyStack : Stack
{
    public MyStack()
    {
        var foo_custom = Output.Create(Rancher2.GetCluster.InvokeAsync(new Rancher2.GetClusterArgs
        {
            Name = "foo-custom",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-rancher2/sdk/v2/go/rancher2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := rancher2.LookupCluster(ctx, &rancher2.LookupClusterArgs{
            Name: "foo-custom",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_rancher2 as rancher2

foo_custom = rancher2.get_cluster(name="foo-custom")
import * as pulumi from "@pulumi/pulumi";
import * as rancher2 from "@pulumi/rancher2";

const foo_custom = pulumi.output(rancher2.getCluster({
    name: "foo-custom",
}, { async: true }));

Using getCluster

function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
def get_cluster(name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetClusterResult
func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)

Note: This function is named LookupCluster in the Go SDK.

public static class GetCluster {
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string

The name of the Cluster (string)

Name string

The name of the Cluster (string)

name string

The name of the Cluster (string)

name str

The name of the Cluster (string)

getCluster Result

The following output properties are available:

AksConfig GetClusterAksConfig

(Computed) The Azure aks configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

Annotations Dictionary<string, object>

(Computed) Annotations for Node Pool object (map)

ClusterAuthEndpoint GetClusterClusterAuthEndpoint

(Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

ClusterMonitoringInput GetClusterClusterMonitoringInput

(Computed) Cluster monitoring config (list maxitems:1)

ClusterRegistrationToken GetClusterClusterRegistrationToken

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

ClusterTemplateAnswers GetClusterClusterTemplateAnswers

(Computed) Cluster template answers (list maxitems:1)

ClusterTemplateId string

(Computed) Cluster template ID (string)

ClusterTemplateQuestions List<GetClusterClusterTemplateQuestion>

(Computed) Cluster template questions (list)

ClusterTemplateRevisionId string

(Computed) Cluster template revision ID (string)

DefaultPodSecurityPolicyTemplateId string

(Optional/Computed) Default pod security policy template id (string)

DefaultProjectId string

(Computed) Default project ID for the cluster (string)

Description string

(Computed) The description for Cluster (string)

Driver string

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

EksConfig GetClusterEksConfig

(Computed) The Amazon eks configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

EksConfigV2 GetClusterEksConfigV2
EnableClusterAlerting bool
EnableClusterMonitoring bool

(Computed) Enable built-in cluster monitoring. Default false (bool)

EnableNetworkPolicy bool

(Computed) Enable project network isolation. Default false (bool)

GkeConfig GetClusterGkeConfig

(Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

Id string

The provider-assigned unique ID for this managed resource.

K3sConfig GetClusterK3sConfig

(Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)

KubeConfig string

(Computed) Kube Config generated for the cluster (string)

Labels Dictionary<string, object>

(Computed) Labels for Node Pool object (map)

Name string
OkeConfig GetClusterOkeConfig
RkeConfig GetClusterRkeConfig

(Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

ScheduledClusterScans List<GetClusterScheduledClusterScan>
SystemProjectId string

(Computed) System project ID for the cluster (string)

AksConfig GetClusterAksConfig

(Computed) The Azure aks configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

Annotations map[string]interface{}

(Computed) Annotations for Node Pool object (map)

ClusterAuthEndpoint GetClusterClusterAuthEndpoint

(Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

ClusterMonitoringInput GetClusterClusterMonitoringInput

(Computed) Cluster monitoring config (list maxitems:1)

ClusterRegistrationToken GetClusterClusterRegistrationToken

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

ClusterTemplateAnswers GetClusterClusterTemplateAnswers

(Computed) Cluster template answers (list maxitems:1)

ClusterTemplateId string

(Computed) Cluster template ID (string)

ClusterTemplateQuestions []GetClusterClusterTemplateQuestion

(Computed) Cluster template questions (list)

ClusterTemplateRevisionId string

(Computed) Cluster template revision ID (string)

DefaultPodSecurityPolicyTemplateId string

(Optional/Computed) Default pod security policy template id (string)

DefaultProjectId string

(Computed) Default project ID for the cluster (string)

Description string

(Computed) The description for Cluster (string)

Driver string

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

EksConfig GetClusterEksConfig

(Computed) The Amazon eks configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

EksConfigV2 GetClusterEksConfigV2
EnableClusterAlerting bool
EnableClusterMonitoring bool

(Computed) Enable built-in cluster monitoring. Default false (bool)

EnableNetworkPolicy bool

(Computed) Enable project network isolation. Default false (bool)

GkeConfig GetClusterGkeConfig

(Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

Id string

The provider-assigned unique ID for this managed resource.

K3sConfig GetClusterK3sConfig

(Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)

KubeConfig string

(Computed) Kube Config generated for the cluster (string)

Labels map[string]interface{}

(Computed) Labels for Node Pool object (map)

Name string
OkeConfig GetClusterOkeConfig
RkeConfig GetClusterRkeConfig

(Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

ScheduledClusterScans []GetClusterScheduledClusterScan
SystemProjectId string

(Computed) System project ID for the cluster (string)

aksConfig GetClusterAksConfig

(Computed) The Azure aks configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

annotations {[key: string]: any}

(Computed) Annotations for Node Pool object (map)

clusterAuthEndpoint GetClusterClusterAuthEndpoint

(Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

clusterMonitoringInput GetClusterClusterMonitoringInput

(Computed) Cluster monitoring config (list maxitems:1)

clusterRegistrationToken GetClusterClusterRegistrationToken

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

clusterTemplateAnswers GetClusterClusterTemplateAnswers

(Computed) Cluster template answers (list maxitems:1)

clusterTemplateId string

(Computed) Cluster template ID (string)

clusterTemplateQuestions GetClusterClusterTemplateQuestion[]

(Computed) Cluster template questions (list)

clusterTemplateRevisionId string

(Computed) Cluster template revision ID (string)

defaultPodSecurityPolicyTemplateId string

(Optional/Computed) Default pod security policy template id (string)

defaultProjectId string

(Computed) Default project ID for the cluster (string)

description string

(Computed) The description for Cluster (string)

driver string

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

eksConfig GetClusterEksConfig

(Computed) The Amazon eks configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

eksConfigV2 GetClusterEksConfigV2
enableClusterAlerting boolean
enableClusterMonitoring boolean

(Computed) Enable built-in cluster monitoring. Default false (bool)

enableNetworkPolicy boolean

(Computed) Enable project network isolation. Default false (bool)

gkeConfig GetClusterGkeConfig

(Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

id string

The provider-assigned unique ID for this managed resource.

k3sConfig GetClusterK3sConfig

(Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)

kubeConfig string

(Computed) Kube Config generated for the cluster (string)

labels {[key: string]: any}

(Computed) Labels for Node Pool object (map)

name string
okeConfig GetClusterOkeConfig
rkeConfig GetClusterRkeConfig

(Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

scheduledClusterScans GetClusterScheduledClusterScan[]
systemProjectId string

(Computed) System project ID for the cluster (string)

aks_config GetClusterAksConfig

(Computed) The Azure aks configuration for aks Clusters. Conflicts with eks_config, gke_config and rke_config (list maxitems:1)

annotations Mapping[str, Any]

(Computed) Annotations for Node Pool object (map)

cluster_auth_endpoint GetClusterClusterAuthEndpoint

(Computed) Enabling the local cluster authorized endpoint allows direct communication with the cluster, bypassing the Rancher API proxy. (list maxitems:1)

cluster_monitoring_input GetClusterClusterMonitoringInput

(Computed) Cluster monitoring config (list maxitems:1)

cluster_registration_token GetClusterClusterRegistrationToken

(Computed) Cluster Registration Token generated for the cluster (list maxitems:1)

cluster_template_answers GetClusterClusterTemplateAnswers

(Computed) Cluster template answers (list maxitems:1)

cluster_template_id str

(Computed) Cluster template ID (string)

cluster_template_questions Sequence[GetClusterClusterTemplateQuestion]

(Computed) Cluster template questions (list)

cluster_template_revision_id str

(Computed) Cluster template revision ID (string)

default_pod_security_policy_template_id str

(Optional/Computed) Default pod security policy template id (string)

default_project_id str

(Computed) Default project ID for the cluster (string)

description str

(Computed) The description for Cluster (string)

driver str

(Computed) The driver used for the Cluster. imported, azurekubernetesservice, amazonelasticcontainerservice, googlekubernetesengine and rancherKubernetesEngine are supported (string)

eks_config GetClusterEksConfig

(Computed) The Amazon eks configuration for eks Clusters. Conflicts with aks_config, gke_config and rke_config (list maxitems:1)

eks_config_v2 GetClusterEksConfigV2
enable_cluster_alerting bool
enable_cluster_monitoring bool

(Computed) Enable built-in cluster monitoring. Default false (bool)

enable_network_policy bool

(Computed) Enable project network isolation. Default false (bool)

gke_config GetClusterGkeConfig

(Computed) The Google gke configuration for gke Clusters. Conflicts with aks_config, eks_config and rke_config (list maxitems:1)

id str

The provider-assigned unique ID for this managed resource.

k3s_config GetClusterK3sConfig

(Computed) The K3S configuration for k3s imported Clusters. Conflicts with aks_config, eks_config, gke_config and rke_config (list maxitems:1)

kube_config str

(Computed) Kube Config generated for the cluster (string)

labels Mapping[str, Any]

(Computed) Labels for Node Pool object (map)

name str
oke_config GetClusterOkeConfig
rke_config GetClusterRkeConfig

(Computed) The RKE configuration for rke Clusters. Conflicts with aks_config, eks_config and gke_config (list maxitems:1)

scheduled_cluster_scans Sequence[GetClusterScheduledClusterScan]
system_project_id str

(Computed) System project ID for the cluster (string)

Supporting Types

GetClusterAksConfig

GetClusterClusterAuthEndpoint

CaCerts string
Enabled bool
Fqdn string
CaCerts string
Enabled bool
Fqdn string
caCerts string
enabled boolean
fqdn string
ca_certs str
enabled bool
fqdn str

GetClusterClusterMonitoringInput

Answers Dictionary<string, object>
Version string
Answers map[string]interface{}
Version string
answers {[key: string]: any}
version string
answers Mapping[str, Any]
version str

GetClusterClusterRegistrationToken

Annotations Dictionary<string, object>

(Computed) Annotations for Node Pool object (map)

ClusterId string
Command string
Id string

(Computed) The ID of the resource (string)

InsecureCommand string
Labels Dictionary<string, object>

(Computed) Labels for Node Pool object (map)

ManifestUrl string
Name string

The name of the Cluster (string)

NodeCommand string
Token string
WindowsNodeCommand string
Annotations map[string]interface{}

(Computed) Annotations for Node Pool object (map)

ClusterId string
Command string
Id string

(Computed) The ID of the resource (string)

InsecureCommand string
Labels map[string]interface{}

(Computed) Labels for Node Pool object (map)

ManifestUrl string
Name string

The name of the Cluster (string)

NodeCommand string
Token string
WindowsNodeCommand string
annotations {[key: string]: any}

(Computed) Annotations for Node Pool object (map)

clusterId string
command string
id string

(Computed) The ID of the resource (string)

insecureCommand string
labels {[key: string]: any}

(Computed) Labels for Node Pool object (map)

manifestUrl string
name string

The name of the Cluster (string)

nodeCommand string
token string
windowsNodeCommand string
annotations Mapping[str, Any]

(Computed) Annotations for Node Pool object (map)

cluster_id str
command str
id str

(Computed) The ID of the resource (string)

insecure_command str
labels Mapping[str, Any]

(Computed) Labels for Node Pool object (map)

manifest_url str
name str

The name of the Cluster (string)

node_command str
token str
windows_node_command str

GetClusterClusterTemplateAnswers

ClusterId string
ProjectId string
Values Dictionary<string, object>
ClusterId string
ProjectId string
Values map[string]interface{}
clusterId string
projectId string
values {[key: string]: any}
cluster_id str
project_id str
values Mapping[str, Any]

GetClusterClusterTemplateQuestion

Default string
Variable string
Required bool
Type string
Default string
Variable string
Required bool
Type string
default string
variable string
required boolean
type string

GetClusterEksConfig

GetClusterEksConfigV2

CloudCredentialId string
KubernetesVersion string
Name string

The name of the Cluster (string)

NodeGroups List<GetClusterEksConfigV2NodeGroupArgs>
Imported bool
KmsKey string
LoggingTypes List<string>
PrivateAccess bool
PublicAccess bool
PublicAccessSources List<string>
Region string
SecretsEncryption bool
SecurityGroups List<string>
ServiceRole string
Subnets List<string>
Tags Dictionary<string, object>
CloudCredentialId string
KubernetesVersion string
Name string

The name of the Cluster (string)

NodeGroups []GetClusterEksConfigV2NodeGroup
Imported bool
KmsKey string
LoggingTypes []string
PrivateAccess bool
PublicAccess bool
PublicAccessSources []string
Region string
SecretsEncryption bool
SecurityGroups []string
ServiceRole string
Subnets []string
Tags map[string]interface{}
cloudCredentialId string
kubernetesVersion string
name string

The name of the Cluster (string)

nodeGroups GetClusterEksConfigV2NodeGroup[]
imported boolean
kmsKey string
loggingTypes string[]
privateAccess boolean
publicAccess boolean
publicAccessSources string[]
region string
secretsEncryption boolean
securityGroups string[]
serviceRole string
subnets string[]
tags {[key: string]: any}

GetClusterEksConfigV2NodeGroup

Name string

The name of the Cluster (string)

DesiredSize int
DiskSize int
Ec2SshKey string
Gpu bool
InstanceType string
Labels Dictionary<string, object>

(Computed) Labels for Node Pool object (map)

MaxSize int
MinSize int
Tags Dictionary<string, object>
Name string

The name of the Cluster (string)

DesiredSize int
DiskSize int
Ec2SshKey string
Gpu bool
InstanceType string
Labels map[string]interface{}

(Computed) Labels for Node Pool object (map)

MaxSize int
MinSize int
Tags map[string]interface{}
name string

The name of the Cluster (string)

desiredSize number
diskSize number
ec2SshKey string
gpu boolean
instanceType string
labels {[key: string]: any}

(Computed) Labels for Node Pool object (map)

maxSize number
minSize number
tags {[key: string]: any}
name str

The name of the Cluster (string)

desired_size int
disk_size int
ec2_ssh_key str
gpu bool
instance_type str
labels Mapping[str, Any]

(Computed) Labels for Node Pool object (map)

max_size int
min_size int
tags Mapping[str, Any]

GetClusterGkeConfig

ClusterIpv4Cidr string
Credential string
DiskType string
ImageType string
IpPolicyClusterIpv4CidrBlock string
IpPolicyClusterSecondaryRangeName string
IpPolicyNodeIpv4CidrBlock string
IpPolicyServicesIpv4CidrBlock string
IpPolicyServicesSecondaryRangeName string
IpPolicySubnetworkName string
Labels Dictionary<string, object>

(Computed) Labels for Node Pool object (map)

Locations List<string>
MachineType string
MaintenanceWindow string
MasterIpv4CidrBlock string
MasterVersion string
Network string
NodePool string
NodeVersion string
OauthScopes List<string>
ProjectId string
ResourceLabels Dictionary<string, object>
ServiceAccount string
SubNetwork string
Description string

(Computed) The description for Cluster (string)

DiskSizeGb int
EnableAlphaFeature bool
EnableAutoRepair bool
EnableAutoUpgrade bool
EnableHorizontalPodAutoscaling bool
EnableHttpLoadBalancing bool
EnableKubernetesDashboard bool
EnableLegacyAbac bool
EnableMasterAuthorizedNetwork bool
EnableNetworkPolicyConfig bool
EnableNodepoolAutoscaling bool
EnablePrivateEndpoint bool
EnablePrivateNodes bool
EnableStackdriverLogging bool
EnableStackdriverMonitoring bool
IpPolicyCreateSubnetwork bool
IssueClientCertificate bool
KubernetesDashboard bool
LocalSsdCount int
MasterAuthorizedNetworkCidrBlocks List<string>
MaxNodeCount int
MinNodeCount int
NodeCount int
Preemptible bool
Region string
Taints List<string>
UseIpAliases bool
Zone string
ClusterIpv4Cidr string
Credential string
DiskType string
ImageType string
IpPolicyClusterIpv4CidrBlock string
IpPolicyClusterSecondaryRangeName string
IpPolicyNodeIpv4CidrBlock string
IpPolicyServicesIpv4CidrBlock string
IpPolicyServicesSecondaryRangeName string
IpPolicySubnetworkName string
Labels map[string]interface{}

(Computed) Labels for Node Pool object (map)

Locations []string
MachineType string
MaintenanceWindow string
MasterIpv4CidrBlock string
MasterVersion string
Network string
NodePool string
NodeVersion string
OauthScopes []string
ProjectId string
ResourceLabels map[string]interface{}
ServiceAccount string
SubNetwork string
Description string

(Computed) The description for Cluster (string)

DiskSizeGb int
EnableAlphaFeature bool
EnableAutoRepair bool
EnableAutoUpgrade bool
EnableHorizontalPodAutoscaling bool
EnableHttpLoadBalancing bool
EnableKubernetesDashboard bool
EnableLegacyAbac bool
EnableMasterAuthorizedNetwork bool
EnableNetworkPolicyConfig bool
EnableNodepoolAutoscaling bool
EnablePrivateEndpoint bool
EnablePrivateNodes bool
EnableStackdriverLogging bool
EnableStackdriverMonitoring bool
IpPolicyCreateSubnetwork bool
IssueClientCertificate bool
KubernetesDashboard bool
LocalSsdCount int
MasterAuthorizedNetworkCidrBlocks []string
MaxNodeCount int
MinNodeCount int
NodeCount int
Preemptible bool
Region string
Taints []string
UseIpAliases bool
Zone string
clusterIpv4Cidr string
credential string
diskType string
imageType string
ipPolicyClusterIpv4CidrBlock string
ipPolicyClusterSecondaryRangeName string
ipPolicyNodeIpv4CidrBlock string
ipPolicyServicesIpv4CidrBlock string
ipPolicyServicesSecondaryRangeName string
ipPolicySubnetworkName string
labels {[key: string]: any}

(Computed) Labels for Node Pool object (map)

locations string[]
machineType string
maintenanceWindow string
masterIpv4CidrBlock string
masterVersion string
network string
nodePool string
nodeVersion string
oauthScopes string[]
projectId string
resourceLabels {[key: string]: any}
serviceAccount string
subNetwork string
description string

(Computed) The description for Cluster (string)

diskSizeGb number
enableAlphaFeature boolean
enableAutoRepair boolean
enableAutoUpgrade boolean
enableHorizontalPodAutoscaling boolean
enableHttpLoadBalancing boolean
enableKubernetesDashboard boolean
enableLegacyAbac boolean
enableMasterAuthorizedNetwork boolean
enableNetworkPolicyConfig boolean
enableNodepoolAutoscaling boolean
enablePrivateEndpoint boolean
enablePrivateNodes boolean
enableStackdriverLogging boolean
enableStackdriverMonitoring boolean
ipPolicyCreateSubnetwork boolean
issueClientCertificate boolean
kubernetesDashboard boolean
localSsdCount number
masterAuthorizedNetworkCidrBlocks string[]
maxNodeCount number
minNodeCount number
nodeCount number
preemptible boolean
region string
taints string[]
useIpAliases boolean
zone string
cluster_ipv4_cidr str
credential str
disk_type str
image_type str
ip_policy_cluster_ipv4_cidr_block str
ip_policy_cluster_secondary_range_name str
ip_policy_node_ipv4_cidr_block str
ip_policy_services_ipv4_cidr_block str
ip_policy_services_secondary_range_name str
ip_policy_subnetwork_name str
labels Mapping[str, Any]

(Computed) Labels for Node Pool object (map)

locations Sequence[str]
machine_type str
maintenance_window str
master_ipv4_cidr_block str
master_version str
network str
node_pool str
node_version str
oauth_scopes Sequence[str]
project_id str
resource_labels Mapping[str, Any]
service_account str
sub_network str
description str

(Computed) The description for Cluster (string)

disk_size_gb int
enable_alpha_feature bool
enable_auto_repair bool
enable_auto_upgrade bool
enable_horizontal_pod_autoscaling bool
enable_http_load_balancing bool
enable_kubernetes_dashboard bool
enable_legacy_abac bool
enable_master_authorized_network bool
enable_network_policy_config bool
enable_nodepool_autoscaling bool
enable_private_endpoint bool
enable_private_nodes bool
enable_stackdriver_logging bool
enable_stackdriver_monitoring bool
ip_policy_create_subnetwork bool
issue_client_certificate bool
kubernetes_dashboard bool
local_ssd_count int
master_authorized_network_cidr_blocks Sequence[str]
max_node_count int
min_node_count int
node_count int
preemptible bool
region str
taints Sequence[str]
use_ip_aliases bool
zone str

GetClusterK3sConfig

GetClusterK3sConfigUpgradeStrategy

GetClusterOkeConfig

GetClusterRkeConfig

GetClusterRkeConfigAuthentication

Sans List<string>
Strategy string
Sans []string
Strategy string
sans string[]
strategy string
sans Sequence[str]
strategy str

GetClusterRkeConfigAuthorization

Options Dictionary<string, object>
Mode string
Options map[string]interface{}
Mode string
options {[key: string]: any}
mode string
options Mapping[str, Any]
mode str

GetClusterRkeConfigBastionHost

Address string
SshKey string
SshKeyPath string
User string
Port string
SshAgentAuth bool
Address string
SshKey string
SshKeyPath string
User string
Port string
SshAgentAuth bool
address string
sshKey string
sshKeyPath string
user string
port string
sshAgentAuth boolean

GetClusterRkeConfigCloudProvider

GetClusterRkeConfigCloudProviderAwsCloudProvider

GetClusterRkeConfigCloudProviderAwsCloudProviderGlobal

GetClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

Region string
Service string
SigningMethod string
SigningName string
SigningRegion string
Url string
Region string
Service string
SigningMethod string
SigningName string
SigningRegion string
Url string
region string
service string
signingMethod string
signingName string
signingRegion string
url string

GetClusterRkeConfigCloudProviderAzureCloudProvider

GetClusterRkeConfigCloudProviderOpenstackCloudProvider

GetClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

GetClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal

AuthUrl string
CaFile string
DomainId string
DomainName string
Password string
Region string
TenantId string
TenantName string
TrustId string
Username string
AuthUrl string
CaFile string
DomainId string
DomainName string
Password string
Region string
TenantId string
TenantName string
TrustId string
Username string
authUrl string
caFile string
domainId string
domainName string
password string
region string
tenantId string
tenantName string
trustId string
username string

GetClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

GetClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

GetClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

RouterId string
RouterId string
routerId string

GetClusterRkeConfigCloudProviderVsphereCloudProvider

GetClusterRkeConfigCloudProviderVsphereCloudProviderDisk

GetClusterRkeConfigCloudProviderVsphereCloudProviderGlobal

datacenters string
insecureFlag boolean
password string
port string
soapRoundtripCount number
user string

GetClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

GetClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

Datacenters string
Name string

The name of the Cluster (string)

Password string
Port string
SoapRoundtripCount int
User string
Datacenters string
Name string

The name of the Cluster (string)

Password string
Port string
SoapRoundtripCount int
User string
datacenters string
name string

The name of the Cluster (string)

password string
port string
soapRoundtripCount number
user string
datacenters str
name str

The name of the Cluster (string)

password str
port str
soap_roundtrip_count int
user str

GetClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace

GetClusterRkeConfigDns

GetClusterRkeConfigDnsLinearAutoscalerParams

GetClusterRkeConfigDnsNodelocal

IpAddress string
NodeSelector Dictionary<string, object>
IpAddress string
NodeSelector map[string]interface{}
ipAddress string
nodeSelector {[key: string]: any}
ip_address str
node_selector Mapping[str, Any]

GetClusterRkeConfigDnsUpdateStrategy

GetClusterRkeConfigDnsUpdateStrategyRollingUpdate

GetClusterRkeConfigIngress

DnsPolicy string
ExtraArgs Dictionary<string, object>
NodeSelector Dictionary<string, object>
Options Dictionary<string, object>
Provider string
DnsPolicy string
ExtraArgs map[string]interface{}
NodeSelector map[string]interface{}
Options map[string]interface{}
Provider string
dnsPolicy string
extraArgs {[key: string]: any}
nodeSelector {[key: string]: any}
options {[key: string]: any}
provider string
dns_policy str
extra_args Mapping[str, Any]
node_selector Mapping[str, Any]
options Mapping[str, Any]
provider str

GetClusterRkeConfigMonitoring

Options Dictionary<string, object>
Provider string
Replicas int
NodeSelector Dictionary<string, object>
UpdateStrategy GetClusterRkeConfigMonitoringUpdateStrategyArgs

GetClusterRkeConfigMonitoringUpdateStrategy

GetClusterRkeConfigMonitoringUpdateStrategyRollingUpdate

GetClusterRkeConfigNetwork

GetClusterRkeConfigNetworkCalicoNetworkProvider

GetClusterRkeConfigNetworkCanalNetworkProvider

Iface string
Iface string
iface string
iface str

GetClusterRkeConfigNetworkFlannelNetworkProvider

Iface string
Iface string
iface string
iface str

GetClusterRkeConfigNetworkWeaveNetworkProvider

Password string
Password string
password string

GetClusterRkeConfigNode

Address string
DockerSocket string
Roles List<string>
SshKey string
SshKeyPath string
User string
HostnameOverride string
InternalAddress string
Labels Dictionary<string, object>

(Computed) Labels for Node Pool object (map)

NodeId string
Port string
SshAgentAuth bool
Address string
DockerSocket string
Roles []string
SshKey string
SshKeyPath string
User string
HostnameOverride string
InternalAddress string
Labels map[string]interface{}

(Computed) Labels for Node Pool object (map)

NodeId string
Port string
SshAgentAuth bool
address string
dockerSocket string
roles string[]
sshKey string
sshKeyPath string
user string
hostnameOverride string
internalAddress string
labels {[key: string]: any}

(Computed) Labels for Node Pool object (map)

nodeId string
port string
sshAgentAuth boolean
address str
docker_socket str
roles Sequence[str]
ssh_key str
ssh_key_path str
user str
hostname_override str
internal_address str
labels Mapping[str, Any]

(Computed) Labels for Node Pool object (map)

node_id str
port str
ssh_agent_auth bool

GetClusterRkeConfigPrivateRegistry

Url string
IsDefault bool
Password string
User string
Url string
IsDefault bool
Password string
User string
url string
isDefault boolean
password string
user string
url str
is_default bool
password str
user str

GetClusterRkeConfigServices

GetClusterRkeConfigServicesEtcd

BackupConfig GetClusterRkeConfigServicesEtcdBackupConfigArgs
CaCert string

(Computed) K8s cluster ca cert (string)

Cert string
Creation string
ExtraArgs Dictionary<string, object>
Image string
Key string
Path string
Retention string
Snapshot bool
ExternalUrls List<string>
ExtraBinds List<string>
ExtraEnvs List<string>
Gid int
Uid int
BackupConfig GetClusterRkeConfigServicesEtcdBackupConfig
CaCert string

(Computed) K8s cluster ca cert (string)

Cert string
Creation string
ExtraArgs map[string]interface{}
Image string
Key string
Path string
Retention string
Snapshot bool
ExternalUrls []string
ExtraBinds []string
ExtraEnvs []string
Gid int
Uid int
backupConfig GetClusterRkeConfigServicesEtcdBackupConfig
caCert string

(Computed) K8s cluster ca cert (string)

cert string
creation string
extraArgs {[key: string]: any}
image string
key string
path string
retention string
snapshot boolean
externalUrls string[]
extraBinds string[]
extraEnvs string[]
gid number
uid number
backup_config GetClusterRkeConfigServicesEtcdBackupConfigArgs
ca_cert str

(Computed) K8s cluster ca cert (string)

cert str
creation str
extra_args Mapping[str, Any]
image str
key str
path str
retention str
snapshot bool
external_urls Sequence[str]
extra_binds Sequence[str]
extra_envs Sequence[str]
gid int
uid int

GetClusterRkeConfigServicesEtcdBackupConfig

GetClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig

BucketName string
Endpoint string
AccessKey string
CustomCa string
Folder string
Region string
SecretKey string
BucketName string
Endpoint string
AccessKey string
CustomCa string
Folder string
Region string
SecretKey string
bucketName string
endpoint string
accessKey string
customCa string
folder string
region string
secretKey string

GetClusterRkeConfigServicesKubeApi

GetClusterRkeConfigServicesKubeApiAuditLog

GetClusterRkeConfigServicesKubeApiAuditLogConfiguration

Policy string
Format string
MaxAge int
MaxBackup int
MaxSize int
Path string
Policy string
Format string
MaxAge int
MaxBackup int
MaxSize int
Path string
policy string
format string
maxAge number
maxBackup number
maxSize number
path string

GetClusterRkeConfigServicesKubeApiEventRateLimit

configuration string
enabled boolean

GetClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

customConfig string
enabled boolean

GetClusterRkeConfigServicesKubeController

ClusterCidr string
ExtraArgs Dictionary<string, object>
Image string
ServiceClusterIpRange string
ExtraBinds List<string>
ExtraEnvs List<string>
ClusterCidr string
ExtraArgs map[string]interface{}
Image string
ServiceClusterIpRange string
ExtraBinds []string
ExtraEnvs []string
clusterCidr string
extraArgs {[key: string]: any}
image string
serviceClusterIpRange string
extraBinds string[]
extraEnvs string[]
cluster_cidr str
extra_args Mapping[str, Any]
image str
service_cluster_ip_range str
extra_binds Sequence[str]
extra_envs Sequence[str]

GetClusterRkeConfigServicesKubelet

ClusterDnsServer string
ClusterDomain string
ExtraArgs Dictionary<string, object>
FailSwapOn bool
Image string
InfraContainerImage string
ExtraBinds List<string>
ExtraEnvs List<string>
GenerateServingCertificate bool
ClusterDnsServer string
ClusterDomain string
ExtraArgs map[string]interface{}
FailSwapOn bool
Image string
InfraContainerImage string
ExtraBinds []string
ExtraEnvs []string
GenerateServingCertificate bool
clusterDnsServer string
clusterDomain string
extraArgs {[key: string]: any}
failSwapOn boolean
image string
infraContainerImage string
extraBinds string[]
extraEnvs string[]
generateServingCertificate boolean

GetClusterRkeConfigServicesKubeproxy

ExtraArgs Dictionary<string, object>
Image string
ExtraBinds List<string>
ExtraEnvs List<string>
ExtraArgs map[string]interface{}
Image string
ExtraBinds []string
ExtraEnvs []string
extraArgs {[key: string]: any}
image string
extraBinds string[]
extraEnvs string[]
extra_args Mapping[str, Any]
image str
extra_binds Sequence[str]
extra_envs Sequence[str]

GetClusterRkeConfigServicesScheduler

ExtraArgs Dictionary<string, object>
Image string
ExtraBinds List<string>
ExtraEnvs List<string>
ExtraArgs map[string]interface{}
Image string
ExtraBinds []string
ExtraEnvs []string
extraArgs {[key: string]: any}
image string
extraBinds string[]
extraEnvs string[]
extra_args Mapping[str, Any]
image str
extra_binds Sequence[str]
extra_envs Sequence[str]

GetClusterRkeConfigUpgradeStrategy

GetClusterRkeConfigUpgradeStrategyDrainInput

deleteLocalData boolean
force boolean
gracePeriod number
ignoreDaemonSets boolean
timeout number

GetClusterScheduledClusterScan

GetClusterScheduledClusterScanScanConfig

GetClusterScheduledClusterScanScanConfigCisScanConfig

GetClusterScheduledClusterScanScheduleConfig

cronSchedule string
retention number

Package Details

Repository
https://github.com/pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.