starboard

Documentation

Index

• Constants
• func GetVersionFromImageRef(imageRef string) (string, error)
• func NewScheme() *runtime.Scheme
• type BuildInfo
• type ConfigData
  • func GetDefaultConfig() ConfigData
  • func (c ConfigData) GetKubeBenchImageRef() string
  • func (c ConfigData) GetTrivyImageRef() string
  • func (c ConfigData) GetTrivyMode() TrivyMode
  • func (c ConfigData) GetTrivyServerURL() string
• type ConfigManager
  • func NewConfigManager(client kubernetes.Interface, namespace string) ConfigManager
• type TrivyConfig
• type TrivyMode

Constants

const (
	// NamespaceName the name of the namespace in which Starboard stores its
	// configuration and runs scan Jobs.
	NamespaceName = "starboard"

	// ServiceAccountName the name of the ServiceAccount used to run scan Jobs.
	ServiceAccountName = "starboard"

	// ConfigMapName the name of the ConfigMap that stored configuration of
	// Starboard and the underlying scanners.
	ConfigMapName = "starboard"
)

Functions

func GetVersionFromImageRef

func GetVersionFromImageRef(imageRef string) (string, error)

GetVersionFromImageRef returns the image identifier for the specified image reference.

func NewScheme

func NewScheme() *runtime.Scheme

Types

type BuildInfo

type BuildInfo struct {
	Version string
	Commit  string
	Date    string
}

BuildInfo holds build info such as Git revision, Git SHA-1, and build datetime.

type ConfigData

type ConfigData map[string]string

ConfigData holds Starboard configuration settings as a set of key-value pairs.

func GetDefaultConfig

func GetDefaultConfig() ConfigData

GetDefaultConfig returns the default configuration data.

func (ConfigData) GetKubeBenchImageRef

func (c ConfigData) GetKubeBenchImageRef() string

GetKubeBenchImageRef returns Docker image of kube-bench scanner.

func (ConfigData) GetTrivyImageRef

func (c ConfigData) GetTrivyImageRef() string

func (ConfigData) GetTrivyMode

func (c ConfigData) GetTrivyMode() TrivyMode

func (ConfigData) GetTrivyServerURL

func (c ConfigData) GetTrivyServerURL() string

type ConfigManager

type ConfigManager interface {
	EnsureDefault(ctx context.Context) error
	Read(ctx context.Context) (ConfigData, error)
	Delete(ctx context.Context) error
}

ConfigManager defines methods for managing ConfigData.

func NewConfigManager

func NewConfigManager(client kubernetes.Interface, namespace string) ConfigManager

NewConfigManager constructs a new ConfigManager that is using kubernetes.Interface to manage ConfigData backed by the the ConfigMap stored in the specified namespace.

type TrivyConfig

type TrivyConfig interface {
	GetTrivyImageRef() string
	GetTrivyMode() TrivyMode
	GetTrivyServerURL() string
}

type TrivyMode

type TrivyMode string

TrivyMode describes mode in which Trivy client operates.

const (
	Standalone   TrivyMode = "Standalone"
	ClientServer TrivyMode = "ClientServer"
)