preflight

Documentation

Index

• Constants
• func CreateRenderedSpec(app *apptypes.App, sequence int64, origin string, inCluster bool, ...) error
• func Execute(preflightSpec *troubleshootv1beta2.Preflight, ignorePermissionErrors bool, ...) (*types.PreflightResults, error)
• func GetPreflightCheckState(p *troubleshootpreflight.UploadPreflightResult) string
• func GetPreflightCommand(appSlug string) []string
• func GetPreflightState(preflightResults *types.PreflightResults, ignoreNonStrict bool) string
• func GetSpecSecretName(appSlug string) string
• func GetSpecURI(appSlug string) string
• func InjectDefaultPreflights(preflight *troubleshootv1beta2.Preflight, kotskinds *kotsutil.KotsKinds, ...)
• func Run(appID string, appSlug string, sequence int64, isAirgap bool, ...) error

Constants

const (
	SpecDataKey = "preflight-spec"
)

Functions

func CreateRenderedSpec

func CreateRenderedSpec(app *apptypes.App, sequence int64, origin string, inCluster bool, kotsKinds *kotsutil.KotsKinds, archiveDir string) error

func Execute

func Execute(preflightSpec *troubleshootv1beta2.Preflight, ignorePermissionErrors bool, setProgress func(progress map[string]interface{}) error, setResults func(results *types.PreflightResults) error) (*types.PreflightResults, error)

Execute will Execute the preflights using spec in preflightSpec. This spec should be rendered, no template functions remaining

func GetPreflightCheckState

func GetPreflightCheckState(p *troubleshootpreflight.UploadPreflightResult) string

GetPreflightCheckState returns the state of a single preflight check result

func GetPreflightCommand

func GetPreflightCommand(appSlug string) []string

func GetPreflightState

func GetPreflightState(preflightResults *types.PreflightResults, ignoreNonStrict bool) string

GetPreflightState returns a single state based on checking all preflight checks results. If there are any errors, the state is fail. If there are no errors and any warnings, the state is warn. Otherwise, the state is pass.

func GetSpecSecretName

func GetSpecSecretName(appSlug string) string

func GetSpecURI

func GetSpecURI(appSlug string) string

func InjectDefaultPreflights

func InjectDefaultPreflights(preflight *troubleshootv1beta2.Preflight, kotskinds *kotsutil.KotsKinds, registrySettings registrytypes.RegistrySettings)

func Run

func Run(appID string, appSlug string, sequence int64, isAirgap bool, ignoreNonStrict bool, archiveDir string) error