kube

Documentation

Index

• Constants
• func NewRunnableJob(clientset kubernetes.Interface, spec *batch.Job) runner.Runnable
• type CRManager
  • func NewCRManager(clientset kubernetes.Interface, ...) CRManager
• type ScannerOpts
• type Workload
  • func (t Workload) String() string
• type WorkloadKind
  • func WorkloadKindFromString(s string) (WorkloadKind, error)
  • func (t WorkloadKind) String() string

Constants

const (
	NamespaceStarboard = "starboard"
	// ServiceAccountPolaris the name of the ServiceAccount used to run Polaris scan Jobs.
	ServiceAccountPolaris = "polaris"
	ConfigMapPolaris      = "polaris"
)

const (
	LabelResourceKind  = "starboard.resource.kind"
	LabelResourceName  = "starboard.resource.name"
	LabelContainerName = "starboard.container.name"

	LabelScannerName   = "starboard.scanner.name"
	LabelScannerVendor = "starboard.scanner.vendor"

	LabelHistoryLatest = "starboard.history.latest"
)

const (
	AnnotationHistoryLimit = "starboard.history.limit"
)

Functions

func NewRunnableJob

func NewRunnableJob(clientset kubernetes.Interface, spec *batch.Job) runner.Runnable

NewRunnableJob constructs a new Runnable task which runs a Kubernetes Job with the given spec and waits for the completion or failure.

Types

type CRManager

type CRManager interface {
	Init(ctx context.Context) error
	Cleanup(ctx context.Context) error
}

TODO This is no longer CRManager as we're creating other resources, such as ClusterRoles and ConfigMaps CRManager defined methods for managing Kubernetes custom resources.

func NewCRManager

func NewCRManager(clientset kubernetes.Interface, clientsetext extapi.ApiextensionsV1beta1Interface) CRManager

NewCRManager constructs a CRManager with the given Kubernetes interface.

type ScannerOpts

type ScannerOpts struct {
	ScanJobTimeout time.Duration
	DeleteScanJob  bool
}

ScannerOpts holds configuration of the vulnerability Scanner.

type Workload

type Workload struct {
	Namespace string
	Kind      WorkloadKind
	Name      string
}

func (Workload) String

func (t Workload) String() string

type WorkloadKind

type WorkloadKind int

WorkloadKind is an enum defining the different kinds of Kubernetes workloads.

const (
	WorkloadKindUnknown WorkloadKind = iota
	WorkloadKindPod
	WorkloadKindReplicaSet
	WorkloadKindReplicationController
	WorkloadKindDeployment
	WorkloadKindStatefulSet
	WorkloadKindDaemonSet
	WorkloadKindCronJob
	WorkloadKindJob
)

func WorkloadKindFromString

func WorkloadKindFromString(s string) (WorkloadKind, error)

func (WorkloadKind) String

func (t WorkloadKind) String() string