Improve docs, improve code clarity

kubernetes-sigs · Nov 29, 2024 · 989dd48 · 989dd48
1 parent c9058d9
commit 989dd48
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/apis/kueue/v1beta1/workload_types.go b/apis/kueue/v1beta1/workload_types.go
@@ -171,6 +171,10 @@ type PodSetAssignment struct {
 	//   cloud.provider.com/topology-rack: rack-2
 	//
 	// Example:
+	// Below there is an equivalent of the above example assuming, Topology
+	// object defines kubernetes.io/hostname as the lowest level in topology.
+	// Hence we omit higher level of topologies, since the hostname label
+	// is sufficient to explicitly identify a proper node.
 	//
 	// topologyAssignment:
 	//   levels:

diff --git a/keps/2724-topology-aware-scheduling/README.md b/keps/2724-topology-aware-scheduling/README.md
@@ -517,6 +517,10 @@ type PodSetAssignment struct {
   //   cloud.provider.com/topology-rack: rack-2
   //
   // Example:
+	// Below there is an equivalent of the above example assuming, Topology
+	// object defines kubernetes.io/hostname as the lowest level in topology.
+	// Hence we omit higher level of topologies, since the hostname label
+	// is sufficient to explicitly identify a proper node.
   //
   // topologyAssignment:
   //   levels:

diff --git a/pkg/cache/tas_flavor_snapshot.go b/pkg/cache/tas_flavor_snapshot.go
@@ -341,11 +341,12 @@ func (s *TASFlavorSnapshot) buildAssignment(domains []*domain) *kueue.TopologyAs
 	slices.SortFunc(domains, func(a, b *domain) int {
 		return cmp.Compare(a.id, b.id)
 	})
+	levelIdx := 0
 	// assign only hostname values if topology defines it
 	if s.isLowestLevelNode() {
-		return s.buildTopologyAssignmentForLevels(domains, len(s.levelKeys)-1)
+		levelIdx = len(s.levelKeys) - 1
 	}
-	return s.buildTopologyAssignmentForLevels(domains, 0)
+	return s.buildTopologyAssignmentForLevels(domains, levelIdx)
 }
 
 func (s *TASFlavorSnapshot) lowerLevelDomains(domains []*domain) []*domain {

diff --git a/site/content/en/docs/reference/kueue.v1beta1.md b/site/content/en/docs/reference/kueue.v1beta1.md
@@ -1692,7 +1692,11 @@ cloud.provider.com/topology-rack: rack-1</li>
 cloud.provider.com/topology-block: block-1
 cloud.provider.com/topology-rack: rack-2</li>
 </ul>
-<p>Example:</p>
+<p>Example:
+Below there is an equivalent of the above example assuming, Topology
+object defines kubernetes.io/hostname as the lowest level in topology.
+Hence we omit higher level of topologies, since the hostname label
+is sufficient to explicitly identify a proper node.</p>
 <p>topologyAssignment:
 levels:</p>
 <ul>