dump

Documentation

Index

• Constants
• func ParseMetadata(ctx context.Context, metadataFilePath string) (collector.Metadata, error)
• type DumpIngestor
  • func NewDumpIngestor(ctx context.Context, collector collector.CollectorClient, compression bool, ...) (*DumpIngestor, error)
  • func (d *DumpIngestor) Close(ctx context.Context) error
  • func (d *DumpIngestor) DumpK8sObjects(ctx context.Context) error
  • func (d *DumpIngestor) Metadata() (collector.Metadata, error)
  • func (d *DumpIngestor) OutputPath() string
• type DumpResult
  • func NewDumpResult(clusterName, runID string, isCompressed bool) (*DumpResult, error)
  • func ParsePath(path string) (*DumpResult, error)
  • func (i *DumpResult) Compressed()
  • func (i *DumpResult) GetFilename() string
  • func (i *DumpResult) GetFullPath() string
  • func (i *DumpResult) Validate() error

Constants

const (
	DumpResultFilenameRegex = DumpResultPrefix + DumpResultClusterNameRegex + "_" + DumpResultRunIDRegex + DumpResultExtensionRegex
	DumpResultPathRegex     = DumpResultClusterNameRegex + "/" + DumpResultFilenameRegex
)

Backward Compatibility: Extracting the metadata from the path

const (
	DumpResultClusterNameRegex = `([A-Za-z0-9\.\-_@]+)`
	DumpResultRunIDRegex       = `([a-z0-9]{26})`
	DumpResultExtensionRegex   = `\.?([a-z0-9\.]+)?`
	DumpResultPrefix           = "kubehound_"

	DumpResultTarWriterExtension = "tar.gz"
)

Functions

func ParseMetadata

func ParseMetadata(ctx context.Context, metadataFilePath string) (collector.Metadata, error)

Types

type DumpIngestor

type DumpIngestor struct {
	// contains filtered or unexported fields
}

func NewDumpIngestor

func NewDumpIngestor(ctx context.Context, collector collector.CollectorClient, compression bool, directoryOutput string, runID *config.RunID) (*DumpIngestor, error)

func (*DumpIngestor) Close

func (d *DumpIngestor) Close(ctx context.Context) error

Close() is invoked by the collector to close all handlers used to dump k8s objects. The function flushes all writers and close all the handlers.

func (*DumpIngestor) DumpK8sObjects

func (d *DumpIngestor) DumpK8sObjects(ctx context.Context) error

func (*DumpIngestor) Metadata

func (d *DumpIngestor) Metadata() (collector.Metadata, error)

func (*DumpIngestor) OutputPath

func (d *DumpIngestor) OutputPath() string

type DumpResult

type DumpResult struct {
	Metadata collector.Metadata
	// contains filtered or unexported fields
}

func NewDumpResult

func NewDumpResult(clusterName, runID string, isCompressed bool) (*DumpResult, error)

func ParsePath

func ParsePath(path string) (*DumpResult, error)

func (*DumpResult) Compressed

func (i *DumpResult) Compressed()

func (*DumpResult) GetFilename

func (i *DumpResult) GetFilename() string

func (*DumpResult) GetFullPath

func (i *DumpResult) GetFullPath() string

./<clusterName>/kubehound_<clusterName>_<run_id>

func (*DumpResult) Validate

func (i *DumpResult) Validate() error