starboard

Documentation

Index

• Constants
• func GetVersionFromImageRef(imageRef string) (string, error)
• type BuildInfo
• type ConfigData
  • func GetDefaultConfig() ConfigData
  • func (c ConfigData) GetKubeBenchImageRef() string
  • func (c ConfigData) GetTrivyImageRef() string
• type ConfigReader
  • func NewConfigReader(client kubernetes.Interface) ConfigReader

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.

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

type ConfigReader

type ConfigReader interface {
	Read(ctx context.Context) (ConfigData, error)
}

func NewConfigReader

func NewConfigReader(client kubernetes.Interface) ConfigReader

NewConfigReader constructs a new ConfigReader that is using client-go interfaces to read ConfigData from the ConfigMap.