1. Docs
  2. Reference
  3. API
  4. @pulumi/rancher2
  5. types
  6. output

Module types/output

APIs

APIs

interface CloudCredentialAmazonec2CredentialConfig

interface CloudCredentialAmazonec2CredentialConfig

property accessKey

accessKey: string;

AWS access key (string)

property secretKey

secretKey: string;

AWS secret key (string)

interface CloudCredentialAzureCredentialConfig

interface CloudCredentialAzureCredentialConfig

property clientId

clientId: string;

Azure Service Principal Account ID (string)

property clientSecret

clientSecret: string;

Azure Service Principal Account password (string)

property subscriptionId

subscriptionId: string;

Azure Subscription ID (string)

interface CloudCredentialDigitaloceanCredentialConfig

interface CloudCredentialDigitaloceanCredentialConfig

property accessToken

accessToken: string;

DigitalOcean access token (string)

interface CloudCredentialLinodeCredentialConfig

interface CloudCredentialLinodeCredentialConfig

property token

token: string;

Linode API token (string)

interface CloudCredentialOpenstackCredentialConfig

interface CloudCredentialOpenstackCredentialConfig

property password

password: string;

vSphere password (string)

interface CloudCredentialVsphereCredentialConfig

interface CloudCredentialVsphereCredentialConfig

property password

password: string;

vSphere password (string)

property username

username: string;

vSphere username (string)

property vcenter

vcenter: string;

vSphere IP/hostname for vCenter (string)

property vcenterPort

vcenterPort?: undefined | string;

vSphere Port for vCenter. Default 443 (string)

interface ClusterAksConfig

interface ClusterAksConfig

property aadServerAppSecret

aadServerAppSecret?: undefined | string;

The secret of an Azure Active Directory server application (string)

property aadTenantId

aadTenantId?: undefined | string;

The ID of an Azure Active Directory tenant (string)

property addClientAppId

addClientAppId?: undefined | string;

The ID of an Azure Active Directory client application of type \“Native\“. This application is for user login via kubectl (string)

property addServerAppId

addServerAppId?: undefined | string;

The ID of an Azure Active Directory server application of type \“Web app/API\“. This application represents the managed cluster’s apiserver (Server application) (string)

property adminUsername

adminUsername?: undefined | string;

The administrator username to use for Linux hosts. Default azureuser (string)

property agentDnsPrefix

agentDnsPrefix: string;

DNS prefix to be used to create the FQDN for the agent pool (string)

property agentOsDiskSize

agentOsDiskSize?: undefined | number;

GB size to be used to specify the disk for every machine in the agent pool. If you specify 0, it will apply the default according to the \“agent vm size\” specified. Default 0 (int)

property agentPoolName

agentPoolName?: undefined | string;

Name for the agent pool, upto 12 alphanumeric characters. Default agentpool0 (string)

property agentStorageProfile

agentStorageProfile?: undefined | string;

Storage profile specifies what kind of storage used on machine in the agent pool. Chooses from [ManagedDisks StorageAccount]. Default ManagedDisks (string)

property agentVmSize

agentVmSize?: undefined | string;

Size of machine in the agent pool. Default Standard_D1_v2 (string)

property authBaseUrl

authBaseUrl?: undefined | string;

Different authentication API url to use. Default https://login.microsoftonline.com/ (string)

property baseUrl

baseUrl?: undefined | string;

Different resource management API url to use. Default https://management.azure.com/ (string)

property clientId

clientId: string;

Azure client ID to use (string)

property clientSecret

clientSecret: string;

Azure client secret associated with the \“client id\” (string)

property count

count?: undefined | number;

Number of machines (VMs) in the agent pool. Allowed values must be in the range of 1 to 100 (inclusive). Default 1 (int)

property dnsServiceIp

dnsServiceIp?: undefined | string;

An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes Service address range specified in \“service cidr\“. Default 10.0.0.10 (string)

property dockerBridgeCidr

dockerBridgeCidr?: undefined | string;

A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes Service address range specified in \“service cidr\“. Default 172.17.0.1/16 (string)

property enableHttpApplicationRouting

enableHttpApplicationRouting?: undefined | false | true;

Enable the Kubernetes ingress with automatic public DNS name creation. Default false (bool)

property enableMonitoring

enableMonitoring?: undefined | false | true;

Turn on Azure Log Analytics monitoring. Uses the Log Analytics \“Default\” workspace if it exists, else creates one. if using an existing workspace, specifies \“log analytics workspace resource id\“. Default true (bool)

property kubernetesVersion

kubernetesVersion: string;

The Kubernetes master version (string)

property location

location?: undefined | string;

Azure Kubernetes cluster location. Default eastus (string)

property logAnalyticsWorkspace

logAnalyticsWorkspace?: undefined | string;

The name of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses ‘{resource group}-{subscription id}-{location code}’ (string)

property logAnalyticsWorkspaceResourceGroup

logAnalyticsWorkspaceResourceGroup?: undefined | string;

The resource group of an existing Azure Log Analytics Workspace to use for storing monitoring data. If not specified, uses the ‘Cluster’ resource group (string)

property masterDnsPrefix

masterDnsPrefix: string;

DNS prefix to use the Kubernetes cluster control pane (string)

property maxPods

maxPods?: undefined | number;

Maximum number of pods that can run on a node. Default 110 (int)

property networkPlugin

networkPlugin?: undefined | string;

Network plugin used for building Kubernetes network. Chooses from azure or kubenet. Default azure (string)

property networkPolicy

networkPolicy?: undefined | string;

Network policy used for building Kubernetes network. Chooses from calico (string)

property podCidr

podCidr?: undefined | string;

A CIDR notation IP range from which to assign Kubernetes Pod IPs when \“network plugin\” is specified in \“kubenet\“. Default 172.244.0.0/16 (string)

property resourceGroup

resourceGroup: string;

The name of the Cluster resource group (string)

property serviceCidr

serviceCidr?: undefined | string;

A CIDR notation IP range from which to assign Kubernetes Service cluster IPs. It must not overlap with any Subnet IP ranges. Default 10.0.0.0/16 (string)

property sshPublicKeyContents

sshPublicKeyContents: string;

Contents of the SSH public key used to authenticate with Linux hosts (string)

property subnet

subnet: string;

The name of an existing Azure Virtual Subnet. Composite of agent virtual network subnet ID (string)

property subscriptionId

subscriptionId: string;

Subscription credentials which uniquely identify Microsoft Azure subscription (string)

property tag

tag: {[key: string]: any};

Tags for Kubernetes cluster. For example, foo=bar (map)

property tenantId

tenantId: string;

Azure tenant ID to use (string)

property virtualNetwork

virtualNetwork: string;

The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

property virtualNetworkResourceGroup

virtualNetworkResourceGroup: string;

The resource group of an existing Azure Virtual Network. Composite of agent virtual network subnet ID (string)

interface ClusterAlterGroupRecipient

interface ClusterAlterGroupRecipient

property defaultRecipient

defaultRecipient?: undefined | false | true;

Use notifier default recipient, overriding recipient argument if set. Default: false (bool)

property notifierId

notifierId: string;

Recipient notifier ID (string)

property notifierType

notifierType: string;

Recipient notifier ID. Supported values : "pagerduty" | "slack" | "email" | "webhook" | "wechat" (string)

property recipient

recipient: string;

Recipient (string)

interface ClusterAlterRuleEventRule

interface ClusterAlterRuleEventRule

property eventType

eventType?: undefined | string;

Event type. Supported values : "Warning" | "Normal". Default: Warning (string)

property resourceKind

resourceKind: string;

Resource kind. Supported values : "DaemonSet" | "Deployment" | "Node" | "Pod" | "StatefulSet" (string)

interface ClusterAlterRuleMetricRule

interface ClusterAlterRuleMetricRule

property comparison

comparison?: undefined | string;

Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

property description

description?: undefined | string;

Metric rule description (string)

property duration

duration: string;

Metric rule duration (string)

property expression

expression: string;

Metric rule expression (string)

property thresholdValue

thresholdValue: number;

Metric rule threshold value (float64)

interface ClusterAlterRuleNodeRule

interface ClusterAlterRuleNodeRule

property condition

condition?: undefined | string;

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

property cpuThreshold

cpuThreshold?: undefined | number;

Node rule cpu threshold. Default: 70 (int)

property memThreshold

memThreshold?: undefined | number;

Node rule mem threshold. Default: 70 (int)

property nodeId

nodeId?: undefined | string;

Node ID (string)

property selector

selector?: undefined | {[key: string]: any};

Node rule selector (map)

interface ClusterAlterRuleSystemServiceRule

interface ClusterAlterRuleSystemServiceRule

property condition

condition?: undefined | string;

System service rule condition. Supported values : "controller-manager" | "etcd" | "scheduler". Default: scheduler (string)

interface ClusterClusterAuthEndpoint

interface ClusterClusterAuthEndpoint

property caCerts

caCerts?: undefined | string;

CA certs for the authorized cluster endpoint (string)

property enabled

enabled?: undefined | false | true;

Enable scheduled cluster scan. Default: false (bool)

property fqdn

fqdn?: undefined | string;

FQDN for the authorized cluster endpoint (string)

interface ClusterClusterMonitoringInput

interface ClusterClusterMonitoringInput

property answers

answers?: undefined | {[key: string]: any};

Key/value answers for monitor input (map)

property version

version?: undefined | string;

rancher-monitoring chart version (string)

interface ClusterClusterRegistrationToken

interface ClusterClusterRegistrationToken

property annotations

annotations: {[key: string]: any};

Annotations for cluster registration token object (map)

property clusterId

clusterId: string;

Cluster ID (string)

property command

command: string;

Command to execute in a imported k8s cluster (string)

property id

id: string;

(Computed) The ID of the resource (string)

property insecureCommand

insecureCommand: string;

Insecure command to execute in a imported k8s cluster (string)

property labels

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

Labels for cluster registration token object (map)

property manifestUrl

manifestUrl: string;

K8s manifest url to execute with kubectl to import an existing k8s cluster (string)

property name

name: string;

Name of cluster registration token (string)

property nodeCommand

nodeCommand: string;

Node command to execute in linux nodes for custom k8s cluster (string)

property token

token: string;

Token for cluster registration token object (string)

property windowsNodeCommand

windowsNodeCommand: string;

Node command to execute in windows nodes for custom k8s cluster (string)

interface ClusterClusterTemplateAnswers

interface ClusterClusterTemplateAnswers

property clusterId

clusterId: string;

Cluster ID (string)

property projectId

projectId: string;

Project ID to apply answer (string)

property values

values: {[key: string]: any};

Key/values for answer (map)

interface ClusterClusterTemplateQuestion

interface ClusterClusterTemplateQuestion

property default

default: string;

Default variable value (string)

property required

required?: undefined | false | true;

Required variable. Default false (bool)

property type

type?: undefined | string;

Variable type. boolean, int and string are allowed. Default string (string)

property variable

variable: string;

Variable name (string)

interface ClusterEksConfig

interface ClusterEksConfig

property accessKey

accessKey: string;

The AWS Client ID to use (string)

property ami

ami?: undefined | string;

AMI ID to use for the worker nodes instead of the default (string)

property associateWorkerNodePublicIp

associateWorkerNodePublicIp?: undefined | false | true;

Associate public ip EKS worker nodes. Default true (bool)

property desiredNodes

desiredNodes?: undefined | number;

The desired number of worker nodes. Just for Rancher v2.3.x and above. Default 3 (int)

property instanceType

instanceType?: undefined | string;

The type of machine to use for worker nodes. Default t2.medium (string)

property keyPairName

keyPairName?: undefined | string;

Allow user to specify key name to use. Just for Rancher v2.2.7 and above (string)

property kubernetesVersion

kubernetesVersion: string;

The Kubernetes master version (string)

property maximumNodes

maximumNodes?: undefined | number;

The maximum number of worker nodes. Default 3 (int)

property minimumNodes

minimumNodes?: undefined | number;

The minimum number of worker nodes. Default 1 (int)

property nodeVolumeSize

nodeVolumeSize?: undefined | number;

The volume size for each node. Default 20 (int)

property region

region?: undefined | string;

The AWS Region to create the EKS cluster in. Default us-west-2 (string)

property secretKey

secretKey: string;

The AWS Client Secret associated with the Client ID (string)

property securityGroups

securityGroups?: string[];

List of security groups to use for the cluster. If it’s not specified Rancher will create a new security group (list)

property serviceRole

serviceRole?: undefined | string;

The service role to use to perform the cluster operations in AWS. If it’s not specified Rancher will create a new service role (string)

property sessionToken

sessionToken?: undefined | string;

A session token to use with the client key and secret if applicable (string)

property subnets

subnets?: string[];

List of subnets in the virtual network to use. If it’s not specified Rancher will create 3 news subnets (list)

property userData

userData: string;

Pass user-data to the nodes to perform automated configuration tasks (string)

property virtualNetwork

virtualNetwork?: undefined | string;

The name of the virtual network to use. If it’s not specified Rancher will create a new VPC (string)

interface ClusterGkeConfig

interface ClusterGkeConfig

property clusterIpv4Cidr

clusterIpv4Cidr: string;

The IP address range of the container pods (string)

property credential

credential: string;

The contents of the GC credential file (string)

property description

description?: undefined | string;

An optional description of this cluster (string)

property diskSizeGb

diskSizeGb?: undefined | number;

Size of the disk attached to each node. Default 100 (int)

property diskType

diskType: string;

Type of the disk attached to each node (string)

property enableAlphaFeature

enableAlphaFeature?: undefined | false | true;

To enable Kubernetes alpha feature. Default true (bool)

property enableAutoRepair

enableAutoRepair?: undefined | false | true;

Specifies whether the node auto-repair is enabled for the node pool. Default false (bool)

property enableAutoUpgrade

enableAutoUpgrade?: undefined | false | true;

Specifies whether node auto-upgrade is enabled for the node pool. Default false (bool)

property enableHorizontalPodAutoscaling

enableHorizontalPodAutoscaling?: undefined | false | true;

Enable horizontal pod autoscaling for the cluster. Default true (bool)

property enableHttpLoadBalancing

enableHttpLoadBalancing?: undefined | false | true;

Enable HTTP load balancing on GKE cluster. Default true (bool)

property enableKubernetesDashboard

enableKubernetesDashboard?: undefined | false | true;

Whether to enable the Kubernetes dashboard. Default false (bool)

property enableLegacyAbac

enableLegacyAbac?: undefined | false | true;

Whether to enable legacy abac on the cluster. Default false (bool)

property enableMasterAuthorizedNetwork

enableMasterAuthorizedNetwork?: undefined | false | true;

property enableNetworkPolicyConfig

enableNetworkPolicyConfig?: undefined | false | true;

Enable stackdriver logging. Default true (bool)

property enableNodepoolAutoscaling

enableNodepoolAutoscaling?: undefined | false | true;

Enable nodepool autoscaling. Default false (bool)

property enablePrivateEndpoint

enablePrivateEndpoint?: undefined | false | true;

Whether the master’s internal IP address is used as the cluster endpoint. Default false (bool)

property enablePrivateNodes

enablePrivateNodes?: undefined | false | true;

Whether nodes have internal IP address only. Default false (bool)

property enableStackdriverLogging

enableStackdriverLogging?: undefined | false | true;

Enable stackdriver monitoring. Default true (bool)

property enableStackdriverMonitoring

enableStackdriverMonitoring?: undefined | false | true;

Enable stackdriver monitoring on GKE cluster (bool)

property imageType

imageType: string;

The image to use for the worker nodes (string)

property ipPolicyClusterIpv4CidrBlock

ipPolicyClusterIpv4CidrBlock: string;

The IP address range for the cluster pod IPs (string)

property ipPolicyClusterSecondaryRangeName

ipPolicyClusterSecondaryRangeName: string;

The name of the secondary range to be used for the cluster CIDR block (string)

property ipPolicyCreateSubnetwork

ipPolicyCreateSubnetwork?: undefined | false | true;

Whether a new subnetwork will be created automatically for the cluster. Default false (bool)

property ipPolicyNodeIpv4CidrBlock

ipPolicyNodeIpv4CidrBlock: string;

The IP address range of the instance IPs in this cluster (string)

property ipPolicyServicesIpv4CidrBlock

ipPolicyServicesIpv4CidrBlock: string;

The IP address range of the services IPs in this cluster (string)

property ipPolicyServicesSecondaryRangeName

ipPolicyServicesSecondaryRangeName: string;

The name of the secondary range to be used for the services CIDR block (string)

property ipPolicySubnetworkName

ipPolicySubnetworkName: string;

A custom subnetwork name to be used if createSubnetwork is true (string)

property issueClientCertificate

issueClientCertificate?: undefined | false | true;

Issue a client certificate. Default false (bool)

property kubernetesDashboard

kubernetesDashboard?: undefined | false | true;

Enable the Kubernetes dashboard. Default false (bool)

property labels

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

Labels for cluster registration token object (map)

property localSsdCount

localSsdCount?: undefined | number;

The number of local SSD disks to be attached to the node. Default 0 (int)

property locations

locations: string[];

Locations for GKE cluster (list)

property machineType

machineType: string;

Machine type for GKE cluster (string)

property maintenanceWindow

maintenanceWindow: string;

Maintenance window for GKE cluster (string)

property masterAuthorizedNetworkCidrBlocks

masterAuthorizedNetworkCidrBlocks?: string[];

Define up to 10 external networks that could access Kubernetes master through HTTPS (list)

property masterIpv4CidrBlock

masterIpv4CidrBlock: string;

The IP range in CIDR notation to use for the hosted master network (string)

property masterVersion

masterVersion: string;

Master version for GKE cluster (string)

property maxNodeCount

maxNodeCount?: undefined | number;

Maximum number of nodes in the NodePool. Must be >= minNodeCount. There has to enough quota to scale up the cluster. Default 0 (int)

property minNodeCount

minNodeCount?: undefined | number;

Minimmum number of nodes in the NodePool. Must be >= 1 and <= maxNodeCount. Default 0 (int)

property network

network: string;

Network for GKE cluster (string)

property nodeCount

nodeCount?: undefined | number;

Node count for GKE cluster. Default 3 (int)

property nodePool

nodePool: string;

The ID of the cluster node pool (string)

property nodeVersion

nodeVersion: string;

Node version for GKE cluster (string)

property oauthScopes

oauthScopes: string[];

The set of Google API scopes to be made available on all of the node VMs under the default service account (list)

property preemptible

preemptible?: undefined | false | true;

Whether the nodes are created as preemptible VM instances. Default false (bool)

property projectId

projectId: string;

Project ID to apply answer (string)

property resourceLabels

resourceLabels: {[key: string]: any};

The map of Kubernetes labels to be applied to each cluster (map)

property serviceAccount

serviceAccount: string;

The Google Cloud Platform Service Account to be used by the node VMs (string)

property subNetwork

subNetwork: string;

Subnetwork for GKE cluster (string)

property taints

taints?: string[];

List of Kubernetes taints to be applied to each node (list)

property useIpAliases

useIpAliases?: undefined | false | true;

Whether alias IPs will be used for pod IPs in the cluster. Default false (bool)

property zone

zone?: undefined | string;

Zone GKE cluster (string)

interface ClusterK3sConfig

interface ClusterK3sConfig

property upgradeStrategy

upgradeStrategy: ClusterK3sConfigUpgradeStrategy;

K3S upgrade strategy (List maxitems: 1)

property version

version: string;

rancher-monitoring chart version (string)

interface ClusterK3sConfigUpgradeStrategy

interface ClusterK3sConfigUpgradeStrategy

property drainServerNodes

drainServerNodes?: undefined | false | true;

Drain server nodes. Default: false (bool)

property drainWorkerNodes

drainWorkerNodes?: undefined | false | true;

Drain worker nodes. Default: false (bool)

property serverConcurrency

serverConcurrency?: undefined | number;

Server concurrency. Default: 1 (int)

property workerConcurrency

workerConcurrency?: undefined | number;

Worker concurrency. Default: 1 (int)

interface ClusterLoggingCustomTargetConfig

interface ClusterLoggingCustomTargetConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property content

content: string;

Custom target config content (string)

interface ClusterLoggingElasticsearchConfig

interface ClusterLoggingElasticsearchConfig

property authPassword

authPassword?: undefined | string;

User password for the elascticsearch service (string)

property authUsername

authUsername?: undefined | string;

Username for the elascticsearch service (string)

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property clientKeyPass

clientKeyPass?: undefined | string;

SSL client key password for the splunk service (string)

property dateFormat

dateFormat?: undefined | string;

Date format for the elascticsearch logs. Default: YYYY-MM-DD (string)

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property indexPrefix

indexPrefix?: undefined | string;

Index prefix for the elascticsearch logs. Default: local (string)

property sslVerify

sslVerify: boolean;

SSL verify for the syslog service (bool)

property sslVersion

sslVersion?: undefined | string;

SSL version for the elascticsearch service (string)

interface ClusterLoggingFluentdConfig

interface ClusterLoggingFluentdConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property compress

compress?: undefined | false | true;

Compress data for the fluentd service (bool)

property enableTls

enableTls?: undefined | false | true;

Enable TLS for the fluentd service (bool)

property fluentServers

fluentServers: ClusterLoggingFluentdConfigFluentServer[];

Servers for the fluentd service (list)

interface ClusterLoggingFluentdConfigFluentServer

interface ClusterLoggingFluentdConfigFluentServer

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property hostname

hostname?: undefined | string;

Hostname of the fluentd service (string)

property password

password?: undefined | string;

User password of the fluentd service (string)

property sharedKey

sharedKey?: undefined | string;

Shared key of the fluentd service (string)

property standby

standby?: undefined | false | true;

Standby server of the fluentd service (bool)

property username

username?: undefined | string;

Username of the fluentd service (string)

property weight

weight?: undefined | number;

Weight of the fluentd server (int)

interface ClusterLoggingKafkaConfig

interface ClusterLoggingKafkaConfig

property brokerEndpoints

brokerEndpoints?: string[];

Kafka endpoints for kafka service. Conflicts with zookeeperEndpoint (list)

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property topic

topic: string;

Topic to publish on the kafka service (string)

property zookeeperEndpoint

zookeeperEndpoint?: undefined | string;

Zookeeper endpoint for kafka service. Conflicts with brokerEndpoints (string)

interface ClusterLoggingSplunkConfig

interface ClusterLoggingSplunkConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property clientKeyPass

clientKeyPass?: undefined | string;

SSL client key password for the splunk service (string)

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property index

index?: undefined | string;

Index prefix for the splunk logs (string)

property source

source?: undefined | string;

Date format for the splunk logs (string)

property sslVerify

sslVerify: boolean;

SSL verify for the syslog service (bool)

property token

token: string;

Token for the syslog service (string)

interface ClusterLoggingSyslogConfig

interface ClusterLoggingSyslogConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property program

program?: undefined | string;

Program for the syslog service (string)

property protocol

protocol?: undefined | string;

Protocol for the syslog service. tcp and udp are supported. Default: udp (string)

property severity

severity?: undefined | string;

Date format for the syslog logs. emergency, alert, critical, error, warning, notice, info and debug are supported. Default: notice (string)

property sslVerify

sslVerify: boolean;

SSL verify for the syslog service (bool)

property token

token?: undefined | string;

Token for the syslog service (string)

interface ClusterRkeConfig

interface ClusterRkeConfig

property addonJobTimeout

addonJobTimeout: number;

Duration in seconds of addon job (int)

property addons

addons?: undefined | string;

Addons descripton to deploy on RKE cluster.

property addonsIncludes

addonsIncludes?: string[];

Addons yaml manifests to deploy on RKE cluster (list)

property authentication

authentication: ClusterRkeConfigAuthentication;

Kubernetes cluster authentication (list maxitems:1)

property authorization

authorization: ClusterRkeConfigAuthorization;

Kubernetes cluster authorization (list maxitems:1)

property bastionHost

bastionHost: ClusterRkeConfigBastionHost;

RKE bastion host (list maxitems:1)

property cloudProvider

cloudProvider: ClusterRkeConfigCloudProvider;

RKE options for Calico network provider (string)

property dns

dns: ClusterRkeConfigDns;

RKE dns add-on. Just for Rancher v2.2.x (list maxitems:1)

property ignoreDockerVersion

ignoreDockerVersion?: undefined | false | true;

Ignore docker version. Default true (bool)

property ingress

ingress: ClusterRkeConfigIngress;

Kubernetes ingress configuration (list maxitems:1)

property kubernetesVersion

kubernetesVersion: string;

The Kubernetes master version (string)

property monitoring

monitoring: ClusterRkeConfigMonitoring;

Kubernetes cluster monitoring (list maxitems:1)

property network

network: ClusterRkeConfigNetwork;

Network for GKE cluster (string)

property nodes

nodes?: ClusterRkeConfigNode[];

RKE cluster nodes (list)

property prefixPath

prefixPath: string;

Prefix to customize Kubernetes path (string)

property privateRegistries

privateRegistries?: ClusterRkeConfigPrivateRegistry[];

private registries for docker images (list)

property services

services: ClusterRkeConfigServices;

Kubernetes cluster services (list maxitems:1)

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

Use ssh agent auth. Default false (bool)

property sshCertPath

sshCertPath: string;

Cluster level SSH certificate path (string)

property sshKeyPath

sshKeyPath: string;

Node SSH private key path (string)

property upgradeStrategy

upgradeStrategy: ClusterRkeConfigUpgradeStrategy;

K3S upgrade strategy (List maxitems: 1)

interface ClusterRkeConfigAuthentication

interface ClusterRkeConfigAuthentication

property sans

sans: string[];

RKE sans for authentication ([]string)

property strategy

strategy: string;

RKE strategy for authentication (string)

interface ClusterRkeConfigAuthorization

interface ClusterRkeConfigAuthorization

property mode

mode?: undefined | string;

RKE mode for authorization. rbac and none modes are available. Default rbac (string)

property options

options: {[key: string]: any};

RKE options for network (map)

interface ClusterRkeConfigBastionHost

interface ClusterRkeConfigBastionHost

property address

address: string;

Address ip for node (string)

property port

port?: undefined | string;

Port for node. Default 22 (string)

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

Use ssh agent auth. Default false (bool)

property sshKey

sshKey: string;

Node SSH private key (string)

property sshKeyPath

sshKeyPath: string;

Node SSH private key path (string)

property user

user: string;

Registry user (string)

interface ClusterRkeConfigCloudProvider

interface ClusterRkeConfigCloudProvider

property awsCloudProvider

awsCloudProvider?: outputs.ClusterRkeConfigCloudProviderAwsCloudProvider;

RKE AWS Cloud Provider config for Cloud Provider rke-aws-cloud-provider (list maxitems:1)

property azureCloudProvider

azureCloudProvider?: outputs.ClusterRkeConfigCloudProviderAzureCloudProvider;

RKE Azure Cloud Provider config for Cloud Provider rke-azure-cloud-provider (list maxitems:1)

property customCloudProvider

customCloudProvider: string;

RKE Custom Cloud Provider config for Cloud Provider (string) (string)

property name

name: string;

Name of cluster registration token (string)

property openstackCloudProvider

openstackCloudProvider?: outputs.ClusterRkeConfigCloudProviderOpenstackCloudProvider;

RKE Openstack Cloud Provider config for Cloud Provider rke-openstack-cloud-provider (list maxitems:1)

property vsphereCloudProvider

vsphereCloudProvider?: outputs.ClusterRkeConfigCloudProviderVsphereCloudProvider;

RKE Vsphere Cloud Provider config for Cloud Provider rke-vsphere-cloud-provider Extra argument name is required on virtualCenter configuration. (list maxitems:1)

interface ClusterRkeConfigCloudProviderAwsCloudProvider

interface ClusterRkeConfigCloudProviderAwsCloudProvider

property global

global: ClusterRkeConfigCloudProviderAwsCloudProviderGlobal;

(list maxitems:1)

property serviceOverrides

serviceOverrides?: ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride[];

(list)

interface ClusterRkeConfigCloudProviderAwsCloudProviderGlobal

interface ClusterRkeConfigCloudProviderAwsCloudProviderGlobal

property disableSecurityGroupIngress

disableSecurityGroupIngress?: undefined | false | true;

Default false (bool)

property disableStrictZoneCheck

disableStrictZoneCheck?: undefined | false | true;

Default false (bool)

property elbSecurityGroup

elbSecurityGroup: string;

(string)

property kubernetesClusterId

kubernetesClusterId: string;

(string)

property kubernetesClusterTag

kubernetesClusterTag: string;

(string)

property roleArn

roleArn: string;

(string)

property routeTableId

routeTableId: string;

(string)

property subnetId

subnetId: string;

(string)

property vpc

vpc: string;

(string)

property zone

zone: string;

Zone GKE cluster (string)

interface ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

interface ClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

property region

region: string;

The AWS Region to create the EKS cluster in. Default us-west-2 (string)

property service

service: string;

(string)

property signingMethod

signingMethod: string;

(string)

property signingName

signingName: string;

(string)

property signingRegion

signingRegion: string;

(string)

property url

url: string;

Registry URL (string)

interface ClusterRkeConfigCloudProviderAzureCloudProvider

interface ClusterRkeConfigCloudProviderAzureCloudProvider

property aadClientCertPassword

aadClientCertPassword: string;

(string)

property aadClientCertPath

aadClientCertPath: string;

(string)

property aadClientId

aadClientId: string;

(string)

property aadClientSecret

aadClientSecret: string;

(string)

property cloud

cloud: string;

(string)

property cloudProviderBackoff

cloudProviderBackoff: boolean;

(bool)

property cloudProviderBackoffDuration

cloudProviderBackoffDuration: number;

(int)

property cloudProviderBackoffExponent

cloudProviderBackoffExponent: number;

(int)

property cloudProviderBackoffJitter

cloudProviderBackoffJitter: number;

(int)

property cloudProviderBackoffRetries

cloudProviderBackoffRetries: number;

(int)

property cloudProviderRateLimit

cloudProviderRateLimit: boolean;

(bool)

property cloudProviderRateLimitBucket

cloudProviderRateLimitBucket: number;

(int)

property cloudProviderRateLimitQps

cloudProviderRateLimitQps: number;

(int)

property location

location: string;

Azure Kubernetes cluster location. Default eastus (string)

property maximumLoadBalancerRuleCount

maximumLoadBalancerRuleCount: number;

(int)

property primaryAvailabilitySetName

primaryAvailabilitySetName: string;

(string)

property primaryScaleSetName

primaryScaleSetName: string;

(string)

property resourceGroup

resourceGroup: string;

The name of the Cluster resource group (string)

property routeTableName

routeTableName: string;

(string)

property securityGroupName

securityGroupName: string;

(string)

property subnetName

subnetName: string;

(string)

property subscriptionId

subscriptionId: string;

Subscription credentials which uniquely identify Microsoft Azure subscription (string)

property tenantId

tenantId: string;

Azure tenant ID to use (string)

property useInstanceMetadata

useInstanceMetadata: boolean;

(bool)

property useManagedIdentityExtension

useManagedIdentityExtension: boolean;

(bool)

property vmType

vmType: string;

(string)

property vnetName

vnetName: string;

(string)

property vnetResourceGroup

vnetResourceGroup: string;

(string)

interface ClusterRkeConfigCloudProviderOpenstackCloudProvider

interface ClusterRkeConfigCloudProviderOpenstackCloudProvider

property blockStorage

blockStorage: ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage;

(list maxitems:1)

property global

global: ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal;

(list maxitems:1)

property loadBalancer

loadBalancer: ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer;

(list maxitems:1)

property metadata

metadata: ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata;

(list maxitems:1)

property route

route: ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute;

(list maxitems:1)

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

property bsVersion

bsVersion: string;

(string)

property ignoreVolumeAz

ignoreVolumeAz: boolean;

(string)

property trustDevicePath

trustDevicePath: boolean;

(string)

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal

property authUrl

authUrl: string;

(string)

property caFile

caFile: string;

(string)

property domainId

domainId: string;

Required if domainName not provided. (string)

property domainName

domainName: string;

Required if domainId not provided. (string)

property password

password: string;

Registry password (string)

property region

region: string;

The AWS Region to create the EKS cluster in. Default us-west-2 (string)

property tenantId

tenantId: string;

Azure tenant ID to use (string)

property tenantName

tenantName: string;

Required if tenantId not provided. (string)

property trustId

trustId: string;

(string)

property username

username: string;

(string)

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

property createMonitor

createMonitor: boolean;

(bool)

property floatingNetworkId

floatingNetworkId: string;

(string)

property lbMethod

lbMethod: string;

(string)

property lbProvider

lbProvider: string;

(string)

property lbVersion

lbVersion: string;

(string)

property manageSecurityGroups

manageSecurityGroups: boolean;

(bool)

property monitorDelay

monitorDelay?: undefined | string;

Default 60s (string)

property monitorMaxRetries

monitorMaxRetries?: undefined | number;

Default 5 (int)

property monitorTimeout

monitorTimeout?: undefined | string;

Default 30s (string)

property subnetId

subnetId: string;

(string)

property useOctavia

useOctavia: boolean;

(bool)

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

property requestTimeout

requestTimeout: number;

(int)

property searchOrder

searchOrder: string;

(string)

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

interface ClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

property routerId

routerId: string;

(string)

interface ClusterRkeConfigCloudProviderVsphereCloudProvider

interface ClusterRkeConfigCloudProviderVsphereCloudProvider

property disk

disk: ClusterRkeConfigCloudProviderVsphereCloudProviderDisk;

(list maxitems:1)

property global

global: ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal;

(list maxitems:1)

property network

network: ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork;

Network for GKE cluster (string)

property virtualCenters

virtualCenters: ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter[];

(List)

property workspace

workspace: ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace;

(list maxitems:1)

interface ClusterRkeConfigCloudProviderVsphereCloudProviderDisk

interface ClusterRkeConfigCloudProviderVsphereCloudProviderDisk

property scsiControllerType

scsiControllerType: string;

(string)

interface ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal

interface ClusterRkeConfigCloudProviderVsphereCloudProviderGlobal

property datacenters

datacenters: string;

(string)

property insecureFlag

insecureFlag: boolean;

(bool)

property password

password: string;

Registry password (string)

property port

port: string;

Port for node. Default 22 (string)

property soapRoundtripCount

soapRoundtripCount: number;

(int)

property user

user: string;

Registry user (string)

interface ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

interface ClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

property publicNetwork

publicNetwork: string;

(string)

interface ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

interface ClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

property datacenters

datacenters: string;

(string)

property name

name: string;

Name of cluster registration token (string)

property password

password: string;

Registry password (string)

property port

port: string;

Port for node. Default 22 (string)

property soapRoundtripCount

soapRoundtripCount: number;

(int)

property user

user: string;

Registry user (string)

interface ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace

interface ClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace

property datacenter

datacenter: string;

(string)

property defaultDatastore

defaultDatastore: string;

(string)

property folder

folder: string;

Folder for S3 service. Available from Rancher v2.2.7 (string)

property resourcepoolPath

resourcepoolPath: string;

(string)

property server

server: string;

(string)

interface ClusterRkeConfigDns

interface ClusterRkeConfigDns

property nodeSelector

nodeSelector: {[key: string]: any};

Node selector for RKE Ingress (map)

property provider

provider?: undefined | string;

Provider for RKE monitoring (string)

property reverseCidrs

reverseCidrs: string[];

DNS add-on reverse cidr (list)

property upstreamNameservers

upstreamNameservers: string[];

DNS add-on upstream nameservers (list)

interface ClusterRkeConfigIngress

interface ClusterRkeConfigIngress

property dnsPolicy

dnsPolicy: string;

Ingress controller DNS policy. ClusterFirstWithHostNet, ClusterFirst, Default, and None are supported. K8S dns Policy (string)

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property nodeSelector

nodeSelector: {[key: string]: any};

Node selector for RKE Ingress (map)

property options

options: {[key: string]: any};

RKE options for network (map)

property provider

provider: string;

Provider for RKE monitoring (string)

interface ClusterRkeConfigMonitoring

interface ClusterRkeConfigMonitoring

property options

options: {[key: string]: any};

RKE options for network (map)

property provider

provider: string;

Provider for RKE monitoring (string)

interface ClusterRkeConfigNetwork

interface ClusterRkeConfigNetwork

property calicoNetworkProvider

calicoNetworkProvider?: outputs.ClusterRkeConfigNetworkCalicoNetworkProvider;

Calico provider config for RKE network (list maxitems:1)

property canalNetworkProvider

canalNetworkProvider?: outputs.ClusterRkeConfigNetworkCanalNetworkProvider;

Canal provider config for RKE network (list maxitems:1)

property flannelNetworkProvider

flannelNetworkProvider?: outputs.ClusterRkeConfigNetworkFlannelNetworkProvider;

Flannel provider config for RKE network (list maxitems:1)

property mtu

mtu?: undefined | number;

Network provider MTU. Default 0 (int)

property options

options: {[key: string]: any};

RKE options for network (map)

property plugin

plugin: string;

Plugin for RKE network. canal (default), flannel, calico, none and weave are supported. (string)

property weaveNetworkProvider

weaveNetworkProvider?: outputs.ClusterRkeConfigNetworkWeaveNetworkProvider;

Weave provider config for RKE network (list maxitems:1)

interface ClusterRkeConfigNetworkCalicoNetworkProvider

interface ClusterRkeConfigNetworkCalicoNetworkProvider

property cloudProvider

cloudProvider: string;

RKE options for Calico network provider (string)

interface ClusterRkeConfigNetworkCanalNetworkProvider

interface ClusterRkeConfigNetworkCanalNetworkProvider

property iface

iface: string;

Iface config Flannel network provider (string)

interface ClusterRkeConfigNetworkFlannelNetworkProvider

interface ClusterRkeConfigNetworkFlannelNetworkProvider

property iface

iface: string;

Iface config Flannel network provider (string)

interface ClusterRkeConfigNetworkWeaveNetworkProvider

interface ClusterRkeConfigNetworkWeaveNetworkProvider

property password

password: string;

Registry password (string)

interface ClusterRkeConfigNode

interface ClusterRkeConfigNode

property address

address: string;

Address ip for node (string)

property dockerSocket

dockerSocket: string;

Docker socket for node (string)

property hostnameOverride

hostnameOverride?: undefined | string;

Hostname override for node (string)

property internalAddress

internalAddress?: undefined | string;

Internal ip for node (string)

property labels

labels?: undefined | {[key: string]: any};

Labels for cluster registration token object (map)

property nodeId

nodeId?: undefined | string;

Id for the node (string)

property port

port?: undefined | string;

Port for node. Default 22 (string)

property roles

roles: string[];

Roles for the node. controlplane, etcd and worker are supported. (list)

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

Use ssh agent auth. Default false (bool)

property sshKey

sshKey: string;

Node SSH private key (string)

property sshKeyPath

sshKeyPath: string;

Node SSH private key path (string)

property user

user: string;

Registry user (string)

interface ClusterRkeConfigPrivateRegistry

interface ClusterRkeConfigPrivateRegistry

property isDefault

isDefault?: undefined | false | true;

Set as default registry. Default false (bool)

property password

password?: undefined | string;

Registry password (string)

property url

url: string;

Registry URL (string)

property user

user?: undefined | string;

Registry user (string)

interface ClusterRkeConfigServices

interface ClusterRkeConfigServices

property etcd

etcd: ClusterRkeConfigServicesEtcd;

Etcd options for RKE services (list maxitems:1)

property kubeApi

kubeApi: ClusterRkeConfigServicesKubeApi;

Kube API options for RKE services (list maxitems:1)

property kubeController

kubeController: ClusterRkeConfigServicesKubeController;

Kube Controller options for RKE services (list maxitems:1)

property kubelet

kubelet: ClusterRkeConfigServicesKubelet;

Kubelet options for RKE services (list maxitems:1)

property kubeproxy

kubeproxy: ClusterRkeConfigServicesKubeproxy;

Kubeproxy options for RKE services (list maxitems:1)

property scheduler

scheduler: ClusterRkeConfigServicesScheduler;

Scheduler options for RKE services (list maxitems:1)

interface ClusterRkeConfigServicesEtcd

interface ClusterRkeConfigServicesEtcd

