tunnelk8s

Documentation

Index

• func BomToArtifacts(b *bom.Result) ([]*artifacts.Artifact, error)
• func FilterResources(include []string, exclude []string, key string) bool
• type ArtifactsK8S
• type K8sOption
  • func WithExcludeKinds(excludeKinds []string) K8sOption
  • func WithExcludeNamespaces(excludeNamespaces []string) K8sOption
  • func WithExcludeOwned(excludeOwned bool) K8sOption
  • func WithIncludeKinds(includeKinds []string) K8sOption
  • func WithIncludeNamespaces(includeNamespaces []string) K8sOption
• type NodeCollectorOption
  • func WithAffinity(affinity *corev1.Affinity) NodeCollectorOption
  • func WithCommandPaths(commandPaths []string) NodeCollectorOption
  • func WithEmbeddedCommandFileSystem(commandsFileSystem embed.FS) NodeCollectorOption
  • func WithEmbeddedNodeConfigFilesystem(nodeConfigFileSystem embed.FS) NodeCollectorOption
  • func WithIgnoreLabels(ignoreLabels map[string]string) NodeCollectorOption
  • func WithNodeConfig(nodeConfig bool) NodeCollectorOption
  • func WithScanJobImageRef(imageRef string) NodeCollectorOption
  • func WithScanJobNamespace(namespace string) NodeCollectorOption
  • func WithSpecCommandIds(specCommandIds []string) NodeCollectorOption
  • func WithTolerations(tolerations []corev1.Toleration) NodeCollectorOption
• type TunnelK8S
  • func New(cluster k8s.Cluster, opts ...K8sOption) TunnelK8S

Functions

func BomToArtifacts

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

func FilterResources

func FilterResources(include []string, exclude []string, key string) bool

Types

type ArtifactsK8S

type ArtifactsK8S interface {
	// ListArtifacts returns kubernetes scanable artifacts
	ListArtifacts(context.Context) ([]*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 WithExcludeKinds

func WithExcludeKinds(excludeKinds []string) K8sOption

func WithExcludeNamespaces

func WithExcludeNamespaces(excludeNamespaces []string) K8sOption

func WithExcludeOwned

func WithExcludeOwned(excludeOwned bool) K8sOption

func WithIncludeKinds

func WithIncludeKinds(includeKinds []string) K8sOption

func WithIncludeNamespaces

func WithIncludeNamespaces(includeNamespaces []string) K8sOption

type NodeCollectorOption

type NodeCollectorOption func(*client)

func WithAffinity

func WithAffinity(affinity *corev1.Affinity) NodeCollectorOption

func WithCommandPaths

func WithCommandPaths(commandPaths []string) NodeCollectorOption

func WithEmbeddedCommandFileSystem

func WithEmbeddedCommandFileSystem(commandsFileSystem embed.FS) NodeCollectorOption

func WithEmbeddedNodeConfigFilesystem

func WithEmbeddedNodeConfigFilesystem(nodeConfigFileSystem embed.FS) NodeCollectorOption

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 WithSpecCommandIds

func WithSpecCommandIds(specCommandIds []string) NodeCollectorOption

func WithTolerations

func WithTolerations(tolerations []corev1.Toleration) NodeCollectorOption

type TunnelK8S

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

TunnelK8S interface represents the operations supported by the library

func New

func New(cluster k8s.Cluster, opts ...K8sOption) TunnelK8S

New creates a tunnelK8S client