Extend CustomBoard with filters (#484)

Signed-off-by: Frank Jogeleit <[email protected]>

Author: fjogeleit

backend/pkg/config/config.go

@@ -205,10 +205,21 @@ type Boards struct {
 	AccessControl AccessControl `koanf:"accessControl"`
 }
 
+type Filter struct {
+	NamespaceKinds []string `koanf:"namespaceKinds"`
+	ClusterKinds   []string `koanf:"clusterKinds"`
+	Results        []string `koanf:"results"`
+	Severities     []string `koanf:"severities"`
+}
+
 type CustomBoard struct {
 	Name          string        `koanf:"name"`
 	AccessControl AccessControl `koanf:"accessControl"`
-	Namespaces    struct {
+	Filter        struct {
+		Include Filter `koanf:"include"`
+	} `koanf:"filter"`
+	Display    string `json:"display"`
+	Namespaces struct {
 		Selector map[string]string `koanf:"selector"`
 		List     []string          `koanf:"list"`
 	} `koanf:"namespaces"`

backend/pkg/config/mapper.go

@@ -73,8 +73,10 @@ func MapCustomBoards(customBoards []CustomBoard) map[string]api.CustomBoard {
 		id := slug.Make(c.Name)
 
 		configs[id] = api.CustomBoard{
-			Name: c.Name,
-			ID:   id,
+			Name:    c.Name,
+			ID:      id,
+			Display: c.Display,
+			Filter:  MapFilter(c.Filter.Include),
 			Namespaces: api.Namespaces{
 				Selector: c.Namespaces.Selector,
 				List:     c.Namespaces.List,
@@ -105,3 +107,25 @@ func MapClusterPermissions(c *Config) map[string]auth.Permissions {
 
 	return permissions
 }
+
+func MapFilter(f Filter) api.Includes {
+	if f.NamespaceKinds == nil {
+		f.NamespaceKinds = make([]string, 0)
+	}
+	if f.ClusterKinds == nil {
+		f.ClusterKinds = make([]string, 0)
+	}
+	if f.Results == nil {
+		f.Results = make([]string, 0)
+	}
+	if f.Severities == nil {
+		f.Severities = make([]string, 0)
+	}
+
+	return api.Includes{
+		NamespaceKinds: f.NamespaceKinds,
+		ClusterKinds:   f.ClusterKinds,
+		Results:        f.Results,
+		Severities:     f.Severities,
+	}
+}

backend/pkg/server/api/handler.go

@@ -199,6 +199,11 @@ func (h *Handler) GetCustomBoard(ctx *gin.Context) {
 			SingleSource:   len(sources) == 1,
 			MultipleSource: len(sources) > 1,
 			Namespaces:     make([]string, 0),
+			Display:        config.Display,
+			Severities:     config.Filter.Severities,
+			Status:         config.Filter.Results,
+			NamespaceKinds: config.Filter.NamespaceKinds,
+			ClusterKinds:   config.Filter.ClusterKinds,
 			Charts: service.Charts{
 				ClusterScope:   make(map[string]map[string]int),
 				NamespaceScope: make(map[string]*service.ChartVariants),
@@ -210,7 +215,17 @@ func (h *Handler) GetCustomBoard(ctx *gin.Context) {
 
 	query["namespaces"] = namespaces
 
-	dashboard, err := h.service.Dashboard(ctx, ctx.Param("cluster"), sources, namespaces, config.ClusterScope, query)
+	dashboard, err := h.service.Dashboard(ctx, service.DashboardOptions{
+		Cluster:        ctx.Param("cluster"),
+		Sources:        sources,
+		Namespaces:     namespaces,
+		Display:        config.Display,
+		ClusterScope:   config.ClusterScope,
+		Status:         config.Filter.Results,
+		Severities:     config.Filter.Severities,
+		NamespaceKinds: config.Filter.NamespaceKinds,
+		ClusterKinds:   config.Filter.ClusterKinds,
+	}, query)
 	if err != nil {
 		zap.L().Error("failed to generate dashboard", zap.Error(err))
 		ctx.AbortWithStatus(http.StatusInternalServerError)
@@ -322,7 +337,12 @@ func (h *Handler) Dashboard(ctx *gin.Context) {
 		return
 	}
 
-	dashboard, err := h.service.Dashboard(ctx, ctx.Param("cluster"), sources, namespaces, true, ctx.Request.URL.Query())
+	dashboard, err := h.service.Dashboard(ctx, service.DashboardOptions{
+		Cluster:      ctx.Param("cluster"),
+		Sources:      sources,
+		Namespaces:   namespaces,
+		ClusterScope: true,
+	}, ctx.Request.URL.Query())
 	if err != nil {
 		zap.L().Error("failed to generate dashboard", zap.Error(err))
 		ctx.AbortWithStatus(http.StatusInternalServerError)

backend/pkg/server/api/model.go

@@ -27,6 +27,13 @@ type Excludes struct {
 	Severities     []string `json:"severities"`
 }
 
+type Includes struct {
+	NamespaceKinds []string `json:"namespaceKinds"`
+	ClusterKinds   []string `json:"clusterKinds"`
+	Results        []string `json:"results"`
+	Severities     []string `json:"severities"`
+}
+
 type Source struct {
 	Name       string   `json:"name"`
 	ViewType   string   `mapstructure:"type"`
@@ -58,6 +65,8 @@ type CustomBoard struct {
 	auth.Permissions `json:"-"`
 	Name             string        `json:"name"`
 	ID               string        `json:"id"`
+	Display          string        `json:"display"`
+	Filter           Includes      `json:"filter"`
 	ClusterScope     bool          `json:"-"`
 	Namespaces       Namespaces    `json:"-"`
 	Sources          Sources       `json:"-"`

backend/pkg/service/model.go

@@ -56,6 +56,7 @@ type Total struct {
 type Dashboard struct {
 	Title          string       `json:"title"`
 	Type           string       `json:"type"`
+	Display        string       `json:"display"`
 	FilterSources  []string     `json:"filterSources,omitempty"`
 	ClusterScope   bool         `json:"clusterScope"`
 	Sources        []string     `json:"sources"`
@@ -69,6 +70,8 @@ type Dashboard struct {
 	ShowResults    []string     `json:"showResults"`
 	Status         []string     `json:"status"`
 	Severities     []string     `json:"severities"`
+	NamespaceKinds []string     `json:"namespaceKinds"`
+	ClusterKinds   []string     `json:"clusterKinds"`
 }
 
 type ResourceDetails struct {
@@ -152,3 +155,15 @@ type ExceptionRequest struct {
 	Category string            `json:"category"`
 	Policies []ExceptionPolicy `json:"policies"`
 }
+
+type DashboardOptions struct {
+	Status         []string
+	Severities     []string
+	Sources        []string
+	Namespaces     []string
+	NamespaceKinds []string
+	ClusterKinds   []string
+	Cluster        string
+	Display        string
+	ClusterScope   bool
+}