Skip to content

Commit 71d2f82

Browse files
authored
docs: describe node over-/ underprovisioning (#49)
1 parent ccbae16 commit 71d2f82

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

docs/advanced-setups.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,20 @@ clusterctl generate cluster test-duacl-stack \
7171
--flavor=dual-stack > cluster.yaml
7272
```
7373

74+
#### Node over-/ underprovisioning
75+
76+
By default our scheduler only allows to allocate as much memory to guests as the host has. This might not be a desirable behaviour in all cases. For example, one might to explicitly want to overprovision their host's memory, or to reserve bit of the host's memory for itself.
77+
78+
This behaviour can be configured in the `ProxmoxCluster` CR through the field `.spec.schedulerHints.memoryAdjustment`.
79+
80+
For example, setting it to `0` (zero), entirely disables scheduling based on memory. Alternatively, if you set it to any value greater than `0`, the scheduler will treat your host as it would have `${value}%` of memory. In real numbers that would mean, if you have a host with 64GB of memory and set the number to `300`, the scheduler would allow you to provision guests with a total of 192GB memory and therefore overprovision the host. (Use with caution! It's strongly suggested to have memory ballooning configured everywhere.). Or, if you were to set it to `95` for example, it would treat your host as it would only have 60,8GB of memory, and leave the remaining 3,2GB for the host.
81+
7482

7583
## Notes
7684

77-
* Clusters with IPV6 IPs only is supported.
85+
* Clusters with IPV6 only is supported.
7886
* Multiple NICs & Dual-stack setups can be mixed together.
79-
* If you're looking for more customized setups, you can create your own cluster template and use it with `clusterctl generate cluster` command.
87+
* If you're looking for more customized setups, you can create your own cluster template and use it with the `clusterctl generate cluster` command, by passing it `--from yourtemplate.yaml`.
8088

8189
## API Reference
8290

0 commit comments

Comments
 (0)