Skip to content

Commit 192c194

Browse files
committed
docs: update topology-aware policy documentation.
Signed-off-by: Krisztian Litkey <[email protected]>
1 parent 5eaef4b commit 192c194

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

docs/resource-policy/policy/topology-aware.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@ behavior. These options can be supplied as part of the effective
145145
`normal`, `low`, and `none`. Currently this option only affects exclusive
146146
CPU allocations. For a more detailed discussion of CPU prioritization see
147147
the [cpu allocator](../developers-guide/cpu-allocator.md) documentation.
148+
- `unlimitedBurstable`
149+
- is the default topology level preference for containers with unlimited
150+
burstability. The policy will try to allocate Burstable containers with
151+
no CPU limit to a pool at this topology level. The possible values are:
152+
`system`, `package`, `die`, `numa`.
148153

149154
Additionally, the following sub-configuration is available for instrumentation:
150155

@@ -281,6 +286,29 @@ metadata:
281286
These Pod annotations have no effect on containers which are not eligible for
282287
exclusive allocation.
283288
289+
### Preferred Topology Level for Burstable Containers Without CPU Limit
290+
291+
CPU-unlimited burstable containers are by default preferred to allocate to a
292+
pool at the topology level specified by the `unlimitedBurstable` configuration
293+
option. This global default can be overridden by pod or container using the
294+
`unlimited-burstable.resource-policy.nri.io` annotation. This annotation can
295+
have the same values as the `unlimitedBurstable` configuration option.
296+
297+
```yaml
298+
metadata:
299+
annotations:
300+
# prefer to allocate container within the pod by default to a die
301+
unlimited-burstable.resource-policy.nri.io/pod: "die"
302+
# prefer to allocate C1 to a single NUMA node
303+
unlimited-burstable.resource-policy.nri.io/container.C1: "numa"
304+
# prefer to allocate C2 to a single socket
305+
unlimited-burstable.resource-policy.nri.io/container.C2: "package"
306+
# prefer to allocate C3 to all sockets in the system
307+
unlimited-burstable.resource-policy.nri.io/container.C3: "system"
308+
# any other containers in the pod will prefer allocation to a single die
309+
```
310+
311+
284312
### Selectively Disabling Hyperthreading
285313

286314
If a container opts to hide hyperthreads, it is allowed to use only

0 commit comments

Comments
 (0)