property backupConfig

backupConfig: ClusterRkeConfigServicesEtcdBackupConfig;

Backup options for etcd service. Just for Rancher v2.2.x (list maxitems:1)

property caCert

caCert: string;

TLS CA certificate for etcd service (string)

property cert

cert: string;

TLS certificate for etcd service (string)

property creation

creation: string;

Creation option for etcd service (string)

property externalUrls

externalUrls?: string[];

External urls for etcd service (list)

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property extraBinds

extraBinds?: string[];

Extra binds for scheduler service (list)

property extraEnvs

extraEnvs?: string[];

Extra environment for scheduler service (list)

property gid

gid?: undefined | number;

Etcd service GID. Default: 0. For Rancher v2.3.x or above (int)

property image

image: string;

Docker image for scheduler service (string)

property key

key: string;

TLS key for etcd service (string)

property path

path: string;

(Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)

property retention

retention: string;

Retention for etcd backup. Default 6 (int)

property snapshot

snapshot: boolean;

Snapshot option for etcd service (bool)

property uid

uid?: undefined | number;

Etcd service UID. Default: 0. For Rancher v2.3.x or above (int)

interface ClusterRkeConfigServicesEtcdBackupConfig

interface ClusterRkeConfigServicesEtcdBackupConfig

property enabled

enabled?: undefined | false | true;

Enable scheduled cluster scan. Default: false (bool)

property intervalHours

intervalHours?: undefined | number;

Interval hours for etcd backup. Default 12 (int)

property retention

retention?: undefined | number;

Retention for etcd backup. Default 6 (int)

property s3BackupConfig

s3BackupConfig?: outputs.ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig;

S3 config options for etcd backup (list maxitems:1)

property safeTimestamp

safeTimestamp?: undefined | false | true;

Safe timestamp for etcd backup. Default: false (bool)

interface ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig

interface ClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig

property accessKey

accessKey?: undefined | string;

The AWS Client ID to use (string)

property bucketName

bucketName: string;

Bucket name for S3 service (string)

property customCa

customCa?: undefined | string;

Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

property endpoint

endpoint: string;

Endpoint for S3 service (string)

property folder

folder?: undefined | string;

Folder for S3 service. Available from Rancher v2.2.7 (string)

property region

region?: undefined | string;

The AWS Region to create the EKS cluster in. Default us-west-2 (string)

property secretKey

secretKey?: undefined | string;

The AWS Client Secret associated with the Client ID (string)

interface ClusterRkeConfigServicesKubeApi

interface ClusterRkeConfigServicesKubeApi

property admissionConfiguration

admissionConfiguration?: undefined | {[key: string]: any};

Admission configuration (map)

property alwaysPullImages

alwaysPullImages?: undefined | false | true;

Enable AlwaysPullImages Admission controller plugin. Rancher docs Default: false (bool)

property auditLog

auditLog?: outputs.ClusterRkeConfigServicesKubeApiAuditLog;

K8s audit log configuration. (list maxitems: 1)

property eventRateLimit

eventRateLimit?: outputs.ClusterRkeConfigServicesKubeApiEventRateLimit;

K8s event rate limit configuration. (list maxitems: 1)

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property extraBinds

extraBinds?: string[];

Extra binds for scheduler service (list)

property extraEnvs

extraEnvs?: string[];

Extra environment for scheduler service (list)

property image

image: string;

Docker image for scheduler service (string)

property podSecurityPolicy

podSecurityPolicy?: undefined | false | true;

Pod Security Policy option for kube API service. Default false (bool)

property secretsEncryptionConfig

secretsEncryptionConfig?: outputs.ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig;

Encrypt k8s secret data configration. (list maxitem: 1)

property serviceClusterIpRange

serviceClusterIpRange: string;

Service Cluster ip Range option for kube controller service (string)

property serviceNodePortRange

serviceNodePortRange: string;

Service Node Port Range option for kube API service (string)

interface ClusterRkeConfigServicesKubeApiAuditLog

interface ClusterRkeConfigServicesKubeApiAuditLog

property configuration

configuration: ClusterRkeConfigServicesKubeApiAuditLogConfiguration;

Event rate limit configuration. (map)

property enabled

enabled?: undefined | false | true;

Enable scheduled cluster scan. Default: false (bool)

interface ClusterRkeConfigServicesKubeApiAuditLogConfiguration

interface ClusterRkeConfigServicesKubeApiAuditLogConfiguration

property format

format?: undefined | string;

Audit log format. Default: ‘json’ (string)

property maxAge

maxAge?: undefined | number;

Audit log max age. Default: 30 (int)

property maxBackup

maxBackup?: undefined | number;

Audit log max backup. Default: 10 (int)

property maxSize

maxSize?: undefined | number;

Audit log max size. Default: 100 (int)

property path

path?: undefined | string;

(Optional) Audit log path. Default: /var/log/kube-audit/audit-log.json (string)

property policy

policy: string;

Audit policy yaml encoded definition. apiVersion and kind: Policy\nrules:" fields are required in the yaml. Ex. "apiVersion: audit.k8s.io/v1\nkind: Policy\nrules:\n- level: RequestResponse\n resources:\n - resources:\n - pods\n" More info (string)

interface ClusterRkeConfigServicesKubeApiEventRateLimit

interface ClusterRkeConfigServicesKubeApiEventRateLimit

property configuration

configuration?: undefined | {[key: string]: any};

Event rate limit configuration. (map)

property enabled

enabled?: undefined | false | true;

Enable scheduled cluster scan. Default: false (bool)

interface ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

interface ClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

property customConfig

customConfig?: undefined | {[key: string]: any};

Secrets encryption configuration. (map)

property enabled

enabled?: undefined | false | true;

Enable scheduled cluster scan. Default: false (bool)

interface ClusterRkeConfigServicesKubeController

interface ClusterRkeConfigServicesKubeController

property clusterCidr

clusterCidr: string;

Cluster CIDR option for kube controller service (string)

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property extraBinds

extraBinds?: string[];

Extra binds for scheduler service (list)

property extraEnvs

extraEnvs?: string[];

Extra environment for scheduler service (list)

property image

image: string;

Docker image for scheduler service (string)

property serviceClusterIpRange

serviceClusterIpRange: string;

Service Cluster ip Range option for kube controller service (string)

interface ClusterRkeConfigServicesKubelet

interface ClusterRkeConfigServicesKubelet

property clusterDnsServer

clusterDnsServer: string;

Cluster DNS Server option for kubelet service (string)

property clusterDomain

clusterDomain: string;

Cluster Domain option for kubelet service (string)

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property extraBinds

extraBinds?: string[];

Extra binds for scheduler service (list)

property extraEnvs

extraEnvs?: string[];

Extra environment for scheduler service (list)

property failSwapOn

failSwapOn: boolean;

Enable or disable failing when swap on is not supported (bool)

property generateServingCertificate

generateServingCertificate?: undefined | false | true;

Generate a certificate signed by the kube-ca. Default false (bool)

property image

image: string;

Docker image for scheduler service (string)

property infraContainerImage

infraContainerImage: string;

Infra container image for kubelet service (string)

interface ClusterRkeConfigServicesKubeproxy

interface ClusterRkeConfigServicesKubeproxy

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property extraBinds

extraBinds?: string[];

Extra binds for scheduler service (list)

property extraEnvs

extraEnvs?: string[];

Extra environment for scheduler service (list)

property image

image: string;

Docker image for scheduler service (string)

interface ClusterRkeConfigServicesScheduler

interface ClusterRkeConfigServicesScheduler

property extraArgs

extraArgs: {[key: string]: any};

Extra arguments for scheduler service (map)

property extraBinds

extraBinds?: string[];

Extra binds for scheduler service (list)

property extraEnvs

extraEnvs?: string[];

Extra environment for scheduler service (list)

property image

image: string;

Docker image for scheduler service (string)

interface ClusterRkeConfigUpgradeStrategy

interface ClusterRkeConfigUpgradeStrategy

property drain

drain?: undefined | false | true;

RKE drain nodes. Default: false (bool)

property drainInput

drainInput: ClusterRkeConfigUpgradeStrategyDrainInput;

RKE drain node input (list Maxitems: 1)

property maxUnavailableControlplane

maxUnavailableControlplane?: undefined | string;

RKE max unavailable controlplane nodes. Default: 1 (string)

property maxUnavailableWorker

maxUnavailableWorker?: undefined | string;

RKE max unavailable worker nodes. Default: 10% (string)

interface ClusterRkeConfigUpgradeStrategyDrainInput

interface ClusterRkeConfigUpgradeStrategyDrainInput

property deleteLocalData

deleteLocalData?: undefined | false | true;

Delete RKE node local data. Default: false (bool)

property force

force?: undefined | false | true;

Force RKE node drain. Default: false (bool)

property gracePeriod

gracePeriod?: undefined | number;

RKE node drain grace period. Default: -1 (int)

property ignoreDaemonSets

ignoreDaemonSets?: undefined | false | true;

Ignore RKE daemon sets. Default: true (bool)

property timeout

timeout?: undefined | number;

RKE node drain timeout. Default: 60 (int)

interface ClusterScheduledClusterScan

interface ClusterScheduledClusterScan

property enabled

enabled?: undefined | false | true;

Enable scheduled cluster scan. Default: false (bool)

property scanConfig

scanConfig: ClusterScheduledClusterScanScanConfig;

Cluster scan config (List maxitems:1)

property scheduleConfig

scheduleConfig: ClusterScheduledClusterScanScheduleConfig;

Cluster scan schedule config (list maxitems:1)

interface ClusterScheduledClusterScanScanConfig

interface ClusterScheduledClusterScanScanConfig

property cisScanConfig

cisScanConfig: ClusterScheduledClusterScanScanConfigCisScanConfig;

Cluster Cis Scan config (List maxitems:1)

interface ClusterScheduledClusterScanScanConfigCisScanConfig

interface ClusterScheduledClusterScanScanConfigCisScanConfig

property debugMaster

debugMaster?: undefined | false | true;

Debug master. Default: false (bool)

property debugWorker

debugWorker?: undefined | false | true;

Debug worker. Default: false (bool)

property overrideBenchmarkVersion

overrideBenchmarkVersion?: undefined | string;

Override benchmark version (string)

property overrideSkips

overrideSkips?: string[];

Override skip (string)

property profile

profile?: undefined | string;

Cis scan profile. Allowed values: "permissive" (default) || "hardened" (string)

interface ClusterScheduledClusterScanScheduleConfig

interface ClusterScheduledClusterScanScheduleConfig

property cronSchedule

cronSchedule: string;

Crontab schedule. It should contains 5 fields "<min> <hour> <month_day> <month> <week_day>" (string)

property retention

retention: number;

Retention for etcd backup. Default 6 (int)

interface ClusterTemplateMember

interface ClusterTemplateMember

property accessType

accessType?: undefined | string;

Member access type. Valid values: ["read-only" | "owner"] (string)

property groupPrincipalId

groupPrincipalId?: undefined | string;

Member group principal id (string)

property userPrincipalId

userPrincipalId?: undefined | string;

Member user principal id (string)

interface ClusterTemplateTemplateRevision

interface ClusterTemplateTemplateRevision

property annotations

annotations: {[key: string]: any};

Annotations for the cluster template revision (map)

property clusterConfig

clusterConfig: ClusterTemplateTemplateRevisionClusterConfig;

Cluster configuration (list maxitem: 1)

property clusterTemplateId

clusterTemplateId: string;

Cluster template ID (string)

property default

default?: undefined | false | true;

Default variable value (string)

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

property id

id: string;

The cluster template revision ID (string)

property labels

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

Labels for the cluster template revision (map)

property name

name: string;

The cluster template revision name (string)

property questions

questions?: ClusterTemplateTemplateRevisionQuestion[];

Cluster template questions (list)

interface ClusterTemplateTemplateRevisionClusterConfig

interface ClusterTemplateTemplateRevisionClusterConfig

property clusterAuthEndpoint

clusterAuthEndpoint: ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint;

Local cluster auth endpoint (list maxitems: 1)

property defaultClusterRoleForProjectMembers

defaultClusterRoleForProjectMembers: string;

Default cluster role for project members (string)

property defaultPodSecurityPolicyTemplateId

defaultPodSecurityPolicyTemplateId: string;

Default pod security policy template ID (string)

property desiredAgentImage

desiredAgentImage: string;

Desired agent image (string)

property desiredAuthImage

desiredAuthImage: string;

Desired auth image (string)

property dockerRootDir

dockerRootDir: string;

Desired auth image (string)

property enableClusterAlerting

enableClusterAlerting?: undefined | false | true;

Enable built-in cluster alerting. Default: false (bool)

property enableClusterMonitoring

enableClusterMonitoring?: undefined | false | true;

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

property enableNetworkPolicy

enableNetworkPolicy?: undefined | false | true;

Enable project network isolation. Default: false (bool)

property rkeConfig

rkeConfig: ClusterTemplateTemplateRevisionClusterConfigRkeConfig;

Rancher Kubernetes Engine Config (list maxitems: 1)

property scheduledClusterScan

scheduledClusterScan?: outputs.ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan;

Cluster scheduled cis scan. For Rancher v2.4.0 or above (List MaxItem:1)

property windowsPreferedCluster

windowsPreferedCluster?: undefined | false | true;

Windows prefered cluster. Default: false (bool)

interface ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

interface ClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

property caCerts

caCerts?: undefined | string;

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

property fqdn

fqdn?: undefined | string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfig

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfig

property addonJobTimeout

addonJobTimeout: number;

property addons

addons?: undefined | string;

property addonsIncludes

addonsIncludes?: string[];

property authentication

authentication: ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication;

property authorization

authorization: ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization;

property bastionHost

bastionHost: ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost;

property cloudProvider

cloudProvider: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider;

property dns

dns: ClusterTemplateTemplateRevisionClusterConfigRkeConfigDns;

property ignoreDockerVersion

ignoreDockerVersion?: undefined | false | true;

property ingress

ingress: ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress;

property kubernetesVersion

kubernetesVersion: string;

property monitoring

monitoring: ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring;

property network

network: ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork;

property nodes

nodes?: ClusterTemplateTemplateRevisionClusterConfigRkeConfigNode[];

property prefixPath

prefixPath: string;

property privateRegistries

privateRegistries?: ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry[];

property services

services: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServices;

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshCertPath

sshCertPath: string;

property sshKeyPath

sshKeyPath: string;

property upgradeStrategy

upgradeStrategy: ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication

property sans

sans: string[];

property strategy

strategy: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization

property mode

mode?: undefined | string;

property options

options: {[key: string]: any};

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost

property address

address: string;

property port

port?: undefined | string;

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshKey

sshKey: string;

property sshKeyPath

sshKeyPath: string;

property user

user: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider

property awsCloudProvider

awsCloudProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider;

property azureCloudProvider

azureCloudProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider;

property customCloudProvider

customCloudProvider: string;

property name

name: string;

The cluster template revision name (string)

property openstackCloudProvider

openstackCloudProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider;

property vsphereCloudProvider

vsphereCloudProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider

property global

global: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal;

property serviceOverrides

serviceOverrides?: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride[];

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal

property disableSecurityGroupIngress

disableSecurityGroupIngress?: undefined | false | true;

property disableStrictZoneCheck

disableStrictZoneCheck?: undefined | false | true;

property elbSecurityGroup

elbSecurityGroup: string;

property kubernetesClusterId

kubernetesClusterId: string;

property kubernetesClusterTag

kubernetesClusterTag: string;

property roleArn

roleArn: string;

property routeTableId

routeTableId: string;

property subnetId

subnetId: string;

property vpc

vpc: string;

property zone

zone: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride

property region

region: string;

property service

service: string;

property signingMethod

signingMethod: string;

property signingName

signingName: string;

property signingRegion

signingRegion: string;

property url

url: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider

property aadClientCertPassword

aadClientCertPassword: string;

property aadClientCertPath

aadClientCertPath: string;

property aadClientId

aadClientId: string;

property aadClientSecret

aadClientSecret: string;

property cloud

cloud: string;

property cloudProviderBackoff

cloudProviderBackoff: boolean;

property cloudProviderBackoffDuration

cloudProviderBackoffDuration: number;

property cloudProviderBackoffExponent

cloudProviderBackoffExponent: number;

property cloudProviderBackoffJitter

cloudProviderBackoffJitter: number;

property cloudProviderBackoffRetries

cloudProviderBackoffRetries: number;

property cloudProviderRateLimit

cloudProviderRateLimit: boolean;

property cloudProviderRateLimitBucket

cloudProviderRateLimitBucket: number;

property cloudProviderRateLimitQps

cloudProviderRateLimitQps: number;

property location

location: string;

property maximumLoadBalancerRuleCount

maximumLoadBalancerRuleCount: number;

property primaryAvailabilitySetName

primaryAvailabilitySetName: string;

property primaryScaleSetName

primaryScaleSetName: string;

property resourceGroup

resourceGroup: string;

property routeTableName

routeTableName: string;

property securityGroupName

securityGroupName: string;

property subnetName

subnetName: string;

property subscriptionId

subscriptionId: string;

property tenantId

tenantId: string;

property useInstanceMetadata

useInstanceMetadata: boolean;

property useManagedIdentityExtension

useManagedIdentityExtension: boolean;

property vmType

vmType: string;

property vnetName

vnetName: string;

property vnetResourceGroup

vnetResourceGroup: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider

property blockStorage

blockStorage: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage;

property global

global: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal;

property loadBalancer

loadBalancer: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer;

property metadata

metadata: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata;

property route

route: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

property bsVersion

bsVersion: string;

property ignoreVolumeAz

ignoreVolumeAz: boolean;

property trustDevicePath

trustDevicePath: boolean;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal

property authUrl

authUrl: string;

property caFile

caFile: string;

property domainId

domainId: string;

property domainName

domainName: string;

property password

password: string;

property region

region: string;

property tenantId

tenantId: string;

property tenantName

tenantName: string;

property trustId

trustId: string;

property username

username: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

property createMonitor

createMonitor: boolean;

property floatingNetworkId

floatingNetworkId: string;

property lbMethod

lbMethod: string;

property lbProvider

lbProvider: string;

property lbVersion

lbVersion: string;

property manageSecurityGroups

manageSecurityGroups: boolean;

property monitorDelay

monitorDelay?: undefined | string;

property monitorMaxRetries

monitorMaxRetries?: undefined | number;

property monitorTimeout

monitorTimeout?: undefined | string;

property subnetId

subnetId: string;

property useOctavia

useOctavia: boolean;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata

property requestTimeout

requestTimeout: number;

property searchOrder

searchOrder: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute

property routerId

routerId: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider

property disk

disk: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk;

property global

global: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal;

property network

network: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork;

property virtualCenters

virtualCenters: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter[];

property workspace

workspace: ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk

property scsiControllerType

scsiControllerType: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal

property datacenters

datacenters: string;

property insecureFlag

insecureFlag: boolean;

property password

password: string;

property port

port: string;

property soapRoundtripCount

soapRoundtripCount: number;

property user

user: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork

property publicNetwork

publicNetwork: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

property datacenters

datacenters: string;

property name

name: string;

The cluster template revision name (string)

property password

password: string;

property port

port: string;

property soapRoundtripCount

soapRoundtripCount: number;

property user

user: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace

property datacenter

datacenter: string;

property defaultDatastore

defaultDatastore: string;

property folder

folder: string;

property resourcepoolPath

resourcepoolPath: string;

property server

server: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigDns

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigDns

property nodeSelector

nodeSelector: {[key: string]: any};

property provider

provider?: undefined | string;

property reverseCidrs

reverseCidrs: string[];

property upstreamNameservers

upstreamNameservers: string[];

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress

property dnsPolicy

dnsPolicy: string;

property extraArgs

extraArgs: {[key: string]: any};

property nodeSelector

nodeSelector: {[key: string]: any};

property options

options: {[key: string]: any};

property provider

provider: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring

property options

options: {[key: string]: any};

property provider

provider: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork

property calicoNetworkProvider

calicoNetworkProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider;

property canalNetworkProvider

canalNetworkProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider;

property flannelNetworkProvider

flannelNetworkProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider;

property mtu

