Add event subscription management for server events and metrics

api/v1alpha1/bmc_types.go

@@ -206,6 +206,14 @@ type BMCStatus struct {
 	// +optional
 	LastResetTime *metav1.Time `json:"lastResetTime,omitempty"`
 
+	// MetricsReportSubscriptionLink is the link to the metrics report subscription of the bmc.
+	// +optional
+	MetricsReportSubscriptionLink string `json:"metricsReportSubscriptionLink,omitempty"`
+
+	// EventsSubscriptionLink is the link to the events subscription of the bmc.
+	// +optional
+	EventsSubscriptionLink string `json:"eventsSubscriptionLink,omitempty"`
+
 	// Conditions represents the latest available observations of the BMC's current state.
 	// +patchStrategy=merge
 	// +patchMergeKey=type

bmc/bmc.go

@@ -109,6 +109,12 @@ type BMC interface {
 	// GetBMCUpgradeTask retrieves the task for the BMC upgrade.
 	GetBMCUpgradeTask(ctx context.Context, manufacturer string, taskURI string) (*schemas.Task, error)
 
+	// CreateEventSubscription creates an event subscription for the manager.
+	CreateEventSubscription(ctx context.Context, destination string, eventType schemas.EventFormatType, protocol schemas.DeliveryRetryPolicy) (string, error)
+
+	// DeleteEventSubscription deletes an event subscription for the manager.
+	DeleteEventSubscription(ctx context.Context, uri string) error
+
 	// CreateOrUpdateAccount creates or updates a BMC user account.
 	CreateOrUpdateAccount(ctx context.Context, userName, role, password string, enabled bool) error
 

bmc/mock/server/data/Managers/BMC/index.json

@@ -4,6 +4,7 @@
     "Name": "Manager",
     "ManagerType": "BMC",
     "Description": "Contoso BMC",
+    "Manufacturer": "Contoso",
     "ServiceEntryPointUUID": "92384634-2938-2342-8820-489239905423",
     "UUID": "58893887-8974-2487-2389-841168418919",
     "Model": "Joo Janta 200",
@@ -96,4 +97,4 @@
     },
     "@odata.id": "/redfish/v1/Managers/BMC",
     "@Redfish.Copyright": "Copyright 2014-2023 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright."
-}
+}

bmc/mock/server/server.go

@@ -26,6 +26,14 @@ var (
 	dataFS embed.FS
 )
 
+type Collection struct {
+	Members []Member `json:"Members"`
+}
+
+type Member struct {
+	OdataID string `json:"@odata.id"`
+}
+
 const (
 	PowerOffState = "Off"
 	PowerOnState  = "On"
@@ -116,6 +124,7 @@ func (s *MockServer) handleGet(w http.ResponseWriter, r *http.Request) {
 	if _, err := w.Write(content); err != nil {
 		s.log.Error(err, "Failed to write response")
 	}
+
 }
 
 func (s *MockServer) handlePost(w http.ResponseWriter, r *http.Request) {
@@ -135,6 +144,66 @@ func (s *MockServer) handlePost(w http.ResponseWriter, r *http.Request) {
 	case strings.Contains(urlPath, "UpdateService/Actions/UpdateService.SimpleUpdate"):
 		s.writeJSON(w, http.StatusAccepted, map[string]string{"status": "Accepted"})
 	default:
+		//
+		urlPath := resolvePath(r.URL.Path)
+		var update map[string]any
+		if err := json.Unmarshal(body, &update); err != nil {
+			http.Error(w, "Invalid JSON", http.StatusBadRequest)
+			return
+		}
+		// Handle resource creation in collections
+		s.mu.Lock()
+		defer s.mu.Unlock()
+		cached, hasOverride := s.overrides[urlPath]
+		var base Collection
+		if hasOverride {
+			s.log.Info("Using overridden data for POST", "path", urlPath)
+			var ok bool
+			base, ok = cached.(Collection)
+			if !ok {
+				http.Error(w, "Corrupt overridden JSON", http.StatusInternalServerError)
+				return
+			}
+		} else {
+			s.log.Info("Using embedded data for POST", "path", urlPath)
+			data, err := dataFS.ReadFile(urlPath)
+			if err != nil {
+				s.log.Error(err, "Failed to read embedded data for POST", "path", urlPath)
+				http.NotFound(w, r)
+				return
+			}
+			if err := json.Unmarshal(data, &base); err != nil {
+				http.Error(w, "Corrupt embedded JSON", http.StatusInternalServerError)
+				return
+			}
+		}
+		// If resource collection (has "Members"), add a new member
+		if len(base.Members) > 0 {
+			newID := fmt.Sprintf("%d", len(base.Members)+1)
+			location := path.Join(r.URL.Path, newID)
+			newMemberPath := resolvePath(location)
+			base.Members = append(base.Members, Member{
+				OdataID: location,
+			})
+			s.log.Info("Adding new member", "id", newID, "location", location, "memberPath", newMemberPath)
+			if strings.HasSuffix(r.URL.Path, "/Subscriptions") {
+				w.Header().Set("Location", location)
+			}
+			s.overrides[urlPath] = base
+			s.overrides[newMemberPath] = update
+		} else {
+			base.Members = make([]Member, 0)
+			location := r.URL.JoinPath("1").String()
+			base.Members = []Member{
+				{
+					OdataID: r.URL.JoinPath("1").String(),
+				},
+			}
+			s.overrides[urlPath] = base
+			if strings.HasSuffix(r.URL.Path, "/Subscriptions") {
+				w.Header().Set("Location", location)
+			}
+		}
 		s.writeJSON(w, http.StatusCreated, map[string]string{"status": "created"})
 	}
 }
@@ -178,22 +247,53 @@ func (s *MockServer) handlePatch(w http.ResponseWriter, r *http.Request) {
 
 func (s *MockServer) handleDelete(w http.ResponseWriter, r *http.Request) {
 	filePath := resolvePath(r.URL.Path)
-
 	base, err := s.loadResource(filePath)
 	if err != nil {
 		s.handleError(w, r, err)
 		return
 	}
-
 	if _, isCollection := base["Members"]; isCollection {
 		http.Error(w, "Method Not Allowed", http.StatusMethodNotAllowed)
 		return
 	}
-
 	s.mu.Lock()
 	delete(s.overrides, filePath)
 	s.mu.Unlock()
 
+	// get collection of the resource
+	collectionPath := path.Dir(filePath)
+	cached, hasOverride := s.overrides[collectionPath]
+	var collection Collection
+	if hasOverride {
+		var ok bool
+		collection, ok = cached.(Collection)
+		if !ok {
+			http.Error(w, "Corrupt embedded JSON", http.StatusInternalServerError)
+			return
+		}
+	} else {
+		data, err := dataFS.ReadFile(collectionPath + "/index.json")
+		if err != nil {
+			http.NotFound(w, r)
+			return
+		}
+		if err := json.Unmarshal(data, &collection); err != nil {
+			http.Error(w, "Corrupt embedded JSON", http.StatusInternalServerError)
+			return
+		}
+	}
+	// remove member from collection
+	newMembers := make([]Member, 0)
+	for _, member := range collection.Members {
+		if member.OdataID != r.URL.Path {
+			newMembers = append(newMembers, member)
+		}
+	}
+	s.log.Info("Removing member from collection", "members", newMembers, "collection", collectionPath)
+	collection.Members = newMembers
+	s.mu.Lock()
+	s.overrides[collectionPath] = collection
+	s.mu.Unlock()
 	w.WriteHeader(http.StatusNoContent)
 }
 

bmc/redfish.go

@@ -12,6 +12,7 @@ import (
 	"io"
 	"maps"
 	"math/big"
+	"net/url"
 	"slices"
 	"strings"
 	"time"
@@ -975,3 +976,89 @@ func shuffleRunes(a []rune) error {
 	}
 	return nil
 }
+
+type subscriptionPayload struct {
+	Destination         string                           `json:"Destination,omitempty"`
+	EventTypes          []schemas.EventType              `json:"EventTypes,omitempty"`
+	EventFormatType     schemas.EventFormatType          `json:"EventFormatType,omitempty"`
+	RegistryPrefixes    []string                         `json:"RegistryPrefixes,omitempty"`
+	ResourceTypes       []string                         `json:"ResourceTypes,omitempty"`
+	DeliveryRetryPolicy schemas.DeliveryRetryPolicy      `json:"DeliveryRetryPolicy,omitempty"`
+	HTTPHeaders         map[string]string                `json:"HttpHeaders,omitempty"`
+	Oem                 any                              `json:"Oem,omitempty"`
+	Protocol            schemas.EventDestinationProtocol `json:"Protocol,omitempty"`
+	Context             string                           `json:"Context,omitempty"`
+}
+
+func (r *RedfishBaseBMC) CreateEventSubscription(
+	ctx context.Context,
+	destination string,
+	eventFormatType schemas.EventFormatType,
+	retry schemas.DeliveryRetryPolicy,
+) (string, error) {
+	service := r.client.GetService()
+	ev, err := service.EventService()
+	if err != nil {
+		return "", fmt.Errorf("failed to get event service: %w", err)
+	}
+	if !ev.ServiceEnabled {
+		return "", fmt.Errorf("event service is not enabled")
+	}
+	payload := &subscriptionPayload{
+		Destination:         destination,
+		EventFormatType:     eventFormatType, // event or metricreport
+		Protocol:            schemas.RedfishEventDestinationProtocol,
+		DeliveryRetryPolicy: retry,
+		Context:             "metal-operator",
+	}
+	client := ev.GetClient()
+	// some implementations (like Dell) do not support ResourceTypes and RegistryPrefixes
+	if len(ev.ResourceTypes) == 0 {
+		payload.EventTypes = []schemas.EventType{}
+	} else {
+		payload.RegistryPrefixes = []string{""} // Filters by the prefix of the event's MessageId, which points to a Message Registry: [Base, ResourceEvent, iLOEvents]
+		payload.ResourceTypes = []string{""}    // Filters by the schema name (Resource Type) of the event's OriginOfCondition:	[Chassis, ComputerSystem, Power]
+	}
+	resp, err := client.Post(ev.SubscriptionsLink, payload)
+	if err != nil {
+		return "", err
+	}
+	defer func() {
+		_ = resp.Body.Close()
+	}()
+	if resp.StatusCode < 200 || resp.StatusCode >= 300 {
+		return "", fmt.Errorf("failed to create event subscription status code: %d", resp.StatusCode)
+	}
+	// return subscription link from returned location
+	subscriptionLink := resp.Header.Get("Location")
+	if subscriptionLink == "" {
+		return "", fmt.Errorf("failed to get subscription link from response header")
+	}
+	urlParser, err := url.ParseRequestURI(subscriptionLink)
+	if err == nil {
+		subscriptionLink = urlParser.RequestURI()
+	}
+	return subscriptionLink, nil
+}
+
+func (r *RedfishBaseBMC) DeleteEventSubscription(ctx context.Context, uri string) error {
+	service := r.client.GetService()
+	ev, err := service.EventService()
+	if err != nil {
+		return fmt.Errorf("failed to get event service: %w", err)
+	}
+	if !ev.ServiceEnabled {
+		return fmt.Errorf("event service is not enabled")
+	}
+	event, err := ev.GetEventSubscription(uri)
+	if err != nil {
+		return fmt.Errorf("failed to get event subscription: %w", err)
+	}
+	if event == nil {
+		return nil
+	}
+	if err := ev.DeleteEventSubscription(uri); err != nil {
+		return fmt.Errorf("failed to delete event subscription: %w", err)
+	}
+	return nil
+}

cmd/main.go

@@ -14,6 +14,7 @@ import (
 
 	"github.com/ironcore-dev/controller-utils/conditionutils"
 	"github.com/ironcore-dev/metal-operator/internal/cmd/dns"
+	"github.com/ironcore-dev/metal-operator/internal/serverevents"
 	webhookv1alpha1 "github.com/ironcore-dev/metal-operator/internal/webhook/v1alpha1"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 
@@ -76,6 +77,9 @@ func main() { // nolint: gocyclo
 		registryPort                       int
 		registryProtocol                   string
 		registryURL                        string
+		eventPort                          int
+		eventURL                           string
+		eventProtocol                      string
 		registryResyncInterval             time.Duration
 		webhookPort                        int
 		enforceFirstBoot                   bool
@@ -125,6 +129,10 @@ func main() { // nolint: gocyclo
 	flag.StringVar(&registryURL, "registry-url", "", "The URL of the registry.")
 	flag.StringVar(&registryProtocol, "registry-protocol", "http", "The protocol to use for the registry.")
 	flag.IntVar(&registryPort, "registry-port", 10000, "The port to use for the registry.")
+	flag.StringVar(&eventURL, "event-url", "", "The URL of the server events endpoint for alerts and metrics.")
+	flag.IntVar(&eventPort, "event-port", 10001, "The port to use for the server events endpoint for alerts and metrics.")
+	flag.StringVar(&eventProtocol, "event-protocol", "http",
+		"The protocol to use for the server events endpoint for alerts and metrics.")
 	flag.StringVar(&probeImage, "probe-image", "", "Image for the first boot probing of a Server.")
 	flag.StringVar(&probeOSImage, "probe-os-image", "", "OS image for the first boot probing of a Server.")
 	flag.StringVar(&managerNamespace, "manager-namespace", "default", "Namespace the manager is running in.")
@@ -210,6 +218,17 @@ func main() { // nolint: gocyclo
 		registryURL = fmt.Sprintf("%s://%s:%d", registryProtocol, registryAddr, registryPort)
 	}
 
+	// set the correct event URL by getting the address from the environment
+	var eventAddr string
+	if eventURL == "" {
+		eventAddr = os.Getenv("EVENT_ADDRESS")
+		if eventAddr == "" {
+			setupLog.Error(nil, "failed to set the event URL as no address is provided")
+		} else {
+			eventURL = fmt.Sprintf("%s://%s:%d", eventProtocol, eventAddr, eventPort)
+		}
+	}
+
 	// if the enable-http2 flag is false (the default), http/2 should be disabled
 	// due to its vulnerabilities. More specifically, disabling http/2 will
 	// prevent from being vulnerable to the HTTP/2 Stream Cancelation and
@@ -355,6 +374,7 @@ func main() { // nolint: gocyclo
 		BMCResetWaitTime:       bmcResetWaitingInterval,
 		BMCClientRetryInterval: bmcResetResyncInterval,
 		ManagerNamespace:       managerNamespace,
+		EventURL:               eventURL,
 		DNSRecordTemplate:      dnsRecordTemplate,
 		Conditions:             conditionutils.NewAccessor(conditionutils.AccessorOptions{}),
 		BMCOptions: bmc.Options{
@@ -615,6 +635,21 @@ func main() { // nolint: gocyclo
 		os.Exit(1)
 	}
 
+	if eventURL != "" {
+		if err := mgr.Add(manager.RunnableFunc(func(ctx context.Context) error {
+			setupLog.Info("starting event server for alerts and metrics", "EventURL", eventURL)
+			eventServer := serverevents.NewServer(setupLog, fmt.Sprintf(":%d", eventPort))
+			if err := eventServer.Start(ctx); err != nil {
+				return fmt.Errorf("unable to start event server: %w", err)
+			}
+			<-ctx.Done()
+			return nil
+		})); err != nil {
+			setupLog.Error(err, "unable to add event runnable to manager")
+			os.Exit(1)
+		}
+	}
+
 	setupLog.Info("Starting manager")
 	if err := mgr.Start(ctx); err != nil {
 		setupLog.Error(err, "Failed to run manager")

config/crd/bases/metal.ironcore.dev_bmcs.yaml

@@ -246,6 +246,10 @@ spec:
                   - type
                   type: object
                 type: array
+              eventsSubscriptionLink:
+                description: EventsSubscriptionLink is the link to the events subscription
+                  of the bmc.
+                type: string
               firmwareVersion:
                 description: FirmwareVersion is the version of the firmware currently
                   running on the BMC.
@@ -265,6 +269,10 @@ spec:
               manufacturer:
                 description: Manufacturer is the name of the BMC manufacturer.
                 type: string
+              metricsReportSubscriptionLink:
+                description: MetricsReportSubscriptionLink is the link to the metrics
+                  report subscription of the bmc.
+                type: string
               model:
                 description: Model is the model number or name of the BMC.
                 type: string