trivyk8s

Documentation

Index

• func BomToArtifacts(b *bom.Result) ([]*artifacts.Artifact, error)
• type ArtifactsK8S
• type K8sOption
  • func WithExcludeOwned(excludeOwned bool) K8sOption
• type NodeCollectorOption
  • func WithIgnoreLabels(ignoreLabels map[string]string) NodeCollectorOption
  • func WithNodeConfig(nodeConfig bool) NodeCollectorOption
  • func WithScanJobImageRef(imageRef string) NodeCollectorOption
  • func WithScanJobNamespace(namespace string) NodeCollectorOption
  • func WithTolerations(toleration []corev1.Toleration) NodeCollectorOption
• type TrivyK8S
  • func New(cluster k8s.Cluster, logger *zap.SugaredLogger, opts ...K8sOption) TrivyK8S

Functions

func BomToArtifacts

func BomToArtifacts(b *bom.Result) ([]*artifacts.Artifact, error)

Types

type ArtifactsK8S

type ArtifactsK8S interface {
	// ListArtifacts returns kubernetes scanable artifacts
	ListArtifacts(context.Context) ([]*artifacts.Artifact, error)
	// GetArtifact return kubernete scanable artifact
	GetArtifact(context.Context, string, string) (*artifacts.Artifact, error)
	// ListArtifactAndNodeInfo return kubernete scanable artifact and node info
	ListArtifactAndNodeInfo(context.Context, ...NodeCollectorOption) ([]*artifacts.Artifact, error)
	// ListClusterBomInfo returns kubernetes Bom (node,core components) information.
	ListClusterBomInfo(context.Context) ([]*artifacts.Artifact, error)
}

ArtifactsK8S interface represents operations to query the artifacts

type K8sOption

type K8sOption func(*client)

func WithExcludeOwned

func WithExcludeOwned(excludeOwned bool) K8sOption

type NodeCollectorOption

type NodeCollectorOption func(*client)

func WithIgnoreLabels

func WithIgnoreLabels(ignoreLabels map[string]string) NodeCollectorOption

func WithNodeConfig

func WithNodeConfig(nodeConfig bool) NodeCollectorOption

func WithScanJobImageRef

func WithScanJobImageRef(imageRef string) NodeCollectorOption

func WithScanJobNamespace

func WithScanJobNamespace(namespace string) NodeCollectorOption

func WithTolerations

func WithTolerations(toleration []corev1.Toleration) NodeCollectorOption

type TrivyK8S

type TrivyK8S interface {
	Namespace(string) TrivyK8S
	AllNamespaces() TrivyK8S
	Resources(string) TrivyK8S
	ArtifactsK8S
}

TrivyK8S interface represents the operations supported by the library

func New

func New(cluster k8s.Cluster, logger *zap.SugaredLogger, opts ...K8sOption) TrivyK8S

New creates a trivyK8S client