feat: use new property name for node count property + specify the core properties (node count, total/allocatable/available CPU/memory)

apis/cluster/v1/commons.go

@@ -18,6 +18,24 @@ const (
 	ClusterStateLeave ClusterState = "Leave"
 )
 
+const (
+	// A list of property names that should be supported by every property provider and
+	// is available out of the box in Fleet without any property provider configuration.
+
+	// The non-resource properties.
+	// NodeCountProperty is a property that describes the number of nodes in the cluster.
+	NodeCountProperty = "kubernetes-fleet.io/node-count"
+
+	// The resource properties.
+	// Total and allocatable CPU resource properties.
+	TotalCPUCapacityProperty       = "resources.kubernetes-fleet.io/total-cpu"
+	AllocatableCPUCapacityProperty = "resources.kubernetes-fleet.io/allocatable-cpu"
+
+	// Total and allocatable memory resource properties.
+	TotalMemoryCapacityProperty       = "resources.kubernetes-fleet.io/total-memory"
+	AllocatableMemoryCapacityProperty = "resources.kubernetes-fleet.io/allocatable-memory"
+)
+
 // ResourceUsage contains the observed resource usage of a member cluster.
 type ResourceUsage struct {
 	// Capacity represents the total resource capacity of all the nodes on a member cluster.

apis/cluster/v1beta1/commons.go

@@ -18,6 +18,24 @@ const (
 	ClusterStateLeave ClusterState = "Leave"
 )
 
+const (
+	// A list of property names that should be supported by every property provider and
+	// is available out of the box in Fleet without any property provider configuration.
+
+	// The non-resource properties.
+	// NodeCountProperty is a property that describes the number of nodes in the cluster.
+	NodeCountProperty = "kubernetes-fleet.io/node-count"
+
+	// The resource properties.
+	// Total and allocatable CPU resource properties.
+	TotalCPUCapacityProperty       = "resources.kubernetes-fleet.io/total-cpu"
+	AllocatableCPUCapacityProperty = "resources.kubernetes-fleet.io/allocatable-cpu"
+
+	// Total and allocatable memory resource properties.
+	TotalMemoryCapacityProperty       = "resources.kubernetes-fleet.io/total-memory"
+	AllocatableMemoryCapacityProperty = "resources.kubernetes-fleet.io/allocatable-memory"
+)
+
 // ResourceUsage contains the observed resource usage of a member cluster.
 type ResourceUsage struct {
 	// Capacity represents the total resource capacity of all the nodes on a member cluster.

docs/concepts/PropertyProviderAndClusterProperties/README.md

@@ -50,8 +50,8 @@ in the form of Kubernetes conditions.
 
 The Fleet member agent can run with or without a property provider. If a provider is not set up, or
 the given provider fails to start properly, the agent will collect limited properties about
-the cluster on its own, specifically the total and allocatable CPU and memory capacities of
-the host member cluster. 
+the cluster on its own, specifically the node count, plus the total/allocatable
+CPU and memory capacities of the host member cluster. 
 
 ## Cluster properties
 
@@ -75,7 +75,7 @@ such as `cpu` and `memory`, and the usage information should consist of:
 * Non-resource property: a metric about a member cluster, in the form of a key/value
 pair; the key should be in the format of
 [a Kubernetes label key](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set),
-such as `kubernetes.azure.com/node-count`, and the value at this moment should be a sortable
+such as `kubernetes-fleet.io/node-count`, and the value at this moment should be a sortable
 numeric that can be parsed as
 [a Kubernetes quantity](https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/).
 
@@ -92,7 +92,7 @@ status:
   agentStatus: ...
   conditions: ...
   properties:
-    kubernetes.azure.com/node-count:
+    kubernetes-fleet.io/node-count:
       observationTime: "2024-04-30T14:54:24Z"
       value: "2"
     ...
@@ -111,3 +111,15 @@ status:
 Note that conditions reported by the property provider (if any), would be available in the
 `.status.conditions` array as well.
 
+All property providers should support the following set of properties:
+
+* Non-resource properties:
+    * `kubernetes-fleet.io/node-count`: the number of nodes in the cluster
+* Resource properties
+    * The total and allocatable capacities of CPU (`cpu`) and memory (`memory`) resources in the cluster.
+
+### Reserved domain for property names
+
+Fleet reserves the domain, `kubernetes-fleet.io`, for property names. Except for the properties
+explicitly listed above, which should be supported by all property providers, any custom property added
+by a property provider should not use the reserved domain.

docs/howtos/property-based-scheduling.md

@@ -101,7 +101,7 @@ spec:
                 clusterSelectorTerms:
                 - propertySelector:
                     matchExpressions:
-                    - name: "kubernetes.azure.com/node-count"
+                    - name: "kubernetes-fleet.io/node-count"
                       operator: Ge
                       values:
                       - "5"
@@ -130,7 +130,7 @@ spec:
                       region: east
                   propertySelector:
                     matchExpressions:
-                    - name: "kubernetes.azure.com/node-count"
+                    - name: "kubernetes-fleet.io/node-count"
                       operator: Ge
                       values:
                       - "5"
@@ -225,7 +225,7 @@ spec:
             - weight: 20
               preference:
                 metricSorter:
-                  name: kubernetes.azure.com/node-count
+                  name: kubernetes-fleet.io/node-count
                   sortOrder: Descending
 ```
 

pkg/controllers/internalmembercluster/v1beta1/member_controller.go

@@ -463,6 +463,12 @@ func (r *Reconciler) updateResourceStats(ctx context.Context, imc *clusterv1beta
 		allocatableMemory.Add(*(node.Status.Allocatable.Memory()))
 	}
 
+	imc.Status.Properties = map[clusterv1beta1.PropertyName]clusterv1beta1.PropertyValue{
+		clusterv1beta1.NodeCountProperty: {
+			Value:           fmt.Sprintf("%d", len(nodes.Items)),
+			ObservationTime: metav1.Now(),
+		},
+	}
 	imc.Status.ResourceUsage.Capacity = corev1.ResourceList{
 		corev1.ResourceCPU:    capacityCPU,
 		corev1.ResourceMemory: capacityMemory,

pkg/controllers/internalmembercluster/v1beta1/member_controller_integration_test.go

@@ -136,6 +136,7 @@ var _ = Describe("Test Internal Member Cluster Controller", Serial, func() {
 			Expect(updatedHealthCond.Reason).To(Equal(EventReasonInternalMemberClusterHealthy))
 
 			By("checking updated member cluster usage")
+			Expect(imc.Status.Properties[clusterv1beta1.NodeCountProperty].Value).ShouldNot(BeEmpty())
 			Expect(imc.Status.ResourceUsage.Allocatable).ShouldNot(BeNil())
 			Expect(imc.Status.ResourceUsage.Capacity).ShouldNot(BeNil())
 			Expect(imc.Status.ResourceUsage.ObservationTime).ToNot(Equal(metav1.Now()))

pkg/propertyprovider/aks/provider.go

@@ -29,10 +29,9 @@ import (
 )
 
 const (
-	// A list of properties that the AKS property provider collects.
+	// A list of properties that the AKS property provider collects in addition to the
+	// Fleet required ones.
 
-	// NodeCountProperty is a property that describes the number of nodes in the cluster.
-	NodeCountProperty = "kubernetes.azure.com/node-count"
 	// PerCPUCoreCostProperty is a property that describes the average hourly cost of a CPU core in
 	// a Kubernetes cluster.
 	PerCPUCoreCostProperty = "kubernetes.azure.com/per-cpu-core-cost"
@@ -41,13 +40,9 @@ const (
 	PerGBMemoryCostProperty = "kubernetes.azure.com/per-gb-memory-cost"
 
 	// The resource properties.
-	TotalCPUCapacityProperty       = "resources.kubernetes-fleet.io/total-cpu"
-	AllocatableCPUCapacityProperty = "resources.kubernetes-fleet.io/allocatable-cpu"
-	AvailableCPUCapacityProperty   = "resources.kubernetes-fleet.io/available-cpu"
-
-	TotalMemoryCapacityProperty       = "resources.kubernetes-fleet.io/total-memory"
-	AllocatableMemoryCapacityProperty = "resources.kubernetes-fleet.io/allocatable-memory"
-	AvailableMemoryCapacityProperty   = "resources.kubernetes-fleet.io/available-memory"
+	// Available CPU and memory resource properties.
+	AvailableCPUCapacityProperty    = "resources.kubernetes-fleet.io/available-cpu"
+	AvailableMemoryCapacityProperty = "resources.kubernetes-fleet.io/available-memory"
 
 	CostPrecisionTemplate = "%.3f"
 )
@@ -197,7 +192,7 @@ func (p *PropertyProvider) Collect(_ context.Context) propertyprovider.PropertyC
 
 	// Collect the non-resource properties.
 	properties := make(map[clusterv1beta1.PropertyName]clusterv1beta1.PropertyValue)
-	properties[NodeCountProperty] = clusterv1beta1.PropertyValue{
+	properties[clusterv1beta1.NodeCountProperty] = clusterv1beta1.PropertyValue{
 		Value:           fmt.Sprintf("%d", p.nodeTracker.NodeCount()),
 		ObservationTime: metav1.Now(),
 	}

pkg/propertyprovider/aks/provider_integration_test.go

@@ -174,7 +174,7 @@ var (
 
 				expectedRes := propertyprovider.PropertyCollectionResponse{
 					Properties: map[clusterv1beta1.PropertyName]clusterv1beta1.PropertyValue{
-						NodeCountProperty: {
+						clusterv1beta1.NodeCountProperty: {
 							Value: fmt.Sprintf("%d", len(nodes)),
 						},
 						PerCPUCoreCostProperty: {

pkg/propertyprovider/aks/provider_test.go

@@ -165,7 +165,7 @@ func TestCollect(t *testing.T) {
 			},
 			wantMetricCollectionResponse: propertyprovider.PropertyCollectionResponse{
 				Properties: map[clusterv1beta1.PropertyName]clusterv1beta1.PropertyValue{
-					NodeCountProperty: {
+					clusterv1beta1.NodeCountProperty: {
 						Value: "2",
 					},
 					PerCPUCoreCostProperty: {
@@ -294,7 +294,7 @@ func TestCollect(t *testing.T) {
 			},
 			wantMetricCollectionResponse: propertyprovider.PropertyCollectionResponse{
 				Properties: map[clusterv1beta1.PropertyName]clusterv1beta1.PropertyValue{
-					NodeCountProperty: {
+					clusterv1beta1.NodeCountProperty: {
 						Value: "2",
 					},
 					PerCPUCoreCostProperty: {

pkg/scheduler/framework/plugins/clusteraffinity/filtering_test.go

@@ -32,7 +32,7 @@ const (
 	envLabelName   = "env"
 	envLabelValue1 = "prod"
 
-	nodeCountPropertyName   = "kubernetes.azure.com/node-count"
+	nodeCountPropertyName   = "kubernetes-fleet.io/node-count"
 	nodeCountPropertyValue1 = "3"
 
 	availableCPUPropertyName   = "resources.kubernetes-fleet.io/available-cpu"

test/e2e/placement_pickall_test.go

@@ -14,6 +14,7 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"k8s.io/utils/ptr"
 
+	clusterv1beta1 "go.goms.io/fleet/apis/cluster/v1beta1"
 	placementv1beta1 "go.goms.io/fleet/apis/placement/v1beta1"
 	"go.goms.io/fleet/pkg/propertyprovider/aks"
 	"go.goms.io/fleet/test/e2e/framework"
@@ -388,7 +389,7 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 											PropertySelector: &placementv1beta1.PropertySelector{
 												MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 													{
-														Name:     aks.NodeCountProperty,
+														Name:     clusterv1beta1.NodeCountProperty,
 														Operator: placementv1beta1.PropertySelectorGreaterThanOrEqualTo,
 														Values: []string{
 															"3",
@@ -462,14 +463,14 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 											PropertySelector: &placementv1beta1.PropertySelector{
 												MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 													{
-														Name:     aks.NodeCountProperty,
+														Name:     clusterv1beta1.NodeCountProperty,
 														Operator: placementv1beta1.PropertySelectorGreaterThanOrEqualTo,
 														Values: []string{
 															"3",
 														},
 													},
 													{
-														Name:     aks.TotalCPUCapacityProperty,
+														Name:     clusterv1beta1.TotalCPUCapacityProperty,
 														Operator: placementv1beta1.PropertySelectorLessThan,
 														Values: []string{
 															"10000",
@@ -522,14 +523,14 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 									PropertySelector: &placementv1beta1.PropertySelector{
 										MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 											{
-												Name:     aks.NodeCountProperty,
+												Name:     clusterv1beta1.NodeCountProperty,
 												Operator: placementv1beta1.PropertySelectorGreaterThanOrEqualTo,
 												Values: []string{
 													"3",
 												},
 											},
 											{
-												Name:     aks.TotalCPUCapacityProperty,
+												Name:     clusterv1beta1.TotalCPUCapacityProperty,
 												Operator: placementv1beta1.PropertySelectorLessThan,
 												Values: []string{
 													"10000",
@@ -542,7 +543,7 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 									PropertySelector: &placementv1beta1.PropertySelector{
 										MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 											{
-												Name:     aks.NodeCountProperty,
+												Name:     clusterv1beta1.NodeCountProperty,
 												Operator: placementv1beta1.PropertySelectorEqualTo,
 												Values: []string{
 													"4",
@@ -622,7 +623,7 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 														},
 													},
 													{
-														Name:     aks.AllocatableCPUCapacityProperty,
+														Name:     clusterv1beta1.AllocatableCPUCapacityProperty,
 														Operator: placementv1beta1.PropertySelectorGreaterThan,
 														Values: []string{
 															"10000",
@@ -695,7 +696,7 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 											PropertySelector: &placementv1beta1.PropertySelector{
 												MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 													{
-														Name:     aks.NodeCountProperty,
+														Name:     clusterv1beta1.NodeCountProperty,
 														Operator: placementv1beta1.PropertySelectorGreaterThanOrEqualTo,
 														Values: []string{
 															"3",
@@ -771,7 +772,7 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 											PropertySelector: &placementv1beta1.PropertySelector{
 												MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 													{
-														Name:     aks.AllocatableCPUCapacityProperty,
+														Name:     clusterv1beta1.AllocatableCPUCapacityProperty,
 														Operator: placementv1beta1.PropertySelectorLessThanOrEqualTo,
 														Values: []string{
 															"10000",
@@ -840,7 +841,7 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 									PropertySelector: &placementv1beta1.PropertySelector{
 										MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 											{
-												Name:     aks.AllocatableMemoryCapacityProperty,
+												Name:     clusterv1beta1.AllocatableMemoryCapacityProperty,
 												Operator: placementv1beta1.PropertySelectorLessThan,
 												Values: []string{
 													"1Ki",
@@ -871,14 +872,14 @@ var _ = Describe("placing resources using a CRP of PickAll placement type", func
 									PropertySelector: &placementv1beta1.PropertySelector{
 										MatchExpressions: []placementv1beta1.PropertySelectorRequirement{
 											{
-												Name:     aks.NodeCountProperty,
+												Name:     clusterv1beta1.NodeCountProperty,
 												Operator: placementv1beta1.PropertySelectorEqualTo,
 												Values: []string{
 													"2",
 												},
 											},
 											{
-												Name:     aks.TotalMemoryCapacityProperty,
+												Name:     clusterv1beta1.TotalMemoryCapacityProperty,
 												Operator: placementv1beta1.PropertySelectorGreaterThanOrEqualTo,
 												Values: []string{
 													"1Ki",