dump

Documentation

Index

• func CreateReportArchive(captureDir string, archiveFilePath string) error
• func Dump(o Options) error
• type Options

Functions

func CreateReportArchive

func CreateReportArchive(captureDir string, archiveFilePath string) error

CreateReportArchive creates the .tar.gz file specified by the archiveFile from the files in captureDir e

func Dump

func Dump(o Options) error

Dump the cluster

Types

type Options

type Options struct {
	// KubeConfigPath is the path to the optional kubeconfig file
	KubeConfigPath string

	// CuratedResources true will dump resource manifests, except Secrets and ConfigMaps
	CuratedResources bool

	// NodeDumpForClusterInfo dumps a subset of node info if true
	NodeDumpForClusterInfo bool

	// IncludeConfigMap true will dump ConfigMaps
	IncludeConfigMap bool

	// SkipPodLogs true will skip pod logs
	SkipPodLogs bool

	// SkipCluster true means to show the details of the cluster
	SkipCluster bool

	// SkipNodes true means to show the details of each node
	SkipNodes bool

	// SkipRedact true mean skip redaction of cluster and node data
	SkipRedact bool

	// NodeNames are the names of the nodes to dump
	NodeNames []string

	// Namespaces are the names of the namespaces to dump
	Namespaces []string

	// Output directory for the dump.  Must be empty or not exist
	OutDir string

	// Quiet means don't log cluster dump info
	Quiet bool

	// ArchiveFile is the file path of the archive file that will be generated
	ArchiveFile string

	// Managed determines whether the managedField metadata is dumped with a resource
	Managed bool

	// JSON determines whether the Kubernetes resources should be outputted in JSON format
	JSON bool
}

Options are the options for the dump command