Extended Config Schema (Recommended) - Rafay Product Documentation
Extended Config Schema (Recommended)
V3 Cluster configuration for MKS cluster
| Field | Description | Type |
|---|---|---|
| apiVersion: infra.k8smgmt.io/v3 |
string | |
| kind: Cluster |
string | |
| name: | Cluster name | string |
| description: | Cluster Description | string |
| project: | Project under which the cluster is created | string |
| labels: {} |
Cluster labels | object |
| annotations: {} |
Cluster annotations | object |
| type: | Cluster type mks | string |
| name: | Blueprint name associated with the cluster | string |
| version: | Blueprint version associated with the cluster. If not provided, the latest version is used | string |
| cloudCredentials: | SSH credentials used to create and manage the cluster. Mandatory for system sync | string |
| location: | Data Center location where cluster is created | string |
| autoApproveNodes: false |
Auto approves incoming nodes by default | boolean |
| dedicatedMastersEnabled: false |
This is deprecated in favour of dedicatedControlPlane | boolean |
| dedicatedControlPlane: false |
Select this option for preventing scheduling of user workloads on Control Plane nodes | boolean |
| kubernetesVersion: | kubernetes version for the cluster | string |
| installerTtl: | Installer TTL Configuration | string |
| kubeletExtraArgs: | Customize kubelet via cluster level kubelet extra arguments | object |
| kubeletConfigurationOverrides: | Customize kubelet via cluster level kubelet configuration overrides | string |
| platformVersion: | Platform version for cluster components | string |
| highAvailability: false |
Select this option for highly available control plane. Minimum three control plane nodes are required | boolean |
| strategy: | Kubernetes upgrade strategy for worker nodes and Valid options are : concurrent/sequential | string |
| workerConcurrency: | Number or percentage of workers to upgrade concurrently | string |
| name: | Name of the CNI plugin. Valid options are : Calico, Cilium, Canal | string |
| version: | Version of the CNI plugin | string |
| podSubnet: | Subnet for pod networking. If not provided, 10.244.0.0/16 is allocated | string |
| serviceSubnet: | Subnet allocated for K8s services. If not provided, 10.96.0.0/12 is allocated | string |
| podSubnet: | Subnet for pod networking | string |
| serviceSubnet: | Subnet allocated for K8s services | string |
| - hostname: |
Hostname of the node | string |
| - operatingSystem: |
Operating system of the node | string |
| - kubeletExtraArgs: |
Customize kubelet via node level kubelet extra arguments | object |
| - kubeletConfigurationOverrides: |
Customize kubelet via node level kubelet configuration overrides | string |
| - arch: |
Architecture of the node | string |
| - interface: |
Network interface of the node | string |
| - privateIP: |
Private IP address of the node | string |
| - roles: |
Roles assigned to the node, Valid roles are : ControlPlane, Worker, Storage | string[] |
| - key: |
Key for the node label | string |
| - value: |
Value for the node label | string |
| - effect: |
Available effects are NoSchedule, PreferNoSchedule, NoExecute | string |
| - key: |
Key for this Taint effect | string |
| - value: |
Value for this Taint effect | string |
| privateKeyPath: | Path to the SSH private key | string |
| username: | SSH username | string |
| port: | SSH port | string |
| passphrase: | Passphrase for SSH | string |
| ipAddress: | IP address for SSH | string |
| privateKeyPath: | Path to the SSH private key | string |
| username: | SSH username | string |
| port: | SSH port | string |
| passphrase: | Passphrase for SSH | string |
| - key: |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists | string |
| - operator: |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. | string |
| - value: |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string | string |
| - effect: |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute | string |
| - tolerationSeconds: |
Seconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint | integer |
| nodeSelector: | nodeSelector to apply to system components | object |
| nodeSelectionEnabled: false |
represents nodeSelector to be added in daemon sets | boolean |
| - key: |
Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists | string |
| - operator: |
Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. | string |
| - value: |
Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string | string |
| - effect: |
Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute | string |
| - tolerationSeconds: |
Seconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint | integer |
| enabled: false |
Enable this option if your infrastructure is running behind a proxy | boolean |
| httpProxy: | Configure proxy information with protocol, host and port information. Ex : http://proxy.example.com:8080/ | string |
| httpsProxy: | Configure proxy information with protocol, host and port information. Ex : https://proxy.example.com:8080/ | string |
| noProxy: | Comma separated list of hosts that need connectivity without proxy. Ex : example.com, 10.96.0.0/12, 10.244.0.0/16 | string |
| proxyAuth: | string | |
| allowInsecureBootstrap: false |
Select this option if proxy is terminating/inspecting TLS traffic | boolean |
| bootstrapCA: | Root CA certificate of the proxy | string |
| enabled: false |
Enable sharing for this resource. | boolean |
| - name: |
The name of the project to share the resource. | string |