Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

docs: fix misleading sysctldConfig examples #3682

Merged
merged 1 commit into from Aug 10, 2020
Merged

docs: fix misleading sysctldConfig examples #3682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 21 additions & 2 deletions docs/topics/clusterdefinitions.md
View file
Open in desktop
Expand Up @@ -696,18 +696,37 @@ Custom YAML specifications can be configured for kube-scheduler, kube-controller

#### sysctldConfig

The `sysctldConfig` configuration interface allows generic Linux kernel runtime configuration that will be delivered to sysctl. Use at your own risk! It is a generic key/value object, and a child property of `masterProfile` and node pool configurations under `agentPoolProfiles`, for tuning the Linux kernel parameters on master and/or node pool VMs, respectively. An example custom sysctl config:
The `sysctldConfig` configuration interface allows generic Linux kernel runtime configuration that will be delivered to sysctl. Use at your own risk! It is a generic key/value object, and a child property of both `masterProfile` and node pool configurations under `agentPoolProfiles`, for tuning the Linux kernel parameters on master and/or node pool VMs, respectively. An example custom sysctl config that tunes the control plane VMs:

```
"kubernetesConfig": {
"masterProfile": {
...
"sysctldConfig": {
"net.ipv4.tcp_keepalive_time": "120",
"net.ipv4.tcp_keepalive_intvl": "75",
"net.ipv4.tcp_keepalive_probes": "9"
}
...
}
```

And, here's that same config override example on a node pool named "my-custom-node-pool":

```
"agentPoolProfiles": [
{
"name": "my-custom-node-pool",
...
"sysctldConfig": {
"net.ipv4.tcp_keepalive_time": "120",
"net.ipv4.tcp_keepalive_intvl": "75",
"net.ipv4.tcp_keepalive_probes": "9"
}
...
}
]
```

Kubernetes kernel configuration varies by distro, so please validate that the kernel parameter and value works for the Linux flavor you are using in your cluster.

Below is a list of sysctl configuration that AKS Engine will configure by default for both Ubuntu 16.04-LTS and 18.04-LTS, for both master and node pool VMs:
Expand Down