mtu?: undefined | number;

property options

options: {[key: string]: any};

property plugin

plugin: string;

property weaveNetworkProvider

weaveNetworkProvider?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider

property cloudProvider

cloudProvider: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider

property iface

iface: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider

property iface

iface: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider

property password

password: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNode

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigNode

property address

address: string;

property dockerSocket

dockerSocket: string;

property hostnameOverride

hostnameOverride?: undefined | string;

property internalAddress

internalAddress?: undefined | string;

property labels

labels?: undefined | {[key: string]: any};

Labels for the cluster template revision (map)

property nodeId

nodeId?: undefined | string;

property port

port?: undefined | string;

property roles

roles: string[];

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshKey

sshKey: string;

property sshKeyPath

sshKeyPath: string;

property user

user: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry

property isDefault

isDefault?: undefined | false | true;

property password

password?: undefined | string;

property url

url: string;

property user

user?: undefined | string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServices

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServices

property etcd

etcd: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd;

property kubeApi

kubeApi: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi;

property kubeController

kubeController: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController;

property kubelet

kubelet: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet;

property kubeproxy

kubeproxy: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy;

property scheduler

scheduler: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd

property backupConfig

backupConfig: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig;

property caCert

caCert: string;

property cert

cert: string;

property creation

creation: string;

property externalUrls

externalUrls?: string[];

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property gid

gid?: undefined | number;

property image

image: string;

property key

key: string;

property path

path: string;

property retention

retention: string;

property snapshot

snapshot: boolean;

property uid

uid?: undefined | number;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

property intervalHours

intervalHours?: undefined | number;

property retention

retention?: undefined | number;

property s3BackupConfig

s3BackupConfig?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig;

property safeTimestamp

safeTimestamp?: undefined | false | true;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig

property accessKey

accessKey?: undefined | string;

property bucketName

bucketName: string;

property customCa

customCa?: undefined | string;

property endpoint

endpoint: string;

property folder

folder?: undefined | string;

property region

region?: undefined | string;

property secretKey

secretKey?: undefined | string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi

property admissionConfiguration

admissionConfiguration?: undefined | {[key: string]: any};

property alwaysPullImages

alwaysPullImages?: undefined | false | true;

property auditLog

auditLog?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog;

property eventRateLimit

eventRateLimit?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

property podSecurityPolicy

podSecurityPolicy?: undefined | false | true;

property secretsEncryptionConfig

secretsEncryptionConfig?: outputs.ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig;

property serviceClusterIpRange

serviceClusterIpRange: string;

property serviceNodePortRange

serviceNodePortRange: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog

property configuration

configuration: ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration;

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration

property format

format?: undefined | string;

property maxAge

maxAge?: undefined | number;

property maxBackup

maxBackup?: undefined | number;

property maxSize

maxSize?: undefined | number;

property path

path?: undefined | string;

property policy

policy: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit

property configuration

configuration?: undefined | {[key: string]: any};

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig

property customConfig

customConfig?: undefined | {[key: string]: any};

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController

property clusterCidr

clusterCidr: string;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

property serviceClusterIpRange

serviceClusterIpRange: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet

property clusterDnsServer

clusterDnsServer: string;

property clusterDomain

clusterDomain: string;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property failSwapOn

failSwapOn: boolean;

property generateServingCertificate

generateServingCertificate?: undefined | false | true;

property image

image: string;

property infraContainerImage

infraContainerImage: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy

property drain

drain?: undefined | false | true;

property drainInput

drainInput: ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput;

property maxUnavailableControlplane

maxUnavailableControlplane?: undefined | string;

property maxUnavailableWorker

maxUnavailableWorker?: undefined | string;

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput

interface ClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput

property deleteLocalData

deleteLocalData?: undefined | false | true;

property force

force?: undefined | false | true;

property gracePeriod

gracePeriod?: undefined | number;

property ignoreDaemonSets

ignoreDaemonSets?: undefined | false | true;

property timeout

timeout?: undefined | number;

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

property enabled

enabled?: undefined | false | true;

Enable cluster template revision. Default true (bool)

property scanConfig

scanConfig: ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig;

property scheduleConfig

scheduleConfig: ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig;

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig

property cisScanConfig

cisScanConfig: ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig;

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig

property debugMaster

debugMaster?: undefined | false | true;

property debugWorker

debugWorker?: undefined | false | true;

property overrideBenchmarkVersion

overrideBenchmarkVersion?: undefined | string;

property overrideSkips

overrideSkips?: string[];

property profile

profile?: undefined | string;

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig

interface ClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig

property cronSchedule

cronSchedule: string;

property retention

retention: number;

interface ClusterTemplateTemplateRevisionQuestion

interface ClusterTemplateTemplateRevisionQuestion

property default

default: string;

Default variable value (string)

property required

required?: undefined | false | true;

Required variable. Default false (bool)

property type

type?: undefined | string;

Variable type. boolean, int and string are allowed. Default string (string)

property variable

variable: string;

Variable name (string)

interface EtcdBackupBackupConfig

interface EtcdBackupBackupConfig

property enabled

enabled?: undefined | false | true;

Enable etcd backup (bool)

property intervalHours

intervalHours?: undefined | number;

Interval hours for etcd backup. Default 12 (int)

property retention

retention?: undefined | number;

Retention for etcd backup. Default 6 (int)

property s3BackupConfig

s3BackupConfig?: outputs.EtcdBackupBackupConfigS3BackupConfig;

S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)

property safeTimestamp

safeTimestamp?: undefined | false | true;

interface EtcdBackupBackupConfigS3BackupConfig

interface EtcdBackupBackupConfigS3BackupConfig

property accessKey

accessKey?: undefined | string;

Access key for S3 service (string)

property bucketName

bucketName: string;

Bucket name for S3 service (string)

property customCa

customCa?: undefined | string;

Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)

property endpoint

endpoint: string;

Endpoint for S3 service (string)

property folder

folder?: undefined | string;

Folder for S3 service. Available from Rancher v2.2.7 (string)

property region

region?: undefined | string;

Region for S3 service (string)

property secretKey

secretKey?: undefined | string;

Secret key for S3 service (string)

interface GetClusterAksConfig

interface GetClusterAksConfig

property aadServerAppSecret

aadServerAppSecret?: undefined | string;

property aadTenantId

aadTenantId?: undefined | string;

property addClientAppId

addClientAppId?: undefined | string;

property addServerAppId

addServerAppId?: undefined | string;

property adminUsername

adminUsername?: undefined | string;

property agentDnsPrefix

agentDnsPrefix: string;

property agentOsDiskSize

agentOsDiskSize?: undefined | number;

property agentPoolName

agentPoolName?: undefined | string;

property agentStorageProfile

agentStorageProfile?: undefined | string;

property agentVmSize

agentVmSize?: undefined | string;

property authBaseUrl

authBaseUrl?: undefined | string;

property baseUrl

baseUrl?: undefined | string;

property clientId

clientId: string;

property clientSecret

clientSecret: string;

property count

count?: undefined | number;

property dnsServiceIp

dnsServiceIp?: undefined | string;

property dockerBridgeCidr

dockerBridgeCidr?: undefined | string;

property enableHttpApplicationRouting

enableHttpApplicationRouting?: undefined | false | true;

property enableMonitoring

enableMonitoring?: undefined | false | true;

property kubernetesVersion

kubernetesVersion: string;

property location

location?: undefined | string;

property logAnalyticsWorkspace

logAnalyticsWorkspace?: undefined | string;

property logAnalyticsWorkspaceResourceGroup

logAnalyticsWorkspaceResourceGroup?: undefined | string;

property masterDnsPrefix

masterDnsPrefix: string;

property maxPods

maxPods?: undefined | number;

property networkPlugin

networkPlugin?: undefined | string;

property networkPolicy

networkPolicy?: undefined | string;

property podCidr

podCidr?: undefined | string;

property resourceGroup

resourceGroup: string;

property serviceCidr

serviceCidr?: undefined | string;

property sshPublicKeyContents

sshPublicKeyContents: string;

property subnet

subnet: string;

property subscriptionId

subscriptionId: string;

property tag

tag: {[key: string]: any};

property tenantId

tenantId: string;

property virtualNetwork

virtualNetwork: string;

property virtualNetworkResourceGroup

virtualNetworkResourceGroup: string;

interface GetClusterAlertGroupRecipient

interface GetClusterAlertGroupRecipient

property defaultRecipient

defaultRecipient?: undefined | false | true;

property notifierId

notifierId: string;

property notifierType

notifierType: string;

property recipient

recipient: string;

interface GetClusterAlterRuleEventRule

interface GetClusterAlterRuleEventRule

property eventType

eventType?: undefined | string;

property resourceKind

resourceKind: string;

interface GetClusterAlterRuleMetricRule

interface GetClusterAlterRuleMetricRule

property comparison

comparison?: undefined | string;

property description

description?: undefined | string;

property duration

duration: string;

property expression

expression: string;

property thresholdValue

thresholdValue: number;

interface GetClusterAlterRuleNodeRule

interface GetClusterAlterRuleNodeRule

property condition

condition?: undefined | string;

property cpuThreshold

cpuThreshold?: undefined | number;

property memThreshold

memThreshold?: undefined | number;

property nodeId

nodeId?: undefined | string;

property selector

selector?: undefined | {[key: string]: any};

interface GetClusterAlterRuleSystemServiceRule

interface GetClusterAlterRuleSystemServiceRule

property condition

condition?: undefined | string;

interface GetClusterClusterAuthEndpoint

interface GetClusterClusterAuthEndpoint

property caCerts

caCerts?: undefined | string;

property enabled

enabled?: undefined | false | true;

property fqdn

fqdn?: undefined | string;

interface GetClusterClusterMonitoringInput

interface GetClusterClusterMonitoringInput

property answers

answers?: undefined | {[key: string]: any};

property version

version?: undefined | string;

interface GetClusterClusterRegistrationToken

interface GetClusterClusterRegistrationToken

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for Node Pool object (map)

property clusterId

clusterId: string;

property command

command: string;

property id

id: string;

(Computed) The ID of the resource (string)

property insecureCommand

insecureCommand: string;

property labels

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

(Computed) Labels for Node Pool object (map)

property manifestUrl

manifestUrl: string;

property name

name: string;

The name of the Cluster (string)

property nodeCommand

nodeCommand: string;

property token

token: string;

property windowsNodeCommand

windowsNodeCommand: string;

interface GetClusterClusterTemplateAnswers

interface GetClusterClusterTemplateAnswers

property clusterId

clusterId: string;

property projectId

projectId: string;

property values

values: {[key: string]: any};

interface GetClusterClusterTemplateQuestion

interface GetClusterClusterTemplateQuestion

property default

default: string;

property required

required?: undefined | false | true;

property type

type?: undefined | string;

property variable

variable: string;

interface GetClusterEksConfig

interface GetClusterEksConfig

property accessKey

accessKey: string;

property ami

ami?: undefined | string;

property associateWorkerNodePublicIp

associateWorkerNodePublicIp?: undefined | false | true;

property desiredNodes

desiredNodes?: undefined | number;

property instanceType

instanceType?: undefined | string;

property keyPairName

keyPairName?: undefined | string;

property kubernetesVersion

kubernetesVersion: string;

property maximumNodes

maximumNodes?: undefined | number;

property minimumNodes

minimumNodes?: undefined | number;

property nodeVolumeSize

nodeVolumeSize?: undefined | number;

property region

region?: undefined | string;

property secretKey

secretKey: string;

property securityGroups

securityGroups?: string[];

property serviceRole

serviceRole?: undefined | string;

property sessionToken

sessionToken?: undefined | string;

property subnets

subnets?: string[];

property userData

userData: string;

property virtualNetwork

virtualNetwork?: undefined | string;

interface GetClusterGkeConfig

interface GetClusterGkeConfig

property clusterIpv4Cidr

clusterIpv4Cidr: string;

property credential

credential: string;

property description

description?: undefined | string;

(Computed) The description for Cluster (string)

property diskSizeGb

diskSizeGb?: undefined | number;

property diskType

diskType: string;

property enableAlphaFeature

enableAlphaFeature?: undefined | false | true;

property enableAutoRepair

enableAutoRepair?: undefined | false | true;

property enableAutoUpgrade

enableAutoUpgrade?: undefined | false | true;

property enableHorizontalPodAutoscaling

enableHorizontalPodAutoscaling?: undefined | false | true;

property enableHttpLoadBalancing

enableHttpLoadBalancing?: undefined | false | true;

property enableKubernetesDashboard

enableKubernetesDashboard?: undefined | false | true;

property enableLegacyAbac

enableLegacyAbac?: undefined | false | true;

property enableMasterAuthorizedNetwork

enableMasterAuthorizedNetwork?: undefined | false | true;

property enableNetworkPolicyConfig

enableNetworkPolicyConfig?: undefined | false | true;

property enableNodepoolAutoscaling

enableNodepoolAutoscaling?: undefined | false | true;

property enablePrivateEndpoint

enablePrivateEndpoint?: undefined | false | true;

property enablePrivateNodes

enablePrivateNodes?: undefined | false | true;

property enableStackdriverLogging

enableStackdriverLogging?: undefined | false | true;

property enableStackdriverMonitoring

enableStackdriverMonitoring?: undefined | false | true;

property imageType

imageType: string;

property ipPolicyClusterIpv4CidrBlock

ipPolicyClusterIpv4CidrBlock: string;

property ipPolicyClusterSecondaryRangeName

ipPolicyClusterSecondaryRangeName: string;

property ipPolicyCreateSubnetwork

ipPolicyCreateSubnetwork?: undefined | false | true;

property ipPolicyNodeIpv4CidrBlock

ipPolicyNodeIpv4CidrBlock: string;

property ipPolicyServicesIpv4CidrBlock

ipPolicyServicesIpv4CidrBlock: string;

property ipPolicyServicesSecondaryRangeName

ipPolicyServicesSecondaryRangeName: string;

property ipPolicySubnetworkName

ipPolicySubnetworkName: string;

property issueClientCertificate

issueClientCertificate?: undefined | false | true;

property kubernetesDashboard

kubernetesDashboard?: undefined | false | true;

property labels

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

(Computed) Labels for Node Pool object (map)

property localSsdCount

localSsdCount?: undefined | number;

property locations

locations: string[];

property machineType

machineType: string;

property maintenanceWindow

maintenanceWindow: string;

property masterAuthorizedNetworkCidrBlocks

masterAuthorizedNetworkCidrBlocks?: string[];

property masterIpv4CidrBlock

masterIpv4CidrBlock: string;

property masterVersion

masterVersion: string;

property maxNodeCount

maxNodeCount?: undefined | number;

property minNodeCount

minNodeCount?: undefined | number;

property network

network: string;

property nodeCount

nodeCount?: undefined | number;

property nodePool

nodePool: string;

property nodeVersion

nodeVersion: string;

property oauthScopes

oauthScopes: string[];

property preemptible

preemptible?: undefined | false | true;

property projectId

projectId: string;

property resourceLabels

resourceLabels: {[key: string]: any};

property serviceAccount

serviceAccount: string;

property subNetwork

subNetwork: string;

property taints

taints?: string[];

property useIpAliases

useIpAliases?: undefined | false | true;

property zone

zone?: undefined | string;

interface GetClusterK3sConfig

interface GetClusterK3sConfig

property upgradeStrategy

upgradeStrategy: GetClusterK3sConfigUpgradeStrategy;

property version

version: string;

interface GetClusterK3sConfigUpgradeStrategy

interface GetClusterK3sConfigUpgradeStrategy

property drainServerNodes

drainServerNodes?: undefined | false | true;

property drainWorkerNodes

drainWorkerNodes?: undefined | false | true;

property serverConcurrency

serverConcurrency?: undefined | number;

property workerConcurrency

workerConcurrency?: undefined | number;

interface GetClusterLoggingCustomTargetConfig

interface GetClusterLoggingCustomTargetConfig

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property content

content: string;

interface GetClusterLoggingElasticsearchConfig

interface GetClusterLoggingElasticsearchConfig

property authPassword

authPassword?: undefined | string;

property authUsername

authUsername?: undefined | string;

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property clientKeyPass

clientKeyPass?: undefined | string;

property dateFormat

dateFormat?: undefined | string;

property endpoint

endpoint: string;

property indexPrefix

indexPrefix?: undefined | string;

property sslVerify

sslVerify: boolean;

property sslVersion

sslVersion?: undefined | string;

interface GetClusterLoggingFluentdConfig

interface GetClusterLoggingFluentdConfig

property certificate

certificate?: undefined | string;

property compress

compress?: undefined | false | true;

property enableTls

enableTls?: undefined | false | true;

property fluentServers

fluentServers: GetClusterLoggingFluentdConfigFluentServer[];

interface GetClusterLoggingFluentdConfigFluentServer

interface GetClusterLoggingFluentdConfigFluentServer

property endpoint

endpoint: string;

property hostname

hostname?: undefined | string;

property password

password?: undefined | string;

property sharedKey

sharedKey?: undefined | string;

property standby

standby?: undefined | false | true;

property username

username?: undefined | string;

property weight

weight?: undefined | number;

interface GetClusterLoggingKafkaConfig

interface GetClusterLoggingKafkaConfig

property brokerEndpoints

brokerEndpoints?: string[];

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property topic

topic: string;

property zookeeperEndpoint

zookeeperEndpoint?: undefined | string;

interface GetClusterLoggingSplunkConfig

interface GetClusterLoggingSplunkConfig

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property clientKeyPass

clientKeyPass?: undefined | string;

property endpoint

endpoint: string;

property index

index?: undefined | string;

property source

source?: undefined | string;

property sslVerify

sslVerify: boolean;

property token

token: string;

interface GetClusterLoggingSyslogConfig

interface GetClusterLoggingSyslogConfig

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property endpoint

endpoint: string;

property program

program?: undefined | string;

property protocol

protocol?: undefined | string;

property severity

severity?: undefined | string;

property sslVerify

sslVerify: boolean;

property token

token?: undefined | string;

interface GetClusterRkeConfig

interface GetClusterRkeConfig

property addonJobTimeout

addonJobTimeout: number;

property addons

addons?: undefined | string;

property addonsIncludes

addonsIncludes?: string[];

property authentication

authentication: GetClusterRkeConfigAuthentication;

property authorization

authorization: GetClusterRkeConfigAuthorization;

property bastionHost

bastionHost: GetClusterRkeConfigBastionHost;

property cloudProvider

cloudProvider: GetClusterRkeConfigCloudProvider;

property dns

dns: GetClusterRkeConfigDns;

property ignoreDockerVersion

ignoreDockerVersion?: undefined | false | true;

property ingress

ingress: GetClusterRkeConfigIngress;

property kubernetesVersion

kubernetesVersion: string;

property monitoring

monitoring: GetClusterRkeConfigMonitoring;

property network

network: GetClusterRkeConfigNetwork;

property nodes

nodes?: GetClusterRkeConfigNode[];

property prefixPath

prefixPath: string;

property privateRegistries

privateRegistries?: GetClusterRkeConfigPrivateRegistry[];

property services

services: GetClusterRkeConfigServices;

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshCertPath

sshCertPath: string;

property sshKeyPath

sshKeyPath: string;

property upgradeStrategy

upgradeStrategy: GetClusterRkeConfigUpgradeStrategy;

interface GetClusterRkeConfigAuthentication

interface GetClusterRkeConfigAuthentication

property sans

sans: string[];

property strategy

strategy: string;

interface GetClusterRkeConfigAuthorization

interface GetClusterRkeConfigAuthorization

property mode

mode?: undefined | string;

property options

options: {[key: string]: any};

interface GetClusterRkeConfigBastionHost

interface GetClusterRkeConfigBastionHost

property address

address: string;

property port

port?: undefined | string;

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshKey

sshKey: string;

property sshKeyPath

sshKeyPath: string;

property user

user: string;

interface GetClusterRkeConfigCloudProvider

interface GetClusterRkeConfigCloudProvider

property awsCloudProvider

awsCloudProvider?: outputs.GetClusterRkeConfigCloudProviderAwsCloudProvider;

property azureCloudProvider

azureCloudProvider?: outputs.GetClusterRkeConfigCloudProviderAzureCloudProvider;

