docs: restructure topology-aware documentation.#628
docs: restructure topology-aware documentation.#628klihub wants to merge 2 commits intocontainers:mainfrom
Conversation
klihub
force-pushed
the
docs/topology-aware/restructure
branch
6 times, most recently
from
0d1a829 to
d108a06
Compare
klihub
changed the title
Reorganize topology-aware.md taking inspiration from a similar update to balloons and using this table of content - Overview with problem statement and key features - Installation and Configuration - Configuration Options (8 subsections) - Cookbook with practical examples - Troubleshooting Co-authored-by: GitHub Copilot <noreply@github.com> Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
klihub
force-pushed
the
docs/topology-aware/restructure
branch
from
d108a06 to
4ef44cf
Compare
| ## Background | ||
| ## 1. Overview | ||
|
|
||
| ### What Problems Does the Topology-Aware Policy Solve? |
There was a problem hiding this comment.
I really like this introduction/background on why resource policies matter in the first place. Let's take it in.
In a later phase, when possibly adding a separate "Why to use a resource policy and how to choose the right one" (sub)document, perhaps we can move this background information there and include links from the topology-aware and balloons policy documents into that.
| The topology-aware policy integrates with Kubernetes through the | ||
| [Node Resource Interface (NRI)](https://github.com/containerd/nri). | ||
| It uses Kubernetes Pod and Container resource annotations to control | ||
| resource allocation behavior. |
There was a problem hiding this comment.
Might be useful to mention running as a DaemonSet that is configured through TopologyAwarePolicies CRs, pod/container-specific configuration through pod annotations, possibly scheduler integration via NRTs. (The last one I hesitated in balloons because I haven't tried that out myself...)
There was a problem hiding this comment.
If we had a sample scheduler plugin or some other component using NRT information published by our policies to guide scheduling, I'd be keen on mentioning it. Until then, not so sure. It's a bit different for balloons, because IIRC you push to NRT debugging information, so it might be useful for the user in some cases.
There was a problem hiding this comment.
I wonder if we could have been able to piggybag this scheduler plugin:
https://scheduler-plugins.sigs.k8s.io/docs/plugins/noderesourcetopology/
...but our NRT's might not be too compatible with what that plugins expects.
And in any case, as the direction is towards DRA that'll solve scheduling issues properly (without races), I suppose the usefulness of NRT might be more in status/debugging ("show me created pools / CPU affinity of containers") rather than scheduling...
Signed-off-by: Krisztian Litkey <krisztian.litkey@intel.com>
klihub
force-pushed
the
docs/topology-aware/restructure
branch
from
e144b3c to
720e3f5
Compare
2 participants
This PR is an attempt to restructure the topology-aware documentation. I threw copilot at it asking to reorganize the content taking the ToC from the corresponding balloons PR#627.