From 4a0a951483eb25e003db3b284837231f61ea44a3 Mon Sep 17 00:00:00 2001 From: Krisztian Litkey Date: Mon, 2 Dec 2024 10:00:49 +0200 Subject: [PATCH] docs: update for Pod Resource API. Signed-off-by: Krisztian Litkey --- docs/resource-policy/policy/topology-aware.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/resource-policy/policy/topology-aware.md b/docs/resource-policy/policy/topology-aware.md index 103dc94bb..cebdd3297 100644 --- a/docs/resource-policy/policy/topology-aware.md +++ b/docs/resource-policy/policy/topology-aware.md @@ -443,7 +443,7 @@ metadata: prefer-reserved-cpus.resource-policy.nri.io/container.special: "false" ``` -## Allowing or denying mount/device paths via annotations +## Controlling Topology Hints Via Annotations User is able mark certain pods and containers to have allowed or denied paths for mounts or devices. What this means is that when the system @@ -486,6 +486,16 @@ metadata: - /xy-zy/another-blacklisted-path5 ``` +## Using Pod Resource API for Extra Topology Hints + +If access to the `kubelet`'s `Pod Resource API` is enabled in the +[Node Agent's](../developers-guide/architecture.md#node-agent) configuration, +it is automatically used to generate per-container topology hints when a +device with locality to a NUMA node is advertised by the API. Annotated allow +and deny lists can be used to selective disable or enable per-resource hints, +using `podresapi:$RESOURCE_NAME` as the path. + + ## Container Affinity and Anti-Affinity ### Introduction