property customCloudProvider

customCloudProvider: string;

property name

name: string;

The name of the Cluster (string)

property openstackCloudProvider

openstackCloudProvider?: outputs.GetClusterRkeConfigCloudProviderOpenstackCloudProvider;

property vsphereCloudProvider

vsphereCloudProvider?: outputs.GetClusterRkeConfigCloudProviderVsphereCloudProvider;

interface GetClusterRkeConfigCloudProviderAwsCloudProvider

interface GetClusterRkeConfigCloudProviderAwsCloudProvider

property global

global: GetClusterRkeConfigCloudProviderAwsCloudProviderGlobal;

property serviceOverrides

serviceOverrides?: GetClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride[];

interface GetClusterRkeConfigCloudProviderAwsCloudProviderGlobal

interface GetClusterRkeConfigCloudProviderAwsCloudProviderGlobal

property disableSecurityGroupIngress

disableSecurityGroupIngress?: undefined | false | true;

property disableStrictZoneCheck

disableStrictZoneCheck?: undefined | false | true;

property elbSecurityGroup

elbSecurityGroup: string;

property kubernetesClusterId

kubernetesClusterId: string;

property kubernetesClusterTag

kubernetesClusterTag: string;

property roleArn

roleArn: string;

property routeTableId

routeTableId: string;

property subnetId

subnetId: string;

property vpc

vpc: string;

property zone

zone: string;

interface GetClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

interface GetClusterRkeConfigCloudProviderAwsCloudProviderServiceOverride

property region

region: string;

property service

service: string;

property signingMethod

signingMethod: string;

property signingName

signingName: string;

property signingRegion

signingRegion: string;

property url

url: string;

interface GetClusterRkeConfigCloudProviderAzureCloudProvider

interface GetClusterRkeConfigCloudProviderAzureCloudProvider

property aadClientCertPassword

aadClientCertPassword: string;

property aadClientCertPath

aadClientCertPath: string;

property aadClientId

aadClientId: string;

property aadClientSecret

aadClientSecret: string;

property cloud

cloud: string;

property cloudProviderBackoff

cloudProviderBackoff: boolean;

property cloudProviderBackoffDuration

cloudProviderBackoffDuration: number;

property cloudProviderBackoffExponent

cloudProviderBackoffExponent: number;

property cloudProviderBackoffJitter

cloudProviderBackoffJitter: number;

property cloudProviderBackoffRetries

cloudProviderBackoffRetries: number;

property cloudProviderRateLimit

cloudProviderRateLimit: boolean;

property cloudProviderRateLimitBucket

cloudProviderRateLimitBucket: number;

property cloudProviderRateLimitQps

cloudProviderRateLimitQps: number;

property location

location: string;

property maximumLoadBalancerRuleCount

maximumLoadBalancerRuleCount: number;

property primaryAvailabilitySetName

primaryAvailabilitySetName: string;

property primaryScaleSetName

primaryScaleSetName: string;

property resourceGroup

resourceGroup: string;

property routeTableName

routeTableName: string;

property securityGroupName

securityGroupName: string;

property subnetName

subnetName: string;

property subscriptionId

subscriptionId: string;

property tenantId

tenantId: string;

property useInstanceMetadata

useInstanceMetadata: boolean;

property useManagedIdentityExtension

useManagedIdentityExtension: boolean;

property vmType

vmType: string;

property vnetName

vnetName: string;

property vnetResourceGroup

vnetResourceGroup: string;

interface GetClusterRkeConfigCloudProviderOpenstackCloudProvider

interface GetClusterRkeConfigCloudProviderOpenstackCloudProvider

property blockStorage

blockStorage: GetClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage;

property global

global: GetClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal;

property loadBalancer

loadBalancer: GetClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer;

property metadata

metadata: GetClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata;

property route

route: GetClusterRkeConfigCloudProviderOpenstackCloudProviderRoute;

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

property bsVersion

bsVersion: string;

property ignoreVolumeAz

ignoreVolumeAz: boolean;

property trustDevicePath

trustDevicePath: boolean;

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderGlobal

property authUrl

authUrl: string;

property caFile

caFile: string;

property domainId

domainId: string;

property domainName

domainName: string;

property password

password: string;

property region

region: string;

property tenantId

tenantId: string;

property tenantName

tenantName: string;

property trustId

trustId: string;

property username

username: string;

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

property createMonitor

createMonitor: boolean;

property floatingNetworkId

floatingNetworkId: string;

property lbMethod

lbMethod: string;

property lbProvider

lbProvider: string;

property lbVersion

lbVersion: string;

property manageSecurityGroups

manageSecurityGroups: boolean;

property monitorDelay

monitorDelay?: undefined | string;

property monitorMaxRetries

monitorMaxRetries?: undefined | number;

property monitorTimeout

monitorTimeout?: undefined | string;

property subnetId

subnetId: string;

property useOctavia

useOctavia: boolean;

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderMetadata

property requestTimeout

requestTimeout: number;

property searchOrder

searchOrder: string;

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

interface GetClusterRkeConfigCloudProviderOpenstackCloudProviderRoute

property routerId

routerId: string;

interface GetClusterRkeConfigCloudProviderVsphereCloudProvider

interface GetClusterRkeConfigCloudProviderVsphereCloudProvider

property disk

disk: GetClusterRkeConfigCloudProviderVsphereCloudProviderDisk;

property global

global: GetClusterRkeConfigCloudProviderVsphereCloudProviderGlobal;

property network

network: GetClusterRkeConfigCloudProviderVsphereCloudProviderNetwork;

property virtualCenters

virtualCenters: GetClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter[];

property workspace

workspace: GetClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace;

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderDisk

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderDisk

property scsiControllerType

scsiControllerType: string;

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderGlobal

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderGlobal

property datacenters

datacenters: string;

property insecureFlag

insecureFlag: boolean;

property password

password: string;

property port

port: string;

property soapRoundtripCount

soapRoundtripCount: number;

property user

user: string;

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderNetwork

property publicNetwork

publicNetwork: string;

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

property datacenters

datacenters: string;

property name

name: string;

The name of the Cluster (string)

property password

password: string;

property port

port: string;

property soapRoundtripCount

soapRoundtripCount: number;

property user

user: string;

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace

interface GetClusterRkeConfigCloudProviderVsphereCloudProviderWorkspace

property datacenter

datacenter: string;

property defaultDatastore

defaultDatastore: string;

property folder

folder: string;

property resourcepoolPath

resourcepoolPath: string;

property server

server: string;

interface GetClusterRkeConfigDns

interface GetClusterRkeConfigDns

property nodeSelector

nodeSelector: {[key: string]: any};

property provider

provider?: undefined | string;

property reverseCidrs

reverseCidrs: string[];

property upstreamNameservers

upstreamNameservers: string[];

interface GetClusterRkeConfigIngress

interface GetClusterRkeConfigIngress

property dnsPolicy

dnsPolicy: string;

property extraArgs

extraArgs: {[key: string]: any};

property nodeSelector

nodeSelector: {[key: string]: any};

property options

options: {[key: string]: any};

property provider

provider: string;

interface GetClusterRkeConfigMonitoring

interface GetClusterRkeConfigMonitoring

property options

options: {[key: string]: any};

property provider

provider: string;

interface GetClusterRkeConfigNetwork

interface GetClusterRkeConfigNetwork

property calicoNetworkProvider

calicoNetworkProvider?: outputs.GetClusterRkeConfigNetworkCalicoNetworkProvider;

property canalNetworkProvider

canalNetworkProvider?: outputs.GetClusterRkeConfigNetworkCanalNetworkProvider;

property flannelNetworkProvider

flannelNetworkProvider?: outputs.GetClusterRkeConfigNetworkFlannelNetworkProvider;

property mtu

mtu?: undefined | number;

property options

options: {[key: string]: any};

property plugin

plugin: string;

property weaveNetworkProvider

weaveNetworkProvider?: outputs.GetClusterRkeConfigNetworkWeaveNetworkProvider;

interface GetClusterRkeConfigNetworkCalicoNetworkProvider

interface GetClusterRkeConfigNetworkCalicoNetworkProvider

property cloudProvider

cloudProvider: string;

interface GetClusterRkeConfigNetworkCanalNetworkProvider

interface GetClusterRkeConfigNetworkCanalNetworkProvider

property iface

iface: string;

interface GetClusterRkeConfigNetworkFlannelNetworkProvider

interface GetClusterRkeConfigNetworkFlannelNetworkProvider

property iface

iface: string;

interface GetClusterRkeConfigNetworkWeaveNetworkProvider

interface GetClusterRkeConfigNetworkWeaveNetworkProvider

property password

password: string;

interface GetClusterRkeConfigNode

interface GetClusterRkeConfigNode

property address

address: string;

property dockerSocket

dockerSocket: string;

property hostnameOverride

hostnameOverride?: undefined | string;

property internalAddress

internalAddress?: undefined | string;

property labels

labels?: undefined | {[key: string]: any};

(Computed) Labels for Node Pool object (map)

property nodeId

nodeId?: undefined | string;

property port

port?: undefined | string;

property roles

roles: string[];

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshKey

sshKey: string;

property sshKeyPath

sshKeyPath: string;

property user

user: string;

interface GetClusterRkeConfigPrivateRegistry

interface GetClusterRkeConfigPrivateRegistry

property isDefault

isDefault?: undefined | false | true;

property password

password?: undefined | string;

property url

url: string;

property user

user?: undefined | string;

interface GetClusterRkeConfigServices

interface GetClusterRkeConfigServices

property etcd

etcd: GetClusterRkeConfigServicesEtcd;

property kubeApi

kubeApi: GetClusterRkeConfigServicesKubeApi;

property kubeController

kubeController: GetClusterRkeConfigServicesKubeController;

property kubelet

kubelet: GetClusterRkeConfigServicesKubelet;

property kubeproxy

kubeproxy: GetClusterRkeConfigServicesKubeproxy;

property scheduler

scheduler: GetClusterRkeConfigServicesScheduler;

interface GetClusterRkeConfigServicesEtcd

interface GetClusterRkeConfigServicesEtcd

property backupConfig

backupConfig: GetClusterRkeConfigServicesEtcdBackupConfig;

property caCert

caCert: string;

property cert

cert: string;

property creation

creation: string;

property externalUrls

externalUrls?: string[];

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property gid

gid?: undefined | number;

property image

image: string;

property key

key: string;

property path

path: string;

property retention

retention: string;

property snapshot

snapshot: boolean;

property uid

uid?: undefined | number;

interface GetClusterRkeConfigServicesEtcdBackupConfig

interface GetClusterRkeConfigServicesEtcdBackupConfig

property enabled

enabled?: undefined | false | true;

property intervalHours

intervalHours?: undefined | number;

property retention

retention?: undefined | number;

property s3BackupConfig

s3BackupConfig?: outputs.GetClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig;

property safeTimestamp

safeTimestamp?: undefined | false | true;

interface GetClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig

interface GetClusterRkeConfigServicesEtcdBackupConfigS3BackupConfig

property accessKey

accessKey?: undefined | string;

property bucketName

bucketName: string;

property customCa

customCa?: undefined | string;

property endpoint

endpoint: string;

property folder

folder?: undefined | string;

property region

region?: undefined | string;

property secretKey

secretKey?: undefined | string;

interface GetClusterRkeConfigServicesKubeApi

interface GetClusterRkeConfigServicesKubeApi

property admissionConfiguration

admissionConfiguration?: undefined | {[key: string]: any};

property alwaysPullImages

alwaysPullImages?: undefined | false | true;

property auditLog

auditLog?: outputs.GetClusterRkeConfigServicesKubeApiAuditLog;

property eventRateLimit

eventRateLimit?: outputs.GetClusterRkeConfigServicesKubeApiEventRateLimit;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

property podSecurityPolicy

podSecurityPolicy?: undefined | false | true;

property secretsEncryptionConfig

secretsEncryptionConfig?: outputs.GetClusterRkeConfigServicesKubeApiSecretsEncryptionConfig;

property serviceClusterIpRange

serviceClusterIpRange: string;

property serviceNodePortRange

serviceNodePortRange: string;

interface GetClusterRkeConfigServicesKubeApiAuditLog

interface GetClusterRkeConfigServicesKubeApiAuditLog

property configuration

configuration: GetClusterRkeConfigServicesKubeApiAuditLogConfiguration;

property enabled

enabled?: undefined | false | true;

interface GetClusterRkeConfigServicesKubeApiAuditLogConfiguration

interface GetClusterRkeConfigServicesKubeApiAuditLogConfiguration

property format

format?: undefined | string;

property maxAge

maxAge?: undefined | number;

property maxBackup

maxBackup?: undefined | number;

property maxSize

maxSize?: undefined | number;

property path

path?: undefined | string;

property policy

policy: string;

interface GetClusterRkeConfigServicesKubeApiEventRateLimit

interface GetClusterRkeConfigServicesKubeApiEventRateLimit

property configuration

configuration?: undefined | {[key: string]: any};

property enabled

enabled?: undefined | false | true;

interface GetClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

interface GetClusterRkeConfigServicesKubeApiSecretsEncryptionConfig

property customConfig

customConfig?: undefined | {[key: string]: any};

property enabled

enabled?: undefined | false | true;

interface GetClusterRkeConfigServicesKubeController

interface GetClusterRkeConfigServicesKubeController

property clusterCidr

clusterCidr: string;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

property serviceClusterIpRange

serviceClusterIpRange: string;

interface GetClusterRkeConfigServicesKubelet

interface GetClusterRkeConfigServicesKubelet

property clusterDnsServer

clusterDnsServer: string;

property clusterDomain

clusterDomain: string;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property failSwapOn

failSwapOn: boolean;

property generateServingCertificate

generateServingCertificate?: undefined | false | true;

property image

image: string;

property infraContainerImage

infraContainerImage: string;

interface GetClusterRkeConfigServicesKubeproxy

interface GetClusterRkeConfigServicesKubeproxy

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

interface GetClusterRkeConfigServicesScheduler

interface GetClusterRkeConfigServicesScheduler

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

interface GetClusterRkeConfigUpgradeStrategy

interface GetClusterRkeConfigUpgradeStrategy

property drain

drain?: undefined | false | true;

property drainInput

drainInput: GetClusterRkeConfigUpgradeStrategyDrainInput;

property maxUnavailableControlplane

maxUnavailableControlplane?: undefined | string;

property maxUnavailableWorker

maxUnavailableWorker?: undefined | string;

interface GetClusterRkeConfigUpgradeStrategyDrainInput

interface GetClusterRkeConfigUpgradeStrategyDrainInput

property deleteLocalData

deleteLocalData?: undefined | false | true;

property force

force?: undefined | false | true;

property gracePeriod

gracePeriod?: undefined | number;

property ignoreDaemonSets

ignoreDaemonSets?: undefined | false | true;

property timeout

timeout?: undefined | number;

interface GetClusterScanScanConfig

interface GetClusterScanScanConfig

property cisScanConfig

cisScanConfig: GetClusterScanScanConfigCisScanConfig;

interface GetClusterScanScanConfigCisScanConfig

interface GetClusterScanScanConfigCisScanConfig

property debugMaster

debugMaster?: undefined | false | true;

property debugWorker

debugWorker?: undefined | false | true;

property overrideBenchmarkVersion

overrideBenchmarkVersion?: undefined | string;

property overrideSkips

overrideSkips?: string[];

property profile

profile?: undefined | string;

interface GetClusterScheduledClusterScan

interface GetClusterScheduledClusterScan

property enabled

enabled?: undefined | false | true;

property scanConfig

scanConfig: GetClusterScheduledClusterScanScanConfig;

property scheduleConfig

scheduleConfig: GetClusterScheduledClusterScanScheduleConfig;

interface GetClusterScheduledClusterScanScanConfig

interface GetClusterScheduledClusterScanScanConfig

property cisScanConfig

cisScanConfig: GetClusterScheduledClusterScanScanConfigCisScanConfig;

interface GetClusterScheduledClusterScanScanConfigCisScanConfig

interface GetClusterScheduledClusterScanScanConfigCisScanConfig

property debugMaster

debugMaster?: undefined | false | true;

property debugWorker

debugWorker?: undefined | false | true;

property overrideBenchmarkVersion

overrideBenchmarkVersion?: undefined | string;

property overrideSkips

overrideSkips?: string[];

property profile

profile?: undefined | string;

interface GetClusterScheduledClusterScanScheduleConfig

interface GetClusterScheduledClusterScanScheduleConfig

property cronSchedule

cronSchedule: string;

property retention

retention: number;

interface GetClusterTemplateMember

interface GetClusterTemplateMember

property accessType

accessType?: undefined | string;

property groupPrincipalId

groupPrincipalId?: undefined | string;

property userPrincipalId

userPrincipalId?: undefined | string;

interface GetClusterTemplateTemplateRevision

interface GetClusterTemplateTemplateRevision

property annotations

annotations: {[key: string]: any};

(Computed) Annotations for the cluster template (map)

property clusterConfig

clusterConfig: GetClusterTemplateTemplateRevisionClusterConfig;

property clusterTemplateId

clusterTemplateId: string;

property default

default?: undefined | false | true;

property enabled

enabled?: undefined | false | true;

property id

id: string;

(Computed) The ID of the resource (string)

property labels

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

(Computed) Labels for the cluster template (map)

property name

name: string;

The cluster template name (string)

property questions

questions?: GetClusterTemplateTemplateRevisionQuestion[];

interface GetClusterTemplateTemplateRevisionClusterConfig

interface GetClusterTemplateTemplateRevisionClusterConfig

property clusterAuthEndpoint

clusterAuthEndpoint: GetClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint;

property defaultClusterRoleForProjectMembers

defaultClusterRoleForProjectMembers: string;

property defaultPodSecurityPolicyTemplateId

defaultPodSecurityPolicyTemplateId: string;

property desiredAgentImage

desiredAgentImage: string;

property desiredAuthImage

desiredAuthImage: string;

property dockerRootDir

dockerRootDir: string;

property enableClusterAlerting

enableClusterAlerting?: undefined | false | true;

property enableClusterMonitoring

enableClusterMonitoring?: undefined | false | true;

property enableNetworkPolicy

enableNetworkPolicy?: undefined | false | true;

property rkeConfig

rkeConfig: GetClusterTemplateTemplateRevisionClusterConfigRkeConfig;

property scheduledClusterScan

scheduledClusterScan?: outputs.GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan;

property windowsPreferedCluster

windowsPreferedCluster?: undefined | false | true;

interface GetClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

interface GetClusterTemplateTemplateRevisionClusterConfigClusterAuthEndpoint

property caCerts

caCerts?: undefined | string;

property enabled

enabled?: undefined | false | true;

property fqdn

fqdn?: undefined | string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfig

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfig

property addonJobTimeout

addonJobTimeout: number;

property addons

addons?: undefined | string;

property addonsIncludes

addonsIncludes?: string[];

property authentication

authentication: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication;

property authorization

authorization: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization;

property bastionHost

bastionHost: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost;

property cloudProvider

cloudProvider: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider;

property dns

dns: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigDns;

property ignoreDockerVersion

ignoreDockerVersion?: undefined | false | true;

property ingress

ingress: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress;

property kubernetesVersion

kubernetesVersion: string;

property monitoring

monitoring: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring;

property network

network: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork;

property nodes

nodes?: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNode[];

property prefixPath

prefixPath: string;

property privateRegistries

privateRegistries?: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry[];

property services

services: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServices;

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshCertPath

sshCertPath: string;

property sshKeyPath

sshKeyPath: string;

property upgradeStrategy

upgradeStrategy: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthentication

property sans

sans: string[];

property strategy

strategy: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigAuthorization

property mode

mode?: undefined | string;

property options

options: {[key: string]: any};

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigBastionHost

property address

address: string;

property port

port?: undefined | string;

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshKey

sshKey: string;

property sshKeyPath

sshKeyPath: string;

property user

user: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProvider

property awsCloudProvider

awsCloudProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider;

property azureCloudProvider

azureCloudProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider;

property customCloudProvider

customCloudProvider: string;

property name

name: string;

The cluster template name (string)

property openstackCloudProvider

openstackCloudProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider;

property vsphereCloudProvider

vsphereCloudProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProvider

property global

global: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal;

property serviceOverrides

serviceOverrides?: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride[];

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderGlobal

property disableSecurityGroupIngress

disableSecurityGroupIngress?: undefined | false | true;

property disableStrictZoneCheck

disableStrictZoneCheck?: undefined | false | true;

property elbSecurityGroup

elbSecurityGroup: string;

property kubernetesClusterId

kubernetesClusterId: string;

property kubernetesClusterTag

kubernetesClusterTag: string;

property roleArn

roleArn: string;

property routeTableId

routeTableId: string;

property subnetId

subnetId: string;

property vpc

vpc: string;

property zone

zone: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAwsCloudProviderServiceOverride

property region

region: string;

property service

service: string;

property signingMethod

signingMethod: string;

property signingName

signingName: string;

property signingRegion

signingRegion: string;

property url

url: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderAzureCloudProvider

property aadClientCertPassword

aadClientCertPassword: string;

property aadClientCertPath

aadClientCertPath: string;

property aadClientId

aadClientId: string;

property aadClientSecret

aadClientSecret: string;

property cloud

cloud: string;

property cloudProviderBackoff

cloudProviderBackoff: boolean;

property cloudProviderBackoffDuration

cloudProviderBackoffDuration: number;

property cloudProviderBackoffExponent

cloudProviderBackoffExponent: number;

property cloudProviderBackoffJitter

cloudProviderBackoffJitter: number;

property cloudProviderBackoffRetries

cloudProviderBackoffRetries: number;

property cloudProviderRateLimit

cloudProviderRateLimit: boolean;

property cloudProviderRateLimitBucket

cloudProviderRateLimitBucket: number;

property cloudProviderRateLimitQps

cloudProviderRateLimitQps: number;

property location

location: string;

property maximumLoadBalancerRuleCount

maximumLoadBalancerRuleCount: number;

property primaryAvailabilitySetName

primaryAvailabilitySetName: string;

property primaryScaleSetName

primaryScaleSetName: string;

property resourceGroup

resourceGroup: string;

property routeTableName

routeTableName: string;

property securityGroupName

securityGroupName: string;

property subnetName

subnetName: string;

property subscriptionId

subscriptionId: string;

property tenantId

tenantId: string;

property useInstanceMetadata

useInstanceMetadata: boolean;

property useManagedIdentityExtension

useManagedIdentityExtension: boolean;

property vmType

vmType: string;

property vnetName

vnetName: string;

property vnetResourceGroup

vnetResourceGroup: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProvider

property blockStorage

blockStorage: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage;

property global

global: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal;

property loadBalancer

loadBalancer: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer;

property metadata

metadata: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata;

property route

route: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderBlockStorage

property bsVersion

bsVersion: string;

property ignoreVolumeAz

ignoreVolumeAz: boolean;

property trustDevicePath

trustDevicePath: boolean;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderGlobal

property authUrl

authUrl: string;

property caFile

caFile: string;

property domainId

domainId: string;

property domainName

domainName: string;

property password

password: string;

property region

region: string;

property tenantId

tenantId: string;

property tenantName

tenantName: string;

property trustId

trustId: string;

property username

username: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderLoadBalancer

property createMonitor

createMonitor: boolean;

property floatingNetworkId

floatingNetworkId: string;

property lbMethod

lbMethod: string;

property lbProvider

lbProvider: string;

property lbVersion

lbVersion: string;

property manageSecurityGroups

manageSecurityGroups: boolean;

property monitorDelay

monitorDelay?: undefined | string;

property monitorMaxRetries

monitorMaxRetries?: undefined | number;

property monitorTimeout

monitorTimeout?: undefined | string;

property subnetId

subnetId: string;

property useOctavia

useOctavia: boolean;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderMetadata

property requestTimeout

requestTimeout: number;

property searchOrder

searchOrder: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderOpenstackCloudProviderRoute

property routerId

routerId: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProvider

property disk

disk: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk;

property global

global: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal;

property network

network: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork;

property virtualCenters

virtualCenters: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter[];

property workspace

workspace: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderDisk

property scsiControllerType

scsiControllerType: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderGlobal

property datacenters

datacenters: string;

property insecureFlag

insecureFlag: boolean;

property password

password: string;

property port

port: string;

property soapRoundtripCount

soapRoundtripCount: number;

property user

user: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderNetwork

property publicNetwork

publicNetwork: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderVirtualCenter

property datacenters

datacenters: string;

property name

name: string;

The cluster template name (string)

property password

password: string;

property port

port: string;

property soapRoundtripCount

soapRoundtripCount: number;

property user

user: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigCloudProviderVsphereCloudProviderWorkspace

property datacenter

datacenter: string;

property defaultDatastore

defaultDatastore: string;

property folder

folder: string;

property resourcepoolPath

resourcepoolPath: string;

property server

server: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigDns

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigDns

property nodeSelector

nodeSelector: {[key: string]: any};

property provider

provider?: undefined | string;

property reverseCidrs

reverseCidrs: string[];

property upstreamNameservers

upstreamNameservers: string[];

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigIngress

property dnsPolicy

dnsPolicy: string;

property extraArgs

extraArgs: {[key: string]: any};

property nodeSelector

nodeSelector: {[key: string]: any};

property options

options: {[key: string]: any};

property provider

provider: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigMonitoring

property options

options: {[key: string]: any};

property provider

provider: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetwork

property calicoNetworkProvider

calicoNetworkProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider;

property canalNetworkProvider

canalNetworkProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider;

property flannelNetworkProvider

flannelNetworkProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider;

property mtu

mtu?: undefined | number;

property options

options: {[key: string]: any};

property plugin

plugin: string;

property weaveNetworkProvider

weaveNetworkProvider?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCalicoNetworkProvider

property cloudProvider

cloudProvider: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkCanalNetworkProvider

property iface

iface: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkFlannelNetworkProvider

property iface

iface: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNetworkWeaveNetworkProvider

property password

password: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNode

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigNode

property address

address: string;

property dockerSocket

dockerSocket: string;

property hostnameOverride

hostnameOverride?: undefined | string;

property internalAddress

internalAddress?: undefined | string;

property labels

labels?: undefined | {[key: string]: any};

(Computed) Labels for the cluster template (map)

property nodeId

nodeId?: undefined | string;

property port

port?: undefined | string;

property roles

roles: string[];

property sshAgentAuth

sshAgentAuth?: undefined | false | true;

property sshKey

sshKey: string;

property sshKeyPath

sshKeyPath: string;

property user

user: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigPrivateRegistry

property isDefault

isDefault?: undefined | false | true;

property password

password?: undefined | string;

property url

url: string;

property user

user?: undefined | string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServices

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServices

property etcd

etcd: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd;

property kubeApi

kubeApi: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi;

property kubeController

kubeController: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController;

property kubelet

kubelet: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet;

property kubeproxy

kubeproxy: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy;

property scheduler

scheduler: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcd

property backupConfig

backupConfig: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig;

property caCert

caCert: string;

property cert

cert: string;

property creation

creation: string;

property externalUrls

externalUrls?: string[];

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property gid

gid?: undefined | number;

property image

image: string;

property key

key: string;

property path

path: string;

property retention

retention: string;

property snapshot

snapshot: boolean;

property uid

uid?: undefined | number;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfig

property enabled

enabled?: undefined | false | true;

property intervalHours

intervalHours?: undefined | number;

property retention

retention?: undefined | number;

property s3BackupConfig

s3BackupConfig?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig;

property safeTimestamp

safeTimestamp?: undefined | false | true;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesEtcdBackupConfigS3BackupConfig

property accessKey

accessKey?: undefined | string;

property bucketName

bucketName: string;

property customCa

customCa?: undefined | string;

property endpoint

endpoint: string;

property folder

folder?: undefined | string;

property region

region?: undefined | string;

property secretKey

secretKey?: undefined | string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApi

property admissionConfiguration

admissionConfiguration?: undefined | {[key: string]: any};

property alwaysPullImages

alwaysPullImages?: undefined | false | true;

property auditLog

auditLog?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog;

property eventRateLimit

eventRateLimit?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

property podSecurityPolicy

podSecurityPolicy?: undefined | false | true;

property secretsEncryptionConfig

secretsEncryptionConfig?: outputs.GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig;

property serviceClusterIpRange

serviceClusterIpRange: string;

property serviceNodePortRange

serviceNodePortRange: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLog

property configuration

configuration: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration;

property enabled

enabled?: undefined | false | true;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiAuditLogConfiguration

property format

format?: undefined | string;

property maxAge

maxAge?: undefined | number;

property maxBackup

maxBackup?: undefined | number;

property maxSize

maxSize?: undefined | number;

property path

path?: undefined | string;

property policy

policy: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiEventRateLimit

property configuration

configuration?: undefined | {[key: string]: any};

property enabled

enabled?: undefined | false | true;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeApiSecretsEncryptionConfig

property customConfig

customConfig?: undefined | {[key: string]: any};

property enabled

enabled?: undefined | false | true;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeController

property clusterCidr

clusterCidr: string;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

property serviceClusterIpRange

serviceClusterIpRange: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubelet

property clusterDnsServer

clusterDnsServer: string;

property clusterDomain

clusterDomain: string;

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property failSwapOn

failSwapOn: boolean;

property generateServingCertificate

generateServingCertificate?: undefined | false | true;

property image

image: string;

property infraContainerImage

infraContainerImage: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesKubeproxy

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigServicesScheduler

property extraArgs

extraArgs: {[key: string]: any};

property extraBinds

extraBinds?: string[];

property extraEnvs

extraEnvs?: string[];

property image

image: string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategy

property drain

drain?: undefined | false | true;

property drainInput

drainInput: GetClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput;

property maxUnavailableControlplane

maxUnavailableControlplane?: undefined | string;

property maxUnavailableWorker

maxUnavailableWorker?: undefined | string;

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput

interface GetClusterTemplateTemplateRevisionClusterConfigRkeConfigUpgradeStrategyDrainInput

property deleteLocalData

deleteLocalData?: undefined | false | true;

property force

force?: undefined | false | true;

property gracePeriod

gracePeriod?: undefined | number;

property ignoreDaemonSets

ignoreDaemonSets?: undefined | false | true;

property timeout

timeout?: undefined | number;

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScan

property enabled

enabled?: undefined | false | true;

property scanConfig

scanConfig: GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig;

property scheduleConfig

scheduleConfig: GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig;

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfig

property cisScanConfig

cisScanConfig: GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig;

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScanConfigCisScanConfig

property debugMaster

debugMaster?: undefined | false | true;

property debugWorker

debugWorker?: undefined | false | true;

property overrideBenchmarkVersion

overrideBenchmarkVersion?: undefined | string;

property overrideSkips

overrideSkips?: string[];

property profile

profile?: undefined | string;

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig

interface GetClusterTemplateTemplateRevisionClusterConfigScheduledClusterScanScheduleConfig

property cronSchedule

cronSchedule: string;

property retention

retention: number;

interface GetClusterTemplateTemplateRevisionQuestion

interface GetClusterTemplateTemplateRevisionQuestion

property default

default: string;

property required

required?: undefined | false | true;

property type

type?: undefined | string;

property variable

variable: string;

interface GetEtcdBackupBackupConfig

interface GetEtcdBackupBackupConfig

property enabled

enabled?: undefined | false | true;

property intervalHours

intervalHours?: undefined | number;

property retention

retention?: undefined | number;

property s3BackupConfig

s3BackupConfig?: outputs.GetEtcdBackupBackupConfigS3BackupConfig;

property safeTimestamp

safeTimestamp?: undefined | false | true;

interface GetEtcdBackupBackupConfigS3BackupConfig

interface GetEtcdBackupBackupConfigS3BackupConfig

property accessKey

accessKey?: undefined | string;

property bucketName

bucketName: string;

property customCa

customCa?: undefined | string;

property endpoint

endpoint: string;

property folder

folder?: undefined | string;

property region

region?: undefined | string;

property secretKey

secretKey?: undefined | string;

interface GetMultiClusterAppAnswer

interface GetMultiClusterAppAnswer

property clusterId

clusterId: string;

property projectId

projectId: string;

property values

values: {[key: string]: any};

interface GetMultiClusterAppMember

interface GetMultiClusterAppMember

property accessType

accessType?: undefined | string;

property groupPrincipalId

groupPrincipalId?: undefined | string;

property userPrincipalId

userPrincipalId?: undefined | string;

interface GetMultiClusterAppTarget

interface GetMultiClusterAppTarget

property appId

appId: string;

property healthState

healthState: string;

property projectId

projectId: string;

property state

state: string;

interface GetMultiClusterAppUpgradeStrategy

interface GetMultiClusterAppUpgradeStrategy

property rollingUpdate

rollingUpdate?: outputs.GetMultiClusterAppUpgradeStrategyRollingUpdate;

interface GetMultiClusterAppUpgradeStrategyRollingUpdate

interface GetMultiClusterAppUpgradeStrategyRollingUpdate

property batchSize

batchSize?: undefined | number;

property interval

interval?: undefined | number;

interface GetNamespaceContainerResourceLimit

interface GetNamespaceContainerResourceLimit

property limitsCpu

limitsCpu?: undefined | string;

property limitsMemory

limitsMemory?: undefined | string;

property requestsCpu

requestsCpu?: undefined | string;

property requestsMemory

requestsMemory?: undefined | string;

interface GetNamespaceResourceQuota

interface GetNamespaceResourceQuota

property limit

limit: GetNamespaceResourceQuotaLimit;

interface GetNamespaceResourceQuotaLimit

interface GetNamespaceResourceQuotaLimit

property configMaps

configMaps?: undefined | string;

property limitsCpu

limitsCpu?: undefined | string;

property limitsMemory

limitsMemory?: undefined | string;

property persistentVolumeClaims

persistentVolumeClaims?: undefined | string;

property pods

pods?: undefined | string;

property replicationControllers

replicationControllers?: undefined | string;

property requestsCpu

requestsCpu?: undefined | string;

property requestsMemory

requestsMemory?: undefined | string;

property requestsStorage

requestsStorage?: undefined | string;

property secrets

secrets?: undefined | string;

property services

services?: undefined | string;

property servicesLoadBalancers

servicesLoadBalancers?: undefined | string;

property servicesNodePorts

servicesNodePorts?: undefined | string;

interface GetNodePoolNodeTaint

interface GetNodePoolNodeTaint

property effect

effect?: undefined | string;

property key

key: string;

property timeAdded

timeAdded: string;

property value

value: string;

interface GetNotifierPagerdutyConfig

interface GetNotifierPagerdutyConfig

property proxyUrl

proxyUrl?: undefined | string;

property serviceKey

serviceKey: string;

interface GetNotifierSlackConfig

interface GetNotifierSlackConfig

property defaultRecipient

defaultRecipient: string;

property proxyUrl

proxyUrl?: undefined | string;

property url

url: string;

interface GetNotifierSmtpConfig

interface GetNotifierSmtpConfig

property defaultRecipient

defaultRecipient: string;

property host

host: string;

property password

password?: undefined | string;

property port

port: number;

property sender

sender: string;

property tls

tls?: undefined | false | true;

property username

username?: undefined | string;

interface GetNotifierWebhookConfig

interface GetNotifierWebhookConfig

property proxyUrl

proxyUrl?: undefined | string;

property url

url: string;

interface GetNotifierWechatConfig

interface GetNotifierWechatConfig

property agent

agent: string;

property corp

corp: string;

property defaultRecipient

defaultRecipient: string;

property proxyUrl

proxyUrl?: undefined | string;

property recipientType

recipientType?: undefined | string;

property secret

secret: string;

interface GetPodSecurityPolicyTemplateAllowedCsiDriver

interface GetPodSecurityPolicyTemplateAllowedCsiDriver

property name

name: string;

The name of the PodSecurityPolicyTemplate (string)

interface GetPodSecurityPolicyTemplateAllowedFlexVolume

interface GetPodSecurityPolicyTemplateAllowedFlexVolume

property driver

driver: string;

interface GetPodSecurityPolicyTemplateAllowedHostPath

interface GetPodSecurityPolicyTemplateAllowedHostPath

property pathPrefix

pathPrefix: string;

property readOnly

readOnly?: undefined | false | true;

interface GetPodSecurityPolicyTemplateFsGroup

interface GetPodSecurityPolicyTemplateFsGroup

property ranges

ranges: GetPodSecurityPolicyTemplateFsGroupRange[];

property rule

rule?: undefined | string;

interface GetPodSecurityPolicyTemplateFsGroupRange

interface GetPodSecurityPolicyTemplateFsGroupRange

property max

max: number;

property min

min: number;

interface GetPodSecurityPolicyTemplateHostPort

interface GetPodSecurityPolicyTemplateHostPort

property max

max: number;

property min

min: number;

interface GetPodSecurityPolicyTemplateRunAsGroup

interface GetPodSecurityPolicyTemplateRunAsGroup

property ranges

ranges?: GetPodSecurityPolicyTemplateRunAsGroupRange[];

property rule

rule: string;

interface GetPodSecurityPolicyTemplateRunAsGroupRange

interface GetPodSecurityPolicyTemplateRunAsGroupRange

property max

max: number;

property min

min: number;

interface GetPodSecurityPolicyTemplateRunAsUser

interface GetPodSecurityPolicyTemplateRunAsUser

property ranges

ranges?: GetPodSecurityPolicyTemplateRunAsUserRange[];

property rule

rule: string;

interface GetPodSecurityPolicyTemplateRunAsUserRange

interface GetPodSecurityPolicyTemplateRunAsUserRange

property max

max: number;

property min

min: number;

interface GetPodSecurityPolicyTemplateRuntimeClass

interface GetPodSecurityPolicyTemplateRuntimeClass

property allowedRuntimeClassNames

allowedRuntimeClassNames: string[];

property defaultRuntimeClassName

defaultRuntimeClassName?: undefined | string;

interface GetPodSecurityPolicyTemplateSeLinux

interface GetPodSecurityPolicyTemplateSeLinux

property rule

rule: string;

property seLinuxOption

seLinuxOption?: outputs.GetPodSecurityPolicyTemplateSeLinuxSeLinuxOption;

interface GetPodSecurityPolicyTemplateSeLinuxSeLinuxOption

interface GetPodSecurityPolicyTemplateSeLinuxSeLinuxOption

property level

level?: undefined | string;

property role

role?: undefined | string;

property type

type?: undefined | string;

property user

user?: undefined | string;

interface GetPodSecurityPolicyTemplateSupplementalGroup

interface GetPodSecurityPolicyTemplateSupplementalGroup

property ranges

ranges: GetPodSecurityPolicyTemplateSupplementalGroupRange[];

property rule

rule?: undefined | string;

interface GetPodSecurityPolicyTemplateSupplementalGroupRange

interface GetPodSecurityPolicyTemplateSupplementalGroupRange

property max

max: number;

property min

min: number;

interface GetProjectAlertGroupRecipient

interface GetProjectAlertGroupRecipient

property defaultRecipient

defaultRecipient?: undefined | false | true;

property notifierId

notifierId: string;

property notifierType

notifierType: string;

property recipient

recipient: string;

interface GetProjectAlertRuleMetricRule

interface GetProjectAlertRuleMetricRule

property comparison

comparison?: undefined | string;

property description

description?: undefined | string;

property duration

duration: string;

property expression

expression: string;

property thresholdValue

thresholdValue: number;

interface GetProjectAlertRulePodRule

interface GetProjectAlertRulePodRule

property condition

condition?: undefined | string;

property podId

podId: string;

property restartIntervalSeconds

restartIntervalSeconds?: undefined | number;

property restartTimes

restartTimes?: undefined | number;

interface GetProjectAlertRuleWorkloadRule

interface GetProjectAlertRuleWorkloadRule

property availablePercentage

availablePercentage?: undefined | number;

property selector

selector?: undefined | {[key: string]: any};

property workloadId

workloadId?: undefined | string;

interface GetProjectContainerResourceLimit

interface GetProjectContainerResourceLimit

property limitsCpu

limitsCpu?: undefined | string;

property limitsMemory

limitsMemory?: undefined | string;

property requestsCpu

requestsCpu?: undefined | string;

property requestsMemory

requestsMemory?: undefined | string;

interface GetProjectLoggingCustomTargetConfig

interface GetProjectLoggingCustomTargetConfig

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property content

content: string;

interface GetProjectLoggingElasticsearchConfig

interface GetProjectLoggingElasticsearchConfig

property authPassword

authPassword?: undefined | string;

property authUsername

authUsername?: undefined | string;

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property clientKeyPass

clientKeyPass?: undefined | string;

property dateFormat

dateFormat?: undefined | string;

property endpoint

endpoint: string;

property indexPrefix

indexPrefix?: undefined | string;

property sslVerify

sslVerify: boolean;

property sslVersion

sslVersion?: undefined | string;

interface GetProjectLoggingFluentdConfig

interface GetProjectLoggingFluentdConfig

property certificate

certificate?: undefined | string;

property compress

compress?: undefined | false | true;

property enableTls

enableTls?: undefined | false | true;

property fluentServers

fluentServers: GetProjectLoggingFluentdConfigFluentServer[];

interface GetProjectLoggingFluentdConfigFluentServer

interface GetProjectLoggingFluentdConfigFluentServer

property endpoint

endpoint: string;

property hostname

hostname?: undefined | string;

property password

password?: undefined | string;

property sharedKey

sharedKey?: undefined | string;

property standby

standby?: undefined | false | true;

property username

username?: undefined | string;

property weight

weight?: undefined | number;

interface GetProjectLoggingKafkaConfig

interface GetProjectLoggingKafkaConfig

property brokerEndpoints

brokerEndpoints?: string[];

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property topic

topic: string;

property zookeeperEndpoint

zookeeperEndpoint?: undefined | string;

interface GetProjectLoggingSplunkConfig

interface GetProjectLoggingSplunkConfig

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property clientKeyPass

clientKeyPass?: undefined | string;

property endpoint

endpoint: string;

property index

index?: undefined | string;

property source

source?: undefined | string;

property sslVerify

sslVerify: boolean;

property token

token: string;

interface GetProjectLoggingSyslogConfig

interface GetProjectLoggingSyslogConfig

property certificate

certificate?: undefined | string;

property clientCert

clientCert?: undefined | string;

property clientKey

clientKey?: undefined | string;

property endpoint

endpoint: string;

property program

program?: undefined | string;

property protocol

protocol?: undefined | string;

property severity

severity?: undefined | string;

property sslVerify

sslVerify: boolean;

property token

token?: undefined | string;

interface GetProjectResourceQuota

interface GetProjectResourceQuota

property namespaceDefaultLimit

namespaceDefaultLimit: GetProjectResourceQuotaNamespaceDefaultLimit;

property projectLimit

projectLimit: GetProjectResourceQuotaProjectLimit;

interface GetProjectResourceQuotaNamespaceDefaultLimit

interface GetProjectResourceQuotaNamespaceDefaultLimit

property configMaps

configMaps?: undefined | string;

property limitsCpu

limitsCpu?: undefined | string;

property limitsMemory

limitsMemory?: undefined | string;

property persistentVolumeClaims

persistentVolumeClaims?: undefined | string;

property pods

pods?: undefined | string;

property replicationControllers

replicationControllers?: undefined | string;

property requestsCpu

requestsCpu?: undefined | string;

property requestsMemory

requestsMemory?: undefined | string;

property requestsStorage

requestsStorage?: undefined | string;

property secrets

secrets?: undefined | string;

property services

services?: undefined | string;

property servicesLoadBalancers

servicesLoadBalancers?: undefined | string;

property servicesNodePorts

servicesNodePorts?: undefined | string;

interface GetProjectResourceQuotaProjectLimit

interface GetProjectResourceQuotaProjectLimit

property configMaps

configMaps?: undefined | string;

property limitsCpu

limitsCpu?: undefined | string;

property limitsMemory

limitsMemory?: undefined | string;

property persistentVolumeClaims

persistentVolumeClaims?: undefined | string;

property pods

pods?: undefined | string;

property replicationControllers

replicationControllers?: undefined | string;

property requestsCpu

requestsCpu?: undefined | string;

property requestsMemory

requestsMemory?: undefined | string;

property requestsStorage

requestsStorage?: undefined | string;

property secrets

secrets?: undefined | string;

property services

services?: undefined | string;

property servicesLoadBalancers

servicesLoadBalancers?: undefined | string;

property servicesNodePorts

servicesNodePorts?: undefined | string;

interface GetRegistryRegistry

interface GetRegistryRegistry

property address

address: string;

property password

password?: undefined | string;

property username

username?: undefined | string;

interface GetRoleTempalteRule

interface GetRoleTempalteRule

property apiGroups

apiGroups?: string[];

property nonResourceUrls

nonResourceUrls?: string[];

property resourceNames

resourceNames?: string[];

property resources

resources?: string[];

property verbs

verbs?: string[];

interface GetRoleTemplateRule

interface GetRoleTemplateRule

property apiGroups

apiGroups?: string[];

property nonResourceUrls

nonResourceUrls?: string[];

property resourceNames

resourceNames?: string[];

property resources

resources?: string[];

property verbs

verbs?: string[];

interface MultiClusterAppAnswer

interface MultiClusterAppAnswer

property clusterId

clusterId: string;

Cluster ID for answer (string)

property projectId

projectId: string;

Project ID for target (string)

property values

values: {[key: string]: any};

Key/values for answer (map)

interface MultiClusterAppMember

interface MultiClusterAppMember

property accessType

accessType?: undefined | string;

Member access type. Valid values: ["member" | "owner" | "read-only"] (string)

property groupPrincipalId

groupPrincipalId?: undefined | string;

Member group principal id (string)

property userPrincipalId

userPrincipalId?: undefined | string;

Member user principal id (string)

interface MultiClusterAppTarget

interface MultiClusterAppTarget

property appId

appId: string;

App ID for target (string)

property healthState

healthState: string;

App health state for target (string)

property projectId

projectId: string;

Project ID for target (string)

property state

state: string;

App state for target (string)

interface MultiClusterAppUpgradeStrategy

interface MultiClusterAppUpgradeStrategy

property rollingUpdate

rollingUpdate?: outputs.MultiClusterAppUpgradeStrategyRollingUpdate;

Upgrade strategy rolling update (list MaxItems:1)

interface MultiClusterAppUpgradeStrategyRollingUpdate

interface MultiClusterAppUpgradeStrategyRollingUpdate

property batchSize

batchSize?: undefined | number;

Rolling update batch size. Default 1 (int)

property interval

interval?: undefined | number;

Rolling update interval. Default 1 (int)

interface NamespaceContainerResourceLimit

interface NamespaceContainerResourceLimit

property limitsCpu

limitsCpu?: undefined | string;

Limit for limits cpu in namespace (string)

property limitsMemory

limitsMemory?: undefined | string;

Limit for limits memory in namespace (string)

property requestsCpu

requestsCpu?: undefined | string;

Limit for requests cpu in namespace (string)

property requestsMemory

requestsMemory?: undefined | string;

Limit for requests memory in namespace (string)

interface NamespaceResourceQuota

interface NamespaceResourceQuota

property limit

limit: NamespaceResourceQuotaLimit;

Resource quota limit for namespace (list maxitems:1)

interface NamespaceResourceQuotaLimit

interface NamespaceResourceQuotaLimit

property configMaps

configMaps?: undefined | string;

Limit for config maps in namespace (string)

property limitsCpu

limitsCpu?: undefined | string;

Limit for limits cpu in namespace (string)

property limitsMemory

limitsMemory?: undefined | string;

Limit for limits memory in namespace (string)

property persistentVolumeClaims

persistentVolumeClaims?: undefined | string;

Limit for persistent volume claims in namespace (string)

property pods

pods?: undefined | string;

Limit for pods in namespace (string)

property replicationControllers

replicationControllers?: undefined | string;

Limit for replication controllers in namespace (string)

property requestsCpu

requestsCpu?: undefined | string;

Limit for requests cpu in namespace (string)

property requestsMemory

requestsMemory?: undefined | string;

Limit for requests memory in namespace (string)

property requestsStorage

requestsStorage?: undefined | string;

Limit for requests storage in namespace (string)

property secrets

secrets?: undefined | string;

Limit for secrets in namespace (string)

property services

services?: undefined | string;

property servicesLoadBalancers

servicesLoadBalancers?: undefined | string;

Limit for services load balancers in namespace (string)

property servicesNodePorts

servicesNodePorts?: undefined | string;

Limit for services node ports in namespace (string)

interface NodePoolNodeTaint

interface NodePoolNodeTaint

property effect

effect?: undefined | string;

Taint effect. Supported values : "NoExecute" | "NoSchedule" | "PreferNoSchedule" (string)

property key

key: string;

Taint key (string)

property timeAdded

timeAdded: string;

Taint time added (string)

property value

value: string;

Taint value (string)

interface NodeTemplateAmazonec2Config

interface NodeTemplateAmazonec2Config

property accessKey

accessKey?: undefined | string;

AWS access key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property ami

ami: string;

AWS machine image (string)

property blockDurationMinutes

blockDurationMinutes?: undefined | string;

AWS spot instance duration in minutes (60, 120, 180, 240, 300, or 360). Default 0 (string)

property deviceName

deviceName?: undefined | string;

AWS root device name. Default /dev/sda1 (string)

property endpoint

endpoint?: undefined | string;

Optional endpoint URL (hostname only or fully qualified URI) (string)

property iamInstanceProfile

iamInstanceProfile?: undefined | string;

AWS IAM Instance Profile (string)

property insecureTransport

insecureTransport?: undefined | false | true;

Disable SSL when sending requests (bool)

property instanceType

instanceType?: undefined | string;

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

property keypairName

keypairName?: undefined | string;

OpenStack keypair to use to SSH to the instance (string)

property monitoring

monitoring?: undefined | false | true;

Enable monitoring for droplet. Default false (bool)

property openPorts

openPorts?: string[];

Make the specified port number accessible from the Internet. (list)

property privateAddressOnly

privateAddressOnly?: undefined | false | true;

Only use a private IP address. Default false (bool)

property region

region: string;

OpenStack region name (string)

property requestSpotInstance

requestSpotInstance?: undefined | false | true;

Set this flag to request spot instance. Default false (bool)

property retries

retries?: undefined | string;

Set retry count for recoverable failures (use -1 to disable). Default 5 (string)

property rootSize

rootSize?: undefined | string;

AWS root disk size (in GB). Default 16 (string)

property secretKey

secretKey?: undefined | string;

AWS secret key. Required on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property securityGroupReadonly

securityGroupReadonly?: undefined | false | true;

Skip adding default rules to security groups (bool)

property securityGroups

securityGroups: string[];

AWS VPC security group. (list)

property sessionToken

sessionToken?: undefined | string;

AWS Session Token (string)

property spotPrice

spotPrice?: undefined | string;

AWS spot instance bid price (in dollar). Default 0.50 (string)

property sshKeypath

sshKeypath?: undefined | string;

