dashboard

package
v1.17.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 13, 2026 License: BSD-3-Clause Imports: 3 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionItem

type ActionItem struct {
	// Kind identifies the type of dashboard action item.
	//
	// Required: true
	Kind ActionItemKind `json:"kind"`

	// Count is the number of impacted resources for this action item.
	//
	// Required: true
	Count int `json:"count"`

	// Severity indicates urgency for the action item.
	//
	// Required: true
	Severity ActionItemSeverity `json:"severity"`
}

type ActionItemKind

type ActionItemKind string
const (
	ActionItemKindStoppedContainers         ActionItemKind = "stopped_containers"
	ActionItemKindImageUpdates              ActionItemKind = "image_updates"
	ActionItemKindActionableVulnerabilities ActionItemKind = "actionable_vulnerabilities"
	ActionItemKindExpiringKeys              ActionItemKind = "expiring_keys"
)

type ActionItemSeverity

type ActionItemSeverity string
const (
	ActionItemSeverityWarning  ActionItemSeverity = "warning"
	ActionItemSeverityCritical ActionItemSeverity = "critical"
)

type ActionItems

type ActionItems struct {
	// Items is the list of action items requiring attention.
	//
	// Required: true
	Items []ActionItem `json:"items"`
}

type Snapshot added in v1.17.0

type Snapshot struct {
	// Containers is the dashboard container table payload.
	//
	// Required: true
	Containers SnapshotContainers `json:"containers"`

	// Images is the dashboard image table payload.
	//
	// Required: true
	Images SnapshotImages `json:"images"`

	// ImageUsageCounts is the dashboard image usage summary.
	//
	// Required: true
	ImageUsageCounts imagetypes.UsageCounts `json:"imageUsageCounts"`

	// ActionItems is the dashboard attention summary.
	//
	// Required: true
	ActionItems ActionItems `json:"actionItems"`

	// Settings is the minimal settings payload needed by the dashboard.
	//
	// Required: true
	Settings SnapshotSettings `json:"settings"`
}

type SnapshotContainers added in v1.17.0

type SnapshotContainers struct {
	// Data is the first dashboard page of container summaries.
	//
	// Required: true
	Data []containertypes.Summary `json:"data"`

	// Counts is the full-environment container status summary.
	//
	// Required: true
	Counts containertypes.StatusCounts `json:"counts"`

	// Pagination describes the fixed first dashboard page.
	//
	// Required: true
	Pagination base.PaginationResponse `json:"pagination"`
}

type SnapshotImages added in v1.17.0

type SnapshotImages struct {
	// Data is the first dashboard page of image summaries.
	//
	// Required: true
	Data []imagetypes.Summary `json:"data"`

	// Pagination describes the fixed first dashboard page.
	//
	// Required: true
	Pagination base.PaginationResponse `json:"pagination"`
}

type SnapshotSettings added in v1.17.0

type SnapshotSettings struct {
	// DockerPruneMode controls whether prune defaults to all or dangling images.
	//
	// Required: true
	DockerPruneMode string `json:"dockerPruneMode"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL