more detailed introduction

kubewharf · Dec 12, 2023 · ca91860 · ca91860
1 parent 8874af1
commit ca91860
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/pkg/consts/qos.go b/pkg/consts/qos.go
@@ -127,8 +127,15 @@ const (
 	PodAnnotationNetworkEnhancementAffinityRestrictedTrue = "true"
 )
 
-// const variables for pod annotations about qos level enhancement for micro-topology level inter-pod affinity
-
+// const variables for pod annotations about qos level enhancement for micro-topology level inter-pod affinity,
+// PodAnnotationMicroTopologyRequired & Preferred stands for hard & soft affinity requirements,
+// PodAnnotationMicroTopologyAffinityNUMA & Socket stands for topology zone of seletor,
+// PodAnnotationMicroTopologyAffinityDefaultZone means the default topology zone is NUMA.
+// example of api is:
+//
+//	"katalyst.kubewharf.io/microtopology_antiaffinity": '{
+//			"required": [{"matchLabels": {"labelKey": "labelValue"}, "zone":"numa"}]
+//	}'
 const (
 	PodAnnotationMicroTopologyInterPodAffinity     = "katalyst.kubewharf.io/microtopology_affinity"
 	PodAnnotationMicroTopologyInterPodAntiAffinity = "katalyst.kubewharf.io/microtopology_antiaffinity"