SSH Key for Instance (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property subnetId

subnetId: string;

AWS VPC subnet id (string)

property tags

tags?: undefined | string;

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

property useEbsOptimizedInstance

useEbsOptimizedInstance?: undefined | false | true;

Create an EBS optimized instance. Default false (bool)

property usePrivateAddress

usePrivateAddress?: undefined | false | true;

Force the usage of private IP address. Default false (bool)

property userdata

userdata?: undefined | string;

Path to file with cloud-init user-data (string)

property volumeType

volumeType?: undefined | string;

Amazon EBS volume type. Default gp2 (string)

property vpcId

vpcId: string;

AWS VPC id. (string)

property zone

zone: string;

AWS zone for instance (i.e. a,b,c,d,e) (string)

interface NodeTemplateAzureConfig

interface NodeTemplateAzureConfig

property availabilitySet

availabilitySet?: undefined | string;

Azure Availability Set to place the virtual machine into. Default docker-machine (string)

property clientId

clientId?: undefined | string;

Azure Service Principal Account ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property clientSecret

clientSecret?: undefined | string;

Azure Service Principal Account password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property customData

customData?: undefined | string;

Path to file with custom-data (string)

property diskSize

diskSize?: undefined | string;

vSphere size of disk for docker VM (in MB). Default 20480 (string)

property dns

dns?: undefined | string;

A unique DNS label for the public IP adddress (string)

property dockerPort

dockerPort?: undefined | string;

Docker Port. Default 2376 (string)

property environment

environment?: undefined | string;

Azure environment (e.g. AzurePublicCloud, AzureChinaCloud). Default AzurePublicCloud (string) faultDomainCount - (Optional) Fault domain count to use for availability set. Default 3 (string)

property faultDomainCount

faultDomainCount?: undefined | string;

property image

image?: undefined | string;

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

property location

location?: undefined | string;

Azure region to create the virtual machine. Default westus (string)

property managedDisks

managedDisks?: undefined | false | true;

Configures VM and availability set for managed disks. Just for Rancher v2.3.x and above. Default false (bool)

property noPublicIp

noPublicIp?: undefined | false | true;

Do not create a public IP address for the machine. Default false (bool)

property openPorts

openPorts?: string[];

Make the specified port number accessible from the Internet. (list)

property privateIpAddress

privateIpAddress?: undefined | string;

Specify a static private IP address for the machine. (string)

property resourceGroup

resourceGroup?: undefined | string;

Azure Resource Group name (will be created if missing). Default docker-machine (string)

property size

size?: undefined | string;

Digital Ocean size. Default s-1vcpu-1gb (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property staticPublicIp

staticPublicIp?: undefined | false | true;

Assign a static public IP address to the machine. Default false (bool)

property storageType

storageType?: undefined | string;

Type of Storage Account to host the OS Disk for the machine. Default Standard_LRS (string)

property subnet

subnet?: undefined | string;

Azure Subnet Name to be used within the Virtual Network. Default docker-machine (string)

property subnetPrefix

subnetPrefix?: undefined | string;

Private CIDR block to be used for the new subnet, should comply RFC 1918. Default 192.168.0.0/16 (string)

property subscriptionId

subscriptionId?: undefined | string;

Azure Subscription ID. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property updateDomainCount

updateDomainCount?: undefined | string;

Update domain count to use for availability set. Default 5 (string)

property usePrivateIp

usePrivateIp?: undefined | false | true;

Use private IP address of the machine to connect. Default false (bool)

property vnet

vnet?: undefined | string;

Azure Virtual Network name to connect the virtual machine (in [resourcegroup:]name format). Default docker-machine-vnet (string)

interface NodeTemplateDigitaloceanConfig

interface NodeTemplateDigitaloceanConfig

property accessToken

accessToken?: undefined | string;

Digital Ocean access token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property backups

backups?: undefined | false | true;

Enable backups for droplet. Default false (bool)

property image

image?: undefined | string;

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

property ipv6

ipv6?: undefined | false | true;

Enable ipv6 for droplet. Default false (bool)

property monitoring

monitoring?: undefined | false | true;

Enable monitoring for droplet. Default false (bool)

property privateNetworking

privateNetworking?: undefined | false | true;

Enable private networking for droplet. Default false (bool)

property region

region?: undefined | string;

OpenStack region name (string)

property size

size?: undefined | string;

Digital Ocean size. Default s-1vcpu-1gb (string)

property sshKeyFingerprint

sshKeyFingerprint?: undefined | string;

SSH key fingerprint (string)

property sshKeyPath

sshKeyPath?: undefined | string;

SSH private key path (string)

property sshPort

sshPort?: undefined | string;

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property tags

tags?: undefined | string;

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

property userdata

userdata?: undefined | string;

Path to file with cloud-init user-data (string)

interface NodeTemplateLinodeConfig

interface NodeTemplateLinodeConfig

property authorizedUsers

authorizedUsers?: undefined | string;

Linode user accounts (seperated by commas) whose Linode SSH keys will be permitted root access to the created node. (string)

property createPrivateIp

createPrivateIp?: undefined | false | true;

Create private IP for the instance. Default false (bool)

property dockerPort

dockerPort?: undefined | string;

Docker Port. Default 2376 (string)

property image

image?: undefined | string;

Specifies the Linode Instance image which determines the OS distribution and base files. Default linode/ubuntu18.04 (string)

property instanceType

instanceType?: undefined | string;

Specifies the Linode Instance type which determines CPU, memory, disk size, etc. Default g6-standard-4 (string)

property label

label?: undefined | string;

Linode Instance Label. (string)

property region

region?: undefined | string;

OpenStack region name (string)

property rootPass

rootPass?: undefined | string;

Root Password (string)

property sshPort

sshPort?: undefined | string;

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property stackscript

stackscript?: undefined | string;

Specifies the Linode StackScript to use to create the instance. (string)

property stackscriptData

stackscriptData?: undefined | string;

A JSON string specifying data for the selected StackScript. (string)

property swapSize

swapSize?: undefined | string;

Linode Instance Swap Size (MB). Default 512 (string)

property tags

tags?: undefined | string;

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

property token

token?: undefined | string;

Linode API token. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property uaPrefix

uaPrefix?: undefined | string;

Prefix the User-Agent in Linode API calls with some ‘product/version’ (string)

interface NodeTemplateOpennebulaConfig

interface NodeTemplateOpennebulaConfig

property b2dSize

b2dSize?: undefined | string;

Size of the Volatile disk in MB - only for b2d (string)

property cpu

cpu?: undefined | string;

CPU value for the VM (string)

property devPrefix

devPrefix?: undefined | string;

Dev prefix to use for the images. E.g.: ‘vd’, ‘sd’, ‘hd’ (string)

property disableVnc

disableVnc?: undefined | false | true;

VNC is enabled by default. Disable it with this flag (bool)

property diskResize

diskResize?: undefined | string;

Size of the disk for the VM in MB (string)

property imageId

imageId?: undefined | string;

OpenStack image id to use for the instance. Conflicts with imageName (string)

property imageName

imageName?: undefined | string;

OpenStack image name to use for the instance. Conflicts with imageId (string)

property imageOwner

imageOwner?: undefined | string;

Owner of the image to use as the VM OS (string)

property memory

memory?: undefined | string;

Size of the memory for the VM in MB (string)

property networkId

networkId?: undefined | string;

Opennebula network ID to connect the machine to. Conflicts with networkName (string)

property networkName

networkName?: undefined | string;

Opennebula network to connect the machine to. Conflicts with networkId (string)

property networkOwner

networkOwner?: undefined | string;

Opennebula user ID of the Network to connect the machine to (string)

property password

password: string;

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property templateId

templateId?: undefined | string;

Opennebula template ID to use. Conflicts with templateName (string)

property templateName

templateName?: undefined | string;

Name of the Opennbula template to use. Conflicts with templateId (string)

property user

user: string;

Set the user for the XML-RPC API authentication (string)

property vcpu

vcpu?: undefined | string;

VCPUs for the VM (string)

property xmlRpcUrl

xmlRpcUrl: string;

Set the url for the Opennebula XML-RPC API (string)

interface NodeTemplateOpenstackConfig

interface NodeTemplateOpenstackConfig

property activeTimeout

activeTimeout?: undefined | string;

OpenStack active timeout Default 200 (string)

property authUrl

authUrl: string;

OpenStack authentication URL (string)

property availabilityZone

availabilityZone: string;

OpenStack availability zone (string)

property cacert

cacert?: undefined | string;

CA certificate bundle to verify against (string)

property configDrive

configDrive?: undefined | false | true;

Enables the OpenStack config drive for the instance. Default false (bool)

property domainId

domainId?: undefined | string;

OpenStack domain ID. Identity v3 only. Conflicts with domainName (string)

property domainName

domainName?: undefined | string;

OpenStack domain name. Identity v3 only. Conflicts with domainId (string)

property endpointType

endpointType?: undefined | string;

OpenStack endpoint type. adminURL, internalURL or publicURL (string)

property flavorId

flavorId?: undefined | string;

OpenStack flavor id to use for the instance. Conflicts with flavorName (string)

property flavorName

flavorName?: undefined | string;

OpenStack flavor name to use for the instance. Conflicts with flavorId (string)

property floatingIpPool

floatingIpPool?: undefined | string;

OpenStack floating IP pool to get an IP from to assign to the instance (string)

property imageId

imageId?: undefined | string;

OpenStack image id to use for the instance. Conflicts with imageName (string)

property imageName

imageName?: undefined | string;

OpenStack image name to use for the instance. Conflicts with imageId (string)

property insecure

insecure?: undefined | false | true;

Disable TLS credential checking. Default false (bool)

property ipVersion

ipVersion?: undefined | string;

OpenStack version of IP address assigned for the machine Default 4 (string)

property keypairName

keypairName?: undefined | string;

OpenStack keypair to use to SSH to the instance (string)

property netId

netId?: undefined | string;

OpenStack network id the machine will be connected on. Conflicts with netName (string)

property netName

netName?: undefined | string;

OpenStack network name the machine will be connected on. Conflicts with netId (string)

property novaNetwork

novaNetwork?: undefined | false | true;

Use the nova networking services instead of neutron (string)

property password

password?: undefined | string;

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property privateKeyFile

privateKeyFile?: undefined | string;

Private key content to use for SSH (string)

property region

region: string;

OpenStack region name (string)

property secGroups

secGroups?: undefined | string;

OpenStack comma separated security groups for the machine (string)

property sshPort

sshPort?: undefined | string;

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property tenantId

tenantId?: undefined | string;

OpenStack tenant id. Conflicts with tenantName (string)

property tenantName

tenantName?: undefined | string;

OpenStack tenant name. Conflicts with tenantId (string)

property userDataFile

userDataFile?: undefined | string;

File containing an openstack userdata script (string)

property username

username: string;

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

interface NodeTemplateVsphereConfig

interface NodeTemplateVsphereConfig

property boot2dockerUrl

boot2dockerUrl?: undefined | string;

vSphere URL for boot2docker iso image. Default https://releases.rancher.com/os/latest/rancheros-vmware.iso (string)

property cfgparams

cfgparams?: string[];

vSphere vm configuration parameters (used for guestinfo) (list)

property cloneFrom

cloneFrom?: undefined | string;

If you choose creation type clone a name of what you want to clone is required. From Rancher v2.3.3 (string)

property cloudConfig

cloudConfig?: undefined | string;

Filepath to a cloud-config yaml file to put into the ISO user-data. From Rancher v2.3.3 (string)

property cloudinit

cloudinit?: undefined | string;

vSphere cloud-init file or url to set in the guestinfo (string)

property contentLibrary

contentLibrary?: undefined | string;

If you choose to clone from a content library template specify the name of the library. From Rancher v2.3.3 (string)

property cpuCount

cpuCount?: undefined | string;

vSphere CPU number for docker VM. Default 2 (string)

property creationType

creationType?: undefined | string;

Creation type when creating a new virtual machine. Supported values: vm, template, library, legacy. Default legacy. From Rancher v2.3.3 (string)

property customAttributes

customAttributes?: string[];

vSphere custom attributes, format key/value e.g. 200=my custom value. From Rancher v2.3.3 (List)

property datacenter

datacenter?: undefined | string;

vSphere datacenter for docker VM (string)

property datastore

datastore?: undefined | string;

vSphere datastore for docker VM (string)

property datastoreCluster

datastoreCluster?: undefined | string;

vSphere datastore cluster for virtual machine. From Rancher v2.3.3 (string)

property diskSize

diskSize?: undefined | string;

vSphere size of disk for docker VM (in MB). Default 20480 (string)

property folder

folder?: undefined | string;

vSphere folder for the docker VM. This folder must already exist in the datacenter (string)

property hostsystem

hostsystem?: undefined | string;

vSphere compute resource where the docker VM will be instantiated. This can be omitted if using a cluster with DRS (string)

property memorySize

memorySize?: undefined | string;

vSphere size of memory for docker VM (in MB). Default 2048 (string)

property networks

networks?: string[];

vSphere network where the docker VM will be attached (list)

property password

password?: undefined | string;

vSphere password. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property pool

pool?: undefined | string;

vSphere resource pool for docker VM (string)

property sshPassword

sshPassword?: undefined | string;

If using a non-B2D image you can specify the ssh password. Default tcuser. From Rancher v2.3.3 (string)

property sshPort

sshPort?: undefined | string;

If using a non-B2D image you can specify the ssh port. Default 22. From Rancher v2.3.3 (string)

property sshUser

sshUser?: undefined | string;

If using a non-B2D image you can specify the ssh user. Default docker. From Rancher v2.3.3 (string)

property sshUserGroup

sshUserGroup?: undefined | string;

If using a non-B2D image the uploaded keys will need chown’ed. Default staff. From Rancher v2.3.3 (string)

property tags

tags?: string[];

vSphere tags id e.g. urn:xxx. From Rancher v2.3.3 (list)

property username

username?: undefined | string;

vSphere username. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property vappIpAllocationPolicy

vappIpAllocationPolicy?: undefined | string;

vSphere vApp IP allocation policy. Supported values are: dhcp, fixed, transient and fixedAllocated (string)

property vappIpProtocol

vappIpProtocol?: undefined | string;

vSphere vApp IP protocol for this deployment. Supported values are: IPv4 and IPv6 (string)

property vappProperties

vappProperties?: string[];

vSphere vApp properties (list)

property vappTransport

vappTransport?: undefined | string;

vSphere OVF environment transports to use for properties. Supported values are: iso and com.vmware.guestInfo (string)

property vcenter

vcenter?: undefined | string;

vSphere IP/hostname for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x (string)

property vcenterPort

vcenterPort?: undefined | string;

vSphere Port for vCenter. Mandatory on Rancher v2.0.x and v2.1.x. Use rancher2..CloudCredential from Rancher v2.2.x. Default 443 (string)

interface NotifierPagerdutyConfig

interface NotifierPagerdutyConfig

property proxyUrl

proxyUrl?: undefined | string;

Wechat proxy url (string)

property serviceKey

serviceKey: string;

Pagerduty service key (string)

interface NotifierSlackConfig

interface NotifierSlackConfig

property defaultRecipient

defaultRecipient: string;

Wechat default recipient (string)

property proxyUrl

proxyUrl?: undefined | string;

Wechat proxy url (string)

property url

url: string;

Webhook url (string)

interface NotifierSmtpConfig

interface NotifierSmtpConfig

property defaultRecipient

defaultRecipient: string;

Wechat default recipient (string)

property host

host: string;

SMTP host (string)

property password

password?: undefined | string;

SMTP password (string)

property port

port: number;

SMTP port (int)

property sender

sender: string;

SMTP sender (string)

property tls

tls?: undefined | false | true;

SMTP tls. Default true (bool)

property username

username?: undefined | string;

SMTP username (string)

interface NotifierWebhookConfig

interface NotifierWebhookConfig

property proxyUrl

proxyUrl?: undefined | string;

Wechat proxy url (string)

property url

url: string;

Webhook url (string)

interface NotifierWechatConfig

interface NotifierWechatConfig

property agent

agent: string;

Wechat agent ID (string)

property corp

corp: string;

Wechat corporation ID (string)

property defaultRecipient

defaultRecipient: string;

Wechat default recipient (string)

property proxyUrl

proxyUrl?: undefined | string;

Wechat proxy url (string)

property recipientType

recipientType?: undefined | string;

Wechat recipient type. Allowed values: party | tag | user (string)

property secret

secret: string;

Wechat agent ID (string)

interface PodSecurityPolicyTemplateAllowedCsiDriver

interface PodSecurityPolicyTemplateAllowedCsiDriver

property name

name: string;

The name of the PodSecurityPolicyTemplate (string)

interface PodSecurityPolicyTemplateAllowedFlexVolume

interface PodSecurityPolicyTemplateAllowedFlexVolume

property driver

driver: string;

interface PodSecurityPolicyTemplateAllowedHostPath

interface PodSecurityPolicyTemplateAllowedHostPath

property pathPrefix

pathPrefix: string;

(string)

property readOnly

readOnly?: undefined | false | true;

(string)

interface PodSecurityPolicyTemplateFsGroup

interface PodSecurityPolicyTemplateFsGroup

property ranges

ranges: PodSecurityPolicyTemplateFsGroupRange[];

(list)

property rule

rule?: undefined | string;

(string)

interface PodSecurityPolicyTemplateFsGroupRange

interface PodSecurityPolicyTemplateFsGroupRange

property max

max: number;

(int)

property min

min: number;

(int)

interface PodSecurityPolicyTemplateHostPort

interface PodSecurityPolicyTemplateHostPort

property max

max: number;

(int)

property min

min: number;

(int)

interface PodSecurityPolicyTemplateRunAsGroup

interface PodSecurityPolicyTemplateRunAsGroup

property ranges

ranges?: PodSecurityPolicyTemplateRunAsGroupRange[];

(list)

property rule

rule: string;

(string)

interface PodSecurityPolicyTemplateRunAsGroupRange

interface PodSecurityPolicyTemplateRunAsGroupRange

property max

max: number;

(int)

property min

min: number;

(int)

interface PodSecurityPolicyTemplateRunAsUser

interface PodSecurityPolicyTemplateRunAsUser

property ranges

ranges?: PodSecurityPolicyTemplateRunAsUserRange[];

(list)

property rule

rule: string;

(string)

interface PodSecurityPolicyTemplateRunAsUserRange

interface PodSecurityPolicyTemplateRunAsUserRange

property max

max: number;

(int)

property min

min: number;

(int)

interface PodSecurityPolicyTemplateRuntimeClass

interface PodSecurityPolicyTemplateRuntimeClass

property allowedRuntimeClassNames

allowedRuntimeClassNames: string[];

(list)

property defaultRuntimeClassName

defaultRuntimeClassName?: undefined | string;

(string)

interface PodSecurityPolicyTemplateSeLinux

interface PodSecurityPolicyTemplateSeLinux

property rule

rule: string;

(string)

property seLinuxOption

seLinuxOption?: outputs.PodSecurityPolicyTemplateSeLinuxSeLinuxOption;

(list maxitems:1)

interface PodSecurityPolicyTemplateSeLinuxSeLinuxOption

interface PodSecurityPolicyTemplateSeLinuxSeLinuxOption

property level

level?: undefined | string;

(string)

property role

role?: undefined | string;

(string)

property type

type?: undefined | string;

(string)

property user

user?: undefined | string;

(string)

interface PodSecurityPolicyTemplateSupplementalGroup

interface PodSecurityPolicyTemplateSupplementalGroup

property ranges

ranges: PodSecurityPolicyTemplateSupplementalGroupRange[];

(list)

property rule

rule?: undefined | string;

(string)

interface PodSecurityPolicyTemplateSupplementalGroupRange

interface PodSecurityPolicyTemplateSupplementalGroupRange

property max

max: number;

(int)

property min

min: number;

(int)

interface ProjectAlertGroupRecipient

interface ProjectAlertGroupRecipient

property defaultRecipient

defaultRecipient?: undefined | false | true;

property notifierId

notifierId: string;

Recipient notifier ID (string)

property notifierType

notifierType: string;

Recipient notifier ID. Supported values : "pagerduty" | "slack" | "email" | "webhook" | "wechat" (string)

property recipient

recipient: string;

Recipient (string)

interface ProjectAlertRuleMetricRule

interface ProjectAlertRuleMetricRule

property comparison

comparison?: undefined | string;

Metric rule comparison. Supported values : "equal" | "greater-or-equal" | "greater-than" | "less-or-equal" | "less-than" | "not-equal" | "has-value". Default: equal (string)

property description

description?: undefined | string;

Metric rule description (string)

property duration

duration: string;

Metric rule duration (string)

property expression

expression: string;

Metric rule expression (string)

property thresholdValue

thresholdValue: number;

Metric rule threshold value (float64)

interface ProjectAlertRulePodRule

interface ProjectAlertRulePodRule

property condition

condition?: undefined | string;

Pod rule condition. Supported values : "notrunning" | "notscheduled" | "restarts". Default: notrunning (string)

property podId

podId: string;

Pod ID (string)

property restartIntervalSeconds

restartIntervalSeconds?: undefined | number;

Pod rule restart interval seconds. Default: 300 (int)

property restartTimes

restartTimes?: undefined | number;

Pod rule restart times. Default: 3 (int)

interface ProjectAlertRuleWorkloadRule

interface ProjectAlertRuleWorkloadRule

property availablePercentage

availablePercentage?: undefined | number;

Workload rule available percentage. Default: 70 (int)

property selector

selector?: undefined | {[key: string]: any};

Workload rule selector (map)

property workloadId

workloadId?: undefined | string;

Workload ID (string)

interface ProjectContainerResourceLimit

interface ProjectContainerResourceLimit

property limitsCpu

limitsCpu?: undefined | string;

Limit for limits cpu in project (string)

property limitsMemory

limitsMemory?: undefined | string;

Limit for limits memory in project (string)

property requestsCpu

requestsCpu?: undefined | string;

Limit for requests cpu in project (string)

property requestsMemory

requestsMemory?: undefined | string;

Limit for requests memory in project (string)

interface ProjectLoggingCustomTargetConfig

interface ProjectLoggingCustomTargetConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property content

content: string;

Custom target config content (string)

interface ProjectLoggingElasticsearchConfig

interface ProjectLoggingElasticsearchConfig

property authPassword

authPassword?: undefined | string;

User password for the elascticsearch service (string)

property authUsername

authUsername?: undefined | string;

Username for the elascticsearch service (string)

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property clientKeyPass

clientKeyPass?: undefined | string;

SSL client key password for the splunk service (string)

property dateFormat

dateFormat?: undefined | string;

Date format for the elascticsearch logs. Default: YYYY-MM-DD (string)

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property indexPrefix

indexPrefix?: undefined | string;

Index prefix for the elascticsearch logs. Default: local (string)

property sslVerify

sslVerify: boolean;

SSL verify for the syslog service (bool)

property sslVersion

sslVersion?: undefined | string;

SSL version for the elascticsearch service (string)

interface ProjectLoggingFluentdConfig

interface ProjectLoggingFluentdConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property compress

compress?: undefined | false | true;

Compress data for the fluentd service (bool)

property enableTls

enableTls?: undefined | false | true;

Enable TLS for the fluentd service (bool)

property fluentServers

fluentServers: ProjectLoggingFluentdConfigFluentServer[];

Servers for the fluentd service (list)

interface ProjectLoggingFluentdConfigFluentServer

interface ProjectLoggingFluentdConfigFluentServer

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property hostname

hostname?: undefined | string;

Hostname of the fluentd service (string)

property password

password?: undefined | string;

User password of the fluentd service (string)

property sharedKey

sharedKey?: undefined | string;

Shared key of the fluentd service (string)

property standby

standby?: undefined | false | true;

Standby server of the fluentd service (bool)

property username

username?: undefined | string;

Username of the fluentd service (string)

property weight

weight?: undefined | number;

Weight of the fluentd server (int)

interface ProjectLoggingKafkaConfig

interface ProjectLoggingKafkaConfig

property brokerEndpoints

brokerEndpoints?: string[];

Kafka endpoints for kafka service. Conflicts with zookeeperEndpoint (list)

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property topic

topic: string;

Topic to publish on the kafka service (string)

property zookeeperEndpoint

zookeeperEndpoint?: undefined | string;

Zookeeper endpoint for kafka service. Conflicts with brokerEndpoints (string)

interface ProjectLoggingSplunkConfig

interface ProjectLoggingSplunkConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property clientKeyPass

clientKeyPass?: undefined | string;

SSL client key password for the splunk service (string)

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property index

index?: undefined | string;

Index prefix for the splunk logs (string)

property source

source?: undefined | string;

Date format for the splunk logs (string)

property sslVerify

sslVerify: boolean;

SSL verify for the syslog service (bool)

property token

token: string;

Token for the syslog service (string)

interface ProjectLoggingSyslogConfig

interface ProjectLoggingSyslogConfig

property certificate

certificate?: undefined | string;

SSL certificate for the syslog service (string)

property clientCert

clientCert?: undefined | string;

SSL client certificate for the syslog service (string)

property clientKey

clientKey?: undefined | string;

SSL client key for the syslog service (string)

property endpoint

endpoint: string;

Endpoint of the syslog service (string)

property program

program?: undefined | string;

Program for the syslog service (string)

property protocol

protocol?: undefined | string;

Protocol for the syslog service. tcp and udp are supported. Default: udp (string)

property severity

severity?: undefined | string;

Date format for the syslog logs. emergency, alert, critical, error, warning, notice, info and debug are supported. Default: notice (string)

property sslVerify

sslVerify: boolean;

SSL verify for the syslog service (bool)

property token

token?: undefined | string;

Token for the syslog service (string)

interface ProjectProjectMonitoringInput

interface ProjectProjectMonitoringInput

property answers

answers?: undefined | {[key: string]: any};

Key/value answers for monitor input (map)

property version

version?: undefined | string;

rancher-monitoring chart version (string)

interface ProjectResourceQuota

interface ProjectResourceQuota

property namespaceDefaultLimit

namespaceDefaultLimit: ProjectResourceQuotaNamespaceDefaultLimit;

Default resource quota limit for namespaces in project (list maxitems:1)

property projectLimit

projectLimit: ProjectResourceQuotaProjectLimit;

Resource quota limit for project (list maxitems:1)

interface ProjectResourceQuotaNamespaceDefaultLimit

interface ProjectResourceQuotaNamespaceDefaultLimit

property configMaps

configMaps?: undefined | string;

Limit for config maps in project (string)

property limitsCpu

limitsCpu?: undefined | string;

Limit for limits cpu in project (string)

property limitsMemory

limitsMemory?: undefined | string;

Limit for limits memory in project (string)

property persistentVolumeClaims

persistentVolumeClaims?: undefined | string;

Limit for persistent volume claims in project (string)

property pods

pods?: undefined | string;

Limit for pods in project (string)

property replicationControllers

replicationControllers?: undefined | string;

Limit for replication controllers in project (string)

property requestsCpu

requestsCpu?: undefined | string;

Limit for requests cpu in project (string)

property requestsMemory

requestsMemory?: undefined | string;

Limit for requests memory in project (string)

property requestsStorage

requestsStorage?: undefined | string;

Limit for requests storage in project (string)

property secrets

secrets?: undefined | string;

Limit for secrets in project (string)

property services

services?: undefined | string;

property servicesLoadBalancers

servicesLoadBalancers?: undefined | string;

Limit for services load balancers in project (string)

property servicesNodePorts

servicesNodePorts?: undefined | string;

Limit for services node ports in project (string)

interface ProjectResourceQuotaProjectLimit

interface ProjectResourceQuotaProjectLimit

property configMaps

configMaps?: undefined | string;

Limit for config maps in project (string)

property limitsCpu

limitsCpu?: undefined | string;

Limit for limits cpu in project (string)

property limitsMemory

limitsMemory?: undefined | string;

Limit for limits memory in project (string)

property persistentVolumeClaims

persistentVolumeClaims?: undefined | string;

Limit for persistent volume claims in project (string)

property pods

pods?: undefined | string;

Limit for pods in project (string)

property replicationControllers

replicationControllers?: undefined | string;

Limit for replication controllers in project (string)

property requestsCpu

requestsCpu?: undefined | string;

Limit for requests cpu in project (string)

property requestsMemory

requestsMemory?: undefined | string;

Limit for requests memory in project (string)

property requestsStorage

requestsStorage?: undefined | string;

Limit for requests storage in project (string)

property secrets

secrets?: undefined | string;

Limit for secrets in project (string)

property services

services?: undefined | string;

property servicesLoadBalancers

servicesLoadBalancers?: undefined | string;

Limit for services load balancers in project (string)

property servicesNodePorts

servicesNodePorts?: undefined | string;

Limit for services node ports in project (string)

interface RegistryRegistry

interface RegistryRegistry

property address

address: string;

Address for registry.

property password

password?: undefined | string;

Password for the registry (string)

property username

username?: undefined | string;

Username for the registry (string)

interface RoleTempalteRule

interface RoleTempalteRule

property apiGroups

apiGroups?: string[];

Policy rule api groups (list)

property nonResourceUrls

nonResourceUrls?: string[];

Policy rule non resource urls (list)

property resourceNames

resourceNames?: string[];

Policy rule resource names (list)

property resources

resources?: string[];

Policy rule resources (list)

property verbs

verbs?: string[];

Policy rule verbs. create, delete, get, list, patch, update, watch and * values are supported (list)