supportbundle

Documentation

Index

• Constants
• Variables
• func Collect(app *apptypes.App, clusterID string) (string, error)
• func CreateBundle(requestedID string, appID string, archivePath string) (*types.SupportBundle, error)
• func CreateBundleForBackup(appID string, backupName string, backupNamespace string) (string, error)
• func CreateRenderedSpec(app *apptypes.App, sequence int64, kotsKinds *kotsutil.KotsKinds, ...) (*troubleshootv1beta2.SupportBundle, error)
• func CreateSupportBundleAnalysis(appID string, archivePath string, bundle *types.SupportBundle) error
• func CreateSupportBundleDependencies(app *apptypes.App, sequence int64, opts types.TroubleshootOptions) (*types.SupportBundle, error)
• func Dedup[T any](objs []T) []T
• func GetBundleCommand(appSlug string) []string
• func GetSpecName(appSlug string) string
• func GetSpecURI(appSlug string) string
• func StartServer()

Constants

const (
	BUNDLE_PROGRESS_ERROR     supportBundleProgressUpdateType = "error"
	BUNDLE_PROGRESS_COLLECTOR supportBundleProgressUpdateType = "collector"
	BUNDLE_PROGRESS_FILETREE  supportBundleProgressUpdateType = "filetree"
	BUNDLE_PROGRESS_UPLOADED  supportBundleProgressUpdateType = "uploaded"
)

const (
	SpecDataKey = "support-bundle-spec"
)

Variables

var (
	SupportBundleNameRegex = regexp.MustCompile(`^\/?support-bundle-(\d{4})-(\d{2})-(\d{2})T(\d{2})_(\d{2})_(\d{2})\/?`)
)

Functions

func Collect

func Collect(app *apptypes.App, clusterID string) (string, error)

Collect will queue collection of a new support bundle. It returns the ID of the support bundle so that the status can be queried by the front end.

func CreateBundle

func CreateBundle(requestedID string, appID string, archivePath string) (*types.SupportBundle, error)

CreateBundle will create a support bundle in the store, attempting to use the requestedID. This function uploads the archive and creates the record.

func CreateBundleForBackup

func CreateBundleForBackup(appID string, backupName string, backupNamespace string) (string, error)

func CreateRenderedSpec

func CreateRenderedSpec(app *apptypes.App, sequence int64, kotsKinds *kotsutil.KotsKinds, opts types.TroubleshootOptions) (*troubleshootv1beta2.SupportBundle, error)

CreateRenderedSpec creates the support bundle specification from defaults and the kots app

func CreateSupportBundleAnalysis

func CreateSupportBundleAnalysis(appID string, archivePath string, bundle *types.SupportBundle) error

CreateSupportBundleAnalysis adds the analysis to the support bundle secret. if the support bundle archive already includes analysis, the secret will be updated with that. (which is the case for new support bundles) if not, the support bundle archive will be unpacked and analyzed and then the secret will be updated with the results. (which is the case for older support bundles formats)

func CreateSupportBundleDependencies

func CreateSupportBundleDependencies(app *apptypes.App, sequence int64, opts types.TroubleshootOptions) (*types.SupportBundle, error)

CreateSupportBundleDependencies generates k8s secrets and configmaps for the support bundle spec and redactors. These resources will be used when executing a support bundle collection

func Dedup

func Dedup[T any](objs []T) []T

func GetBundleCommand

func GetBundleCommand(appSlug string) []string

func GetSpecName

func GetSpecName(appSlug string) string

func GetSpecURI

func GetSpecURI(appSlug string) string

func StartServer

func StartServer()