Add TotalSystemMemory to Server status (#173)

* adds TotalSystemMemory to server status * uses resource quantity for memory * renames TotalSystemMemoryBytes to TotalSystemMemory
ironcore-dev · Nov 19, 2024 · fe41bd7 · fe41bd7
1 parent 57bec93
commit fe41bd7
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 8 deletions.
diff --git a/api/v1alpha1/server_types.go b/api/v1alpha1/server_types.go
@@ -183,6 +183,9 @@ type ServerStatus struct {
 	// NetworkInterfaces is a list of network interfaces associated with the server.
 	NetworkInterfaces []NetworkInterface `json:"networkInterfaces,omitempty"`
 
+	// TotalSystemMemory is the total amount of memory in bytes available on the server.
+	TotalSystemMemory *resource.Quantity `json:"totalSystemMemory,omitempty"`
+
 	// Storages is a list of storages associated with the server.
 	Storages []Storage `json:"storages,omitempty"`
 

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/bmc/bmc.go b/bmc/bmc.go
@@ -6,6 +6,7 @@ package bmc
 import (
 	"github.com/stmcginnis/gofish/common"
 	"github.com/stmcginnis/gofish/redfish"
+	"k8s.io/apimachinery/pkg/api/resource"
 )
 
 // BMC defines an interface for interacting with a Baseboard Management Controller.
@@ -194,6 +195,7 @@ type SystemInfo struct {
 	PowerState        redfish.PowerState
 	NetworkInterfaces []NetworkInterface
 	Processors        []Processor
+	TotalSystemMemory resource.Quantity
 	SystemUUID        string
 	SerialNumber      string
 	SKU               string

diff --git a/bmc/redfish.go b/bmc/redfish.go
@@ -12,6 +12,7 @@ import (
 
 	"github.com/stmcginnis/gofish"
 	"github.com/stmcginnis/gofish/redfish"
+	"k8s.io/apimachinery/pkg/api/resource"
 )
 
 var _ BMC = (*RedfishBMC)(nil)
@@ -180,16 +181,22 @@ func (r *RedfishBMC) GetSystemInfo(systemUUID string) (SystemInfo, error) {
 	if err != nil {
 		return SystemInfo{}, fmt.Errorf("failed to get systems: %w", err)
 	}
+	memoryString := fmt.Sprintf("%.fGi", system.MemorySummary.TotalSystemMemoryGiB)
+	quantity, err := resource.ParseQuantity(memoryString)
 
+	if err != nil {
+		return SystemInfo{}, fmt.Errorf("failed to parse memory quantity: %w", err)
+	}
 	return SystemInfo{
-		SystemUUID:   system.UUID,
-		Manufacturer: system.Manufacturer,
-		Model:        system.Model,
-		Status:       system.Status,
-		PowerState:   system.PowerState,
-		SerialNumber: system.SerialNumber,
-		SKU:          system.SKU,
-		IndicatorLED: string(system.IndicatorLED),
+		SystemUUID:        system.UUID,
+		Manufacturer:      system.Manufacturer,
+		Model:             system.Model,
+		Status:            system.Status,
+		PowerState:        system.PowerState,
+		SerialNumber:      system.SerialNumber,
+		SKU:               system.SKU,
+		IndicatorLED:      string(system.IndicatorLED),
+		TotalSystemMemory: quantity,
 	}, nil
 }
 

diff --git a/config/crd/bases/metal.ironcore.dev_servers.yaml b/config/crd/bases/metal.ironcore.dev_servers.yaml
@@ -483,6 +483,14 @@ spec:
                       type: array
                   type: object
                 type: array
+              totalSystemMemory:
+                anyOf:
+                - type: integer
+                - type: string
+                description: TotalSystemMemory is the total amount of memory in bytes
+                  available on the server.
+                pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
+                x-kubernetes-int-or-string: true
             type: object
         type: object
     served: true

diff --git a/docs/api-reference/api.md b/docs/api-reference/api.md
@@ -2111,6 +2111,19 @@ ServerState
 </tr>
 <tr>
 <td>
+<code>totalSystemMemory</code><br/>
+<em>
+<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity">
+k8s.io/apimachinery/pkg/api/resource.Quantity
+</a>
+</em>
+</td>
+<td>
+<p>TotalSystemMemoryBytes is the total amount of memory in bytes available on the server.</p>
+</td>
+</tr>
+<tr>
+<td>
 <code>storages</code><br/>
 <em>
 <a href="#metal.ironcore.dev/v1alpha1.Storage">

diff --git a/internal/controller/server_controller.go b/internal/controller/server_controller.go
@@ -436,6 +436,7 @@ func (r *ServerReconciler) updateServerStatus(ctx context.Context, log logr.Logg
 	server.Status.Manufacturer = systemInfo.Manufacturer
 	server.Status.Model = systemInfo.Model
 	server.Status.IndicatorLED = metalv1alpha1.IndicatorLED(systemInfo.IndicatorLED)
+	server.Status.TotalSystemMemory = &systemInfo.TotalSystemMemory
 
 	currentBiosVersion, err := bmcClient.GetBiosVersion(server.Spec.UUID)
 	if err != nil {