support

package
v1.14.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 14, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

Package support provides functions and methods to produce Finch support bundles

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BundleBuilder

type BundleBuilder interface {
	GenerateSupportBundle(*BundleCfg) (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 BundleCfg added in v1.14.0

type BundleCfg struct {
	AdditionalFiles []string
	ExcludeFiles    []string
	LogLines        int
}

BundleCfg has all the required args for generating support bundles.

type BundleConfig

type BundleConfig interface {
	LogFiles() []string
	ConfigFiles() []string
	JournalServices() []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 added in v1.4.0

type SystemDeps interface {
	system.ExecutableFinder
}

SystemDeps provides methods to get system dependencies.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL