support

Documentation

Overview

Package support provides functions and methods to produce Finch support bundles

Index

• type BundleBuilder
  • func NewBundleBuilder(logger flog.Logger, fs afero.Fs, config BundleConfig, finch fpath.Finch, ...) BundleBuilder
• type BundleConfig
  • func NewBundleConfig(finch fpath.Finch, rootDir string) BundleConfig
• type PlatformData
• type SystemDeps

Types

type BundleBuilder

type BundleBuilder interface {
	GenerateSupportBundle([]string, []string) (string, error)
}

BundleBuilder provides methods to generate support bundles.

func NewBundleBuilder

func NewBundleBuilder(
	logger flog.Logger,
	fs afero.Fs,
	config BundleConfig,
	finch fpath.Finch,
	ecc command.Creator,
	ncc command.NerdctlCmdCreator,
	lima wrapper.LimaWrapper,
	systemDeps SystemDeps,
) BundleBuilder

NewBundleBuilder produces a new BundleBuilder.

type BundleConfig

type BundleConfig interface {
	LogFiles() []string
	ConfigFiles() []string
}

BundleConfig provides methods that configure what is included in a support bundle.

func NewBundleConfig

func NewBundleConfig(finch fpath.Finch, rootDir string) BundleConfig

NewBundleConfig creates a new bundleConfig.

type PlatformData

type PlatformData struct {
	Os    string `yaml:"os"`
	Arch  string `yaml:"arch"`
	Finch string `yaml:"finch"`
}

PlatformData defines the YAML structure for the platform data included in a support bundle.

type SystemDeps

type SystemDeps interface {
	system.ExecutableFinder
}

SystemDeps provides methods to get system dependencies.