schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
cluster.json
maximumLoadBalancerRuleCount
Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148
{"type": "integer"}
cluster.json
loadBalancerSku
Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`
{"type": "string"}
cluster.json
excludeMasterFromStandardLB
Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true` If want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes
{"type": "boolean"}
cluster.json
address
Address of Bastion Host
{"type": "string"}
cluster.json
port
SSH Port of Bastion Host
{"oneOf": [{"type": "string"}, {"type": "number"}]}
cluster.json
user
ssh User to Bastion Host
{"type": "string"}
cluster.json
sshAgentAuth
SSH Agent Auth enable
{"type": "boolean"}
cluster.json
sshKey
SSH Private Key
{"type": "string"}
cluster.json
sshKeyPath
SSH Private Key Path
{"type": "string"}
cluster.json
sshCert
SSH Certificate
{"type": "string"}
cluster.json
sshCertPath
SSH Certificate Path
{"type": "string"}
cluster.json
ignoreProxyEnvVars
Ignore proxy environment variables
{"type": "boolean"}
cluster.json
bs-version
overrides autodetection. v1 or v2. Defaults to auto
{"type": "string"}
cluster.json
trust-device-path
See Issue #33128
{"type": "boolean"}
cluster.json
cloudProvider
Cloud provider type used with calico
{"type": "string"}
cluster.json
name
Name of the Cloud Provider
{"type": "string"}
cluster.json
awsCloudProvider
AWSCloudProvider
{}
cluster.json
azureCloudProvider
AzureCloudProvider
{}
cluster.json
openstackCloudProvider
OpenstackCloudProvider
{}
cluster.json
vsphereCloudProvider
VsphereCloudProvider
{}
cluster.json
customCloudProvider
CustomCloudProvider is a multiline string that represent a custom cloud config file
{"type": "string"}
cluster.json
provider
DNS provider
{"type": "string"}
cluster.json
options
DNS config options
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
upstreamnameservers
Upstream nameservers
{"items": {"type": "string"}, "type": "array"}
cluster.json
reversecidrs
ReverseCIDRs
{"items": {"type": "string"}, "type": "array"}
cluster.json
stubdomains
Stubdomains
{"patternProperties": {".*": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
cluster.json
nodeSelector
NodeSelector key pair
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
nodelocal
Nodelocal DNS
{}
cluster.json
updateStrategy
Update strategy
{}
cluster.json
linearAutoscalerParams
Autoscaler fields to determine number of dns replicas
{}
cluster.json
tolerations
Tolerations for Deployments
{"items": {}, "type": "array"}
cluster.json
externalUrls
List of etcd urls
{"items": {"type": "string"}, "type": "array"}
cluster.json
caCert
External CA certificate
{"type": "string"}
cluster.json
cert
External Client certificate
{"type": "string"}
cluster.json
key
External Client key
{"type": "string"}
cluster.json
path
External etcd prefix
{"type": "string"}
cluster.json
uid
UID to run etcd container as
{"type": "integer"}
cluster.json
gid
GID to run etcd container as
{"type": "integer"}
cluster.json
snapshot
Etcd Recurring snapshot Service, used by rke only
{"type": "boolean"}
cluster.json
retention
Etcd snapshot Retention period
{"type": "string"}
cluster.json
creation
Etcd snapshot Creation period
{"type": "string"}
cluster.json
backupConfig
Backup backend for etcd snapshots
{}
cluster.json
iface
Alternate cloud interface for flannel
{"type": "string"}
cluster.json
zone
TODO: Is there any use for this? We can get it from the instance metadata service Maybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful
{"type": "string"}
cluster.json
vpc
The AWS VPC flag enables the possibility to run the master components on a different aws account, on a different cloud provider or on-premises. If the flag is set also the KubernetesClusterTag must be provided
{"type": "string"}
cluster.json
subnet-id
SubnetID enables using a specific subnet to use for ELB's
{"type": "string"}
cluster.json
routetable-id
RouteTableID enables using a specific RouteTable
{"type": "string"}
cluster.json
role-arn
RoleARN is the IAM role to assume when interaction with AWS APIs.
{"type": "string"}
cluster.json
kubernetes-cluster-tag
KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources
{"type": "string"}
cluster.json
kubernetes-cluster-id
KubernetesClusterID is the cluster id we'll use to identify our cluster resources
{"type": "string"}
cluster.json
disable-security-group-ingress
The aws provider creates an inbound rule per load balancer on the node security group. However, this can run into the AWS security group rule limit of 50 if many LoadBalancers are created. This flag disables the automatic ingress creation. It requires that the user has setup a rule that allows inbound traffic on kubelet ports from the local VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000.
{"type": "boolean"}
cluster.json
elb-security-group
AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB can cause the max number of security groups to be reached. If this is set instead of creating a new Security group for each ELB this security group will be used instead.
{"type": "string"}
cluster.json
disable-strict-zone-check
During the instantiation of an new AWS cloud provider, the detected region is validated against a known set of regions. In a non-standard, AWS like environment (e.g. Eucalyptus), this check may be undesirable. Setting this to true will disable the check and provide a warning that the check was skipped. Please note that this is an experimental feature and work-in-progress for the moment. If you find yourself in an non-AWS cloud and open an issue, please indicate that in the issue body.
{"type": "boolean"}
cluster.json
provider
Ingress controller type used by kubernetes
{"type": "string"}
cluster.json
options
These options are NOT for configuring Ingress's addon template. They are used for its ConfigMap options specifically.
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
nodeSelector
NodeSelector key pair
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
extraArgs
Ingress controller extra arguments
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
dnsPolicy
DNS Policy
{"type": "string"}
cluster.json
extraEnvs
Extra Env vars
{"items": {}, "type": "array"}
cluster.json
extraVolumes
Extra volumes
{"items": {}, "type": "array"}
cluster.json
extraVolumeMounts
Extra volume mounts
{"items": {}, "type": "array"}
cluster.json
updateStrategy
nginx daemonset upgrade strategy
{}
cluster.json
httpPort
Http port for ingress controller daemonset
{"oneOf": [{"type": "string"}, {"type": "number"}]}
cluster.json
httpsPort
Https port for ingress controller daemonset
{"oneOf": [{"type": "string"}, {"type": "number"}]}
cluster.json
networkMode
NetworkMode selector for ingress controller pods. Default is HostNetwork
{"type": "string"}
cluster.json
tolerations
Tolerations for Deployments
{"items": {}, "type": "array"}
cluster.json
defaultBackend
Enable or disable nginx default-http-backend
{"type": "boolean"}
cluster.json
defaultHttpBackendPriorityClassName
Priority class name for Nginx-Ingress's "default-http-backend" deployment
{"type": "string"}
cluster.json
nginxIngressControllerPriorityClassName
Priority class name for Nginx-Ingress's "nginx-ingress-controller" daemonset
{"type": "string"}
cluster.json
serviceClusterIpRange
Virtual IP range that will be used by Kubernetes services
{"type": "string"}
cluster.json
serviceNodePortRange
Port range for services defined with NodePort type
{"type": "string"}
cluster.json
podSecurityPolicy
Enabled/Disable PodSecurityPolicy
{"type": "boolean"}
cluster.json
alwaysPullImages
Enable/Disable AlwaysPullImages admissions plugin
{"type": "boolean"}
cluster.json
secretsEncryptionConfig
Secrets encryption provider config
{}
cluster.json
auditLog
Audit Log Configuration
{}
cluster.json
admissionConfiguration
AdmissionConfiguration
{}
cluster.json
eventRateLimit
Event Rate Limit configuration
{}
cluster.json
clusterCidr
CIDR Range for Pods in cluster
{"type": "string"}
cluster.json
serviceClusterIpRange
Virtual IP range that will be used by Kubernetes services
{"type": "string"}
cluster.json
clusterDomain
Domain of the cluster (default: "cluster.local")
{"type": "string"}
cluster.json
infraContainerImage
The image whose network/ipc namespaces containers in each pod will use
{"type": "string"}
cluster.json
clusterDnsServer
Cluster DNS service ip
{"type": "string"}
cluster.json
failSwapOn
Fail if swap is enabled
{"type": "boolean"}
cluster.json
generateServingCertificate
Generate per node kubelet serving certificates created using kube-ca
{"type": "boolean"}
cluster.json
lb-version
overrides autodetection. Only support v2.
{"type": "string"}
cluster.json
use-octavia
uses Octavia V2 service catalog endpoint
{"type": "boolean"}
cluster.json
subnet-id
overrides autodetection.
{"type": "string"}
cluster.json
floating-network-id
If specified, will create floating ip for loadbalancer, or do not create floating ip.
{"type": "string"}
cluster.json
lb-method
default to ROUND_ROBIN.
{"type": "string"}
cluster.json
provider
Monitoring server provider
{"type": "string"}
cluster.json
options
These options are NOT for configuring the Metrics-Server's addon template. They are used to pass command args to the metric-server's deployment containers specifically.
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
nodeSelector
NodeSelector key pair
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
updateStrategy
Update strategy
{}
cluster.json
replicas
Number of monitoring addon pods
{"type": "integer"}
cluster.json
tolerations
Tolerations for Deployments
{"items": {}, "type": "array"}
cluster.json
metricsServerPriorityClassName
Priority class name for Metrics-Server's "metrics-server" deployment
{"type": "string"}
cluster.json
plugin
Network Plugin That will be used in kubernetes cluster
{"type": "string"}
cluster.json
options
Plugin options to configure network properties
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.json
mtu
Set MTU for CNI provider
{"type": "integer"}
cluster.json
calicoNetworkProvider
CalicoNetworkProvider
{}