bundle

package

v0.30.9 Latest Latest Go to latest Published: Mar 19, 2024 License: Apache-2.0 Imports: 33 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/replicatedcom/support-bundle

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func ChannelJSONSpec(channelID string) types.Spec
func CustomerJSONSpec(customerID string) types.Spec
func DefaultSpecs() ([]types.Spec, error)
func Exec(ctx context.Context, rootDir string, tasks []types.Task, opts ...Option) []*types.Result
func Generate(tasks []types.Task, timeout time.Duration, pathname string) (os.FileInfo, string, error)
func SupportBundleSpecs() []types.Spec
func Upload(file *os.File, fname, lname, email, company, description string) (string, error)
func WatchJSONSpec(watchID string) types.Spec
type ExecOptions
type Option
type Planner
- func NewPlanner(opts PlannerOptions, inContainer bool, logOutput *util.Buffer) (*Planner, error)
- func (p *Planner) AddPlugin(plugin types.Plugin)
- func (p *Planner) Plan(specs []types.Spec) []types.Task
type PlannerOptions

Constants ¶

View Source

const (
	DeferredTimeoutDefault = 5 * time.Second
)

Variables ¶

This section is empty.

Functions ¶

func ChannelJSONSpec ¶ added in v0.23.0

func ChannelJSONSpec(channelID string) types.Spec

func CustomerJSONSpec ¶

func CustomerJSONSpec(customerID string) types.Spec

Deprecated

func DefaultSpecs ¶

func DefaultSpecs() ([]types.Spec, error)

func Exec ¶

func Exec(ctx context.Context, rootDir string, tasks []types.Task, opts ...Option) []*types.Result

func Generate ¶

func Generate(tasks []types.Task, timeout time.Duration, pathname string) (os.FileInfo, string, error)

Generate a new support bundle and write the results as an archive at pathname

func SupportBundleSpecs ¶ added in v0.24.0

func SupportBundleSpecs() []types.Spec

func Upload ¶

func Upload(file *os.File, fname, lname, email, company, description string) (string, error)

Upload uploads a support bundle in such a way that it becomes accessable to replicated support.

func WatchJSONSpec ¶ added in v0.27.0

func WatchJSONSpec(watchID string) types.Spec

Types ¶

type ExecOptions ¶ added in v0.24.0

type ExecOptions struct {
	DeferredTimeout time.Duration
}

type Option ¶ added in v0.24.0

type Option func(*ExecOptions)

type Planner ¶

type Planner struct {
	Plugins []types.Plugin
}

func NewPlanner ¶ added in v0.19.0

func NewPlanner(opts PlannerOptions, inContainer bool, logOutput *util.Buffer) (*Planner, error)

func (*Planner) AddPlugin ¶

func (p *Planner) AddPlugin(plugin types.Plugin)

func (*Planner) Plan ¶

func (p *Planner) Plan(specs []types.Spec) []types.Task

type PlannerOptions ¶ added in v0.19.0

type PlannerOptions struct {
	EnableCore       bool
	EnableDocker     bool
	EnableJournald   bool
	EnableKubernetes bool
	EnableRetraced   bool

	RequireCore       bool
	RequireDocker     bool
	RequireJournald   bool
	RequireKubernetes bool
	RequireRetraced   bool
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
defaultspec
reader
testfixtures

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