feat(events): add events extension (#3045)

* feat: add events config Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat: implement event support with log sink Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat: integrate events and update tests Signed-off-by: Piaras Hoban <phoban01@gmail.com> * refactor: update event config Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat: implement http and nats sinks. remove log sink Signed-off-by: Piaras Hoban <phoban01@gmail.com> * refactor: events extension setup Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: cleanup tests to use nil event recorder Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: update events config example and add more logging Signed-off-by: Piaras Hoban <phoban01@gmail.com> * refactor: better use of build tags for minimal binary Signed-off-by: Piaras Hoban <phoban01@gmail.com> * fix: missing store param in evelated privileges tests Signed-off-by: Piaras Hoban <phoban01@gmail.com> * fix: regression in config decoding Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: update check logs script to enable cross-platform usage via GREP_BIN_PATH envvar Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: fix log lint issue for events Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: fix failing events disabled test Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: add blackbox tests for events Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: specify architecture when downloading binaries in Makefile Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: improve failure handling when no valid sinks are provided Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: fix data race in events test Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: cleanup event decoding Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: fix logging tests Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: make nats server test more reliable Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: go mod cleanup Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: add sleep when setting up nats client Signed-off-by: Piaras Hoban <phoban01@gmail.com> * fix: ensure event sink errors do not propogate Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: increase coverage for events Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat(events): Refactor events to be non-blocking from caller. Signed-off-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no> Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: remove harded-coded linux Co-authored-by: Andrei Aaron <andreifdaaron@gmail.com> Signed-off-by: Piaras Hoban <phoban01@gmail.com> * feat(events): fail to start if incorrect event sink is configured Signed-off-by: Piaras Hoban <phoban01@gmail.com> * test: allow cli tests to return errors instead of panic Signed-off-by: Piaras Hoban <phoban01@gmail.com> * chore: bump nats server to v2.11.3 Signed-off-by: Piaras Hoban <phoban01@gmail.com> --------- Signed-off-by: Piaras Hoban <phoban01@gmail.com> Signed-off-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no> Co-authored-by: Asgeir Nilsen <asgeir.nilsen@bouvet.no> Co-authored-by: Andrei Aaron <andreifdaaron@gmail.com>
2026-06-19 22:27:58 +08:00 · 2025-05-02 20:30:06 +01:00
parent 06a0cd5220
commit bc5fd1a357
63 changed files with 2907 additions and 306 deletions
@@ -3,6 +3,7 @@ package config
 import (
 	"time"

+	"zotregistry.dev/zot/pkg/extensions/config/events"
 	"zotregistry.dev/zot/pkg/extensions/config/sync"
 )

@@ -21,6 +22,7 @@ type ExtensionConfig struct {
 	Mgmt    *MgmtConfig
 	APIKey  *APIKeyConfig
 	Trust   *ImageTrustConfig
+	Events  *events.Config
 }

 type ImageTrustConfig struct {
@@ -0,0 +1,55 @@
+package events
+
+import (
+	"time"
+)
+
+type SinkType string
+
+func (s SinkType) String() string {
+	return string(s)
+}
+
+const (
+	HTTP SinkType = "http"
+	NATS SinkType = "nats"
+)
+
+func IsSupportedSink(sinkType SinkType) bool {
+	supportedSinks := map[SinkType]struct{}{
+		HTTP: {},
+		NATS: {},
+	}
+
+	_, ok := supportedSinks[sinkType]
+
+	return ok
+}
+
+// Config holds configuration for the events extension.
+type Config struct {
+	Enable *bool
+	Sinks  []SinkConfig
+}
+
+type SinkConfig struct {
+	*Credentials
+	*TLSConfig
+	Type    SinkType
+	Address string
+	Channel string
+	Timeout time.Duration
+	Proxy   *string
+}
+
+type Credentials struct {
+	Username string
+	Password string
+	File     *string
+}
+
+type TLSConfig struct {
+	CACertFile string
+	CertFile   string
+	KeyFile    string
+}
@@ -0,0 +1,52 @@
+package events
+
+import (
+	"reflect"
+
+	"github.com/mitchellh/mapstructure"
+
+	zerr "zotregistry.dev/zot/errors"
+)
+
+// SinkConfigDecoderHook provides a mapstructure hook for decoding SinkConfig interfaces.
+func SinkConfigDecoderHook() mapstructure.DecodeHookFunc {
+	return func(_ reflect.Type, target reflect.Type, data interface{}) (interface{}, error) {
+		// Only apply this hook when converting to SinkConfig
+		if target.Name() != "SinkConfig" {
+			return data, nil
+		}
+
+		if target != reflect.TypeOf((*SinkConfig)(nil)).Elem() {
+			return data, nil
+		}
+
+		dataMap, ok := data.(map[string]interface{})
+		if !ok {
+			return data, nil
+		}
+
+		config := &SinkConfig{}
+
+		decoderConfig := &mapstructure.DecoderConfig{
+			DecodeHook:       mapstructure.StringToTimeDurationHookFunc(),
+			Result:           config,
+			WeaklyTypedInput: true,
+			TagName:          "mapstructure",
+		}
+
+		decoder, err := mapstructure.NewDecoder(decoderConfig)
+		if err != nil {
+			return nil, err
+		}
+
+		if err := decoder.Decode(dataMap); err != nil {
+			return nil, err
+		}
+
+		if !IsSupportedSink(config.Type) {
+			return nil, zerr.ErrUnsupportedEventSink
+		}
+
+		return config, nil
+	}
+}