schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
cluster.yml.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.yml.json
address
Address of Bastion Host
{"type": "string"}
cluster.yml.json
port
SSH Port of Bastion Host
{"oneOf": [{"type": "string"}, {"type": "number"}]}
cluster.yml.json
user
ssh User to Bastion Host
{"type": "string"}
cluster.yml.json
ssh_agent_auth
SSH Agent Auth enable
{"type": "boolean"}
cluster.yml.json
ssh_key
SSH Private Key
{"type": "string"}
cluster.yml.json
ssh_key_path
SSH Private Key Path
{"type": "string"}
cluster.yml.json
ssh_cert
SSH Certificate
{"type": "string"}
cluster.yml.json
ssh_cert_path
SSH Certificate Path
{"type": "string"}
cluster.yml.json
ignore_proxy_env_vars
Ignore proxy environment variables
{"type": "boolean"}
cluster.yml.json
bs-version
overrides autodetection. v1 or v2. Defaults to auto
{"type": "string"}
cluster.yml.json
trust-device-path
See Issue #33128
{"type": "boolean"}
cluster.yml.json
CloudProvider
Cloud provider type used with calico
{"type": "string"}
cluster.yml.json
name
Name of the Cloud Provider
{"type": "string"}
cluster.yml.json
awsCloudProvider
AWSCloudProvider
{}
cluster.yml.json
azureCloudProvider
AzureCloudProvider
{}
cluster.yml.json
openstackCloudProvider
OpenstackCloudProvider
{}
cluster.yml.json
vsphereCloudProvider
VsphereCloudProvider
{}
cluster.yml.json
customCloudProvider
CustomCloudProvider is a multiline string that represent a custom cloud config file
{"type": "string"}
cluster.yml.json
provider
DNS provider
{"type": "string"}
cluster.yml.json
options
DNS config options
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
upstreamnameservers
Upstream nameservers
{"items": {"type": "string"}, "type": "array"}
cluster.yml.json
reversecidrs
ReverseCIDRs
{"items": {"type": "string"}, "type": "array"}
cluster.yml.json
stubdomains
Stubdomains
{"patternProperties": {".*": {"items": {"type": "string"}, "type": "array"}}, "type": "object"}
cluster.yml.json
node_selector
NodeSelector key pair
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
nodelocal
Nodelocal DNS
{}
cluster.yml.json
update_strategy
Update strategy
{}
cluster.yml.json
linear_autoscaler_params
Autoscaler fields to determine number of dns replicas
{}
cluster.yml.json
tolerations
Tolerations for Deployments
{"items": {}, "type": "array"}
cluster.yml.json
external_urls
List of etcd urls
{"items": {"type": "string"}, "type": "array"}
cluster.yml.json
ca_cert
External CA certificate
{"type": "string"}
cluster.yml.json
cert
External Client certificate
{"type": "string"}
cluster.yml.json
key
External Client key
{"type": "string"}
cluster.yml.json
path
External etcd prefix
{"type": "string"}
cluster.yml.json
uid
UID to run etcd container as
{"type": "integer"}
cluster.yml.json
gid
GID to run etcd container as
{"type": "integer"}
cluster.yml.json
snapshot
Etcd Recurring snapshot Service, used by rke only
{"type": "boolean"}
cluster.yml.json
retention
Etcd snapshot Retention period
{"type": "string"}
cluster.yml.json
creation
Etcd snapshot Creation period
{"type": "string"}
cluster.yml.json
backup_config
Backup backend for etcd snapshots
{}
cluster.yml.json
Iface
Alternate cloud interface for flannel
{"type": "string"}
cluster.yml.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.yml.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.yml.json
subnet-id
SubnetID enables using a specific subnet to use for ELB's
{"type": "string"}
cluster.yml.json
routetable-id
RouteTableID enables using a specific RouteTable
{"type": "string"}
cluster.yml.json
role-arn
RoleARN is the IAM role to assume when interaction with AWS APIs.
{"type": "string"}
cluster.yml.json
kubernetes-cluster-tag
KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources
{"type": "string"}
cluster.yml.json
kubernetes-cluster-id
KubernetesClusterID is the cluster id we'll use to identify our cluster resources
{"type": "string"}
cluster.yml.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.yml.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.yml.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.yml.json
provider
Ingress controller type used by kubernetes
{"type": "string"}
cluster.yml.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.yml.json
node_selector
NodeSelector key pair
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
extra_args
Ingress controller extra arguments
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
dns_policy
DNS Policy
{"type": "string"}
cluster.yml.json
extra_envs
Extra Env vars
{"items": {}, "type": "array"}
cluster.yml.json
extra_volumes
Extra volumes
{"items": {}, "type": "array"}
cluster.yml.json
extra_volume_mounts
Extra volume mounts
{"items": {}, "type": "array"}
cluster.yml.json
update_strategy
nginx daemonset upgrade strategy
{}
cluster.yml.json
http_port
Http port for ingress controller daemonset
{"oneOf": [{"type": "string"}, {"type": "number"}]}
cluster.yml.json
https_port
Https port for ingress controller daemonset
{"oneOf": [{"type": "string"}, {"type": "number"}]}
cluster.yml.json
network_mode
NetworkMode selector for ingress controller pods. Default is HostNetwork
{"type": "string"}
cluster.yml.json
tolerations
Tolerations for Deployments
{"items": {}, "type": "array"}
cluster.yml.json
default_backend
Enable or disable nginx default-http-backend
{"type": "boolean"}
cluster.yml.json
default_http_backend_priority_class_name
Priority class name for Nginx-Ingress's "default-http-backend" deployment
{"type": "string"}
cluster.yml.json
nginx_ingress_controller_priority_class_name
Priority class name for Nginx-Ingress's "nginx-ingress-controller" daemonset
{"type": "string"}
cluster.yml.json
service_cluster_ip_range
Virtual IP range that will be used by Kubernetes services
{"type": "string"}
cluster.yml.json
service_node_port_range
Port range for services defined with NodePort type
{"type": "string"}
cluster.yml.json
pod_security_policy
Enabled/Disable PodSecurityPolicy
{"type": "boolean"}
cluster.yml.json
always_pull_images
Enable/Disable AlwaysPullImages admissions plugin
{"type": "boolean"}
cluster.yml.json
secrets_encryption_config
Secrets encryption provider config
{}
cluster.yml.json
audit_log
Audit Log Configuration
{}
cluster.yml.json
admission_configuration
AdmissionConfiguration
{}
cluster.yml.json
event_rate_limit
Event Rate Limit configuration
{}
cluster.yml.json
cluster_cidr
CIDR Range for Pods in cluster
{"type": "string"}
cluster.yml.json
service_cluster_ip_range
Virtual IP range that will be used by Kubernetes services
{"type": "string"}
cluster.yml.json
cluster_domain
Domain of the cluster (default: "cluster.local")
{"type": "string"}
cluster.yml.json
infra_container_image
The image whose network/ipc namespaces containers in each pod will use
{"type": "string"}
cluster.yml.json
cluster_dns_server
Cluster DNS service ip
{"type": "string"}
cluster.yml.json
fail_swap_on
Fail if swap is enabled
{"type": "boolean"}
cluster.yml.json
generate_serving_certificate
Generate per node kubelet serving certificates created using kube-ca
{"type": "boolean"}
cluster.yml.json
lb-version
overrides autodetection. Only support v2.
{"type": "string"}
cluster.yml.json
use-octavia
uses Octavia V2 service catalog endpoint
{"type": "boolean"}
cluster.yml.json
subnet-id
overrides autodetection.
{"type": "string"}
cluster.yml.json
floating-network-id
If specified, will create floating ip for loadbalancer, or do not create floating ip.
{"type": "string"}
cluster.yml.json
lb-method
default to ROUND_ROBIN.
{"type": "string"}
cluster.yml.json
provider
Monitoring server provider
{"type": "string"}
cluster.yml.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.yml.json
node_selector
NodeSelector key pair
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
update_strategy
Update strategy
{}
cluster.yml.json
replicas
Number of monitoring addon pods
{"type": "integer"}
cluster.yml.json
tolerations
Tolerations for Deployments
{"items": {}, "type": "array"}
cluster.yml.json
metrics_server_priority_class_name
Priority class name for Metrics-Server's "metrics-server" deployment
{"type": "string"}
cluster.yml.json
plugin
Network Plugin That will be used in kubernetes cluster
{"type": "string"}
cluster.yml.json
options
Plugin options to configure network properties
{"patternProperties": {".*": {"oneOf": [{"type": "string"}, {"type": "number"}]}}, "type": "object"}
cluster.yml.json
mtu
Set MTU for CNI provider
{"type": "integer"}
cluster.yml.json
calico_network_provider
CalicoNetworkProvider
{}
cluster.yml.json
canal_network_provider
CanalNetworkProvider
{}
cluster.yml.json
flannel_network_provider
FlannelNetworkProvider
{}