add comment for ORMResourceNamesMap flag

kubewharf · Dec 18, 2023 · a26b792 · a26b792
1 parent 63bf19e
commit a26b792
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 6 deletions.
diff --git a/cmd/katalyst-agent/app/options/orm/orm_base.go b/cmd/katalyst-agent/app/options/orm/orm_base.go
@@ -43,7 +43,11 @@ func (o *GenericORMPluginOptions) AddFlags(fss *cliflag.NamedFlagSets) {
 
 	fs.DurationVar(&o.ORMRconcilePeriod, "orm-reconcile-period",
 		o.ORMRconcilePeriod, "orm resource reconcile period")
-	fs.Var(cliflag.NewMapStringString(&o.ORMResourceNamesMap), "orm-resource-names-map", "A set of ResourceName=ResourceQuantity (e.g. best-effort-cpu=cpu,best-effort-memory=memory,...) pairs that map resource name \"best-effort-cpu\" to resource name \"cpu\" during QoS Resource Manager allocation period.")
+	fs.Var(cliflag.NewMapStringString(&o.ORMResourceNamesMap), "orm-resource-names-map",
+		"A set of ResourceName=ResourceQuantity pairs that map resource name during QoS Resource Manager allocation period. "+
+			"e.g. 'resource.katalyst.kubewharf.io/reclaimed_millicpu=cpu,resource.katalyst.kubewharf.io/reclaimed_memory=memory' "+
+			"should be set for that reclaimed_cores pods with resources [resource.katalyst.kubewharf.io/reclaimed_millicpu] and [resource.katalyst.kubewharf.io/reclaimed_memory]"+
+			"will also be allocated by [cpu] and [memory] QRM plugins")
 	fs.IntVar(&o.ORMPodNotifyChanLen, "orm-pod-notify-chan-len",
 		o.ORMPodNotifyChanLen, "length of pod addition and movement notifying channel")
 }

diff --git a/pkg/agent/resourcemanager/outofband/checkpoint_test.go b/pkg/agent/resourcemanager/outofband/checkpoint_test.go
@@ -28,6 +28,8 @@ import (
 )
 
 func TestCheckpoint(t *testing.T) {
+	t.Parallel()
+
 	checkpointManager, err := checkpointmanager.NewCheckpointManager("/tmp")
 	assert.NoError(t, err)
 

diff --git a/pkg/agent/resourcemanager/outofband/endpoint/endpoint_test.go b/pkg/agent/resourcemanager/outofband/endpoint/endpoint_test.go
@@ -30,14 +30,18 @@ var (
 )
 
 func TestNewEndpoint(t *testing.T) {
-	socket := path.Join("/tmp", eSocketName)
+	t.Parallel()
+
+	socket := path.Join("/tmp", "TestNewEndpoint"+eSocketName)
 
 	p, e := eSetup(t, socket, "mock")
 	defer eCleanup(t, p, e)
 }
 
 func TestAllocate(t *testing.T) {
-	socket := path.Join("/tmp", eSocketName)
+	t.Parallel()
+
+	socket := path.Join("/tmp", "TestAllocate"+eSocketName)
 	p, e := eSetup(t, socket, "mock")
 	defer eCleanup(t, p, e)
 
@@ -54,12 +58,16 @@ func TestAllocate(t *testing.T) {
 }
 
 func TestNewStoppedEndpointImpl(t *testing.T) {
+	t.Parallel()
+
 	ei := NewStoppedEndpointImpl("cpu")
 	require.NotNil(t, ei)
 }
 
 func TestRemovePod(t *testing.T) {
-	socket := path.Join("/tmp", eSocketName)
+	t.Parallel()
+
+	socket := path.Join("/tmp", "TestRemovePod"+eSocketName)
 	p, e := eSetup(t, socket, "mock")
 	defer eCleanup(t, p, e)
 
@@ -70,7 +78,9 @@ func TestRemovePod(t *testing.T) {
 }
 
 func TestGetResourceAllocation(t *testing.T) {
-	socket := path.Join("/tmp", eSocketName)
+	t.Parallel()
+
+	socket := path.Join("/tmp", "TestGetResourceAllocation"+eSocketName)
 	p, e := eSetup(t, socket, "mock")
 	defer eCleanup(t, p, e)
 
@@ -85,7 +95,9 @@ func TestGetResourceAllocation(t *testing.T) {
 }
 
 func TestClient(t *testing.T) {
-	socket := path.Join("/tmp", eSocketName)
+	t.Parallel()
+
+	socket := path.Join("/tmp", "TestClient"+eSocketName)
 	p, e := eSetup(t, socket, "mock")
 	defer eCleanup(t, p, e)