Documentation
¶
Index ¶
- Constants
- func AnalyzeAndExtractSupportBundle(spec *troubleshootv1beta2.SupportBundleSpec, archivePath string) ([]*analyzer.AnalyzeResult, error)
- func AnalyzeSupportBundle(spec *troubleshootv1beta2.SupportBundleSpec, tmpDir string) ([]*analyzer.AnalyzeResult, error)
- func CollectSupportBundleFromSpec(spec *troubleshootv1beta2.SupportBundleSpec, ...) (string, error)
- func GetRedactorFromURI(redactorURI string) (*troubleshootv1beta2.Redactor, error)
- func GetSupportBundleFromURI(bundleURI string) (*troubleshootv1beta2.SupportBundle, error)
- func LoadRedactorSpec(arg string) ([]byte, error)
- func LoadSupportBundleSpec(arg string) ([]byte, error)
- func ParseSupportBundleFromDoc(doc []byte) (*troubleshootv1beta2.SupportBundle, error)
- func ProcessSupportBundleAfterCollection(spec *troubleshootv1beta2.SupportBundleSpec, archivePath string) (bool, error)
- type SupportBundleCreateOpts
- type SupportBundleResponse
Constants ¶
const VersionFilename = "version.yaml"
Variables ¶
This section is empty.
Functions ¶
func AnalyzeAndExtractSupportBundle ¶
func AnalyzeAndExtractSupportBundle(spec *troubleshootv1beta2.SupportBundleSpec, archivePath string) ([]*analyzer.AnalyzeResult, error)
AnalyzeAndExtractSupportBundle performs analysis on a support bundle using the archive and spec.
func AnalyzeSupportBundle ¶
func AnalyzeSupportBundle(spec *troubleshootv1beta2.SupportBundleSpec, tmpDir string) ([]*analyzer.AnalyzeResult, error)
AnalyzeSupportBundle performs analysis on a support bundle using the support bundle spec and an already unpacked support bundle on disk
func CollectSupportBundleFromSpec ¶
func CollectSupportBundleFromSpec(spec *troubleshootv1beta2.SupportBundleSpec, additionalRedactors *troubleshootv1beta2.Redactor, opts SupportBundleCreateOpts) (string, error)
CollectSupportBundleFromSpec run the support bundle collectors and creates an archive. The output is the name of the archive on disk (the caller must remove)
func GetRedactorFromURI ¶
func GetRedactorFromURI(redactorURI string) (*troubleshootv1beta2.Redactor, error)
func GetSupportBundleFromURI ¶
func GetSupportBundleFromURI(bundleURI string) (*troubleshootv1beta2.SupportBundle, error)
func LoadRedactorSpec ¶
func LoadSupportBundleSpec ¶
func ParseSupportBundleFromDoc ¶
func ParseSupportBundleFromDoc(doc []byte) (*troubleshootv1beta2.SupportBundle, error)
func ProcessSupportBundleAfterCollection ¶
func ProcessSupportBundleAfterCollection(spec *troubleshootv1beta2.SupportBundleSpec, archivePath string) (bool, error)
ProcessSupportBundleAfterCollection performs the after collection actions, like Callbacks and sending the archive to a remote server.
Types ¶
type SupportBundleCreateOpts ¶
type SupportBundleResponse ¶
type SupportBundleResponse struct {
AnalyzerResults []*analyzer.AnalyzeResult
ArchivePath string
// contains filtered or unexported fields
}
func CollectSupportBundleFromURI ¶
func CollectSupportBundleFromURI(specURI string, redactorURIs []string, opts SupportBundleCreateOpts) (*SupportBundleResponse, error)
CollectSupportBundleFromURI collects support bundle from start to finish, including running collectors, analyzers and after collection steps. Input arguments are the URIs of the support bundle and redactor specs.
func SupportBundleCollectAnalyzeProcess ¶
func SupportBundleCollectAnalyzeProcess(spec *troubleshootv1beta2.SupportBundleSpec, additionalRedactors *troubleshootv1beta2.Redactor, opts SupportBundleCreateOpts) (*SupportBundleResponse, error)
SupportBundleCollectAnalyzeProcess collects support bundle from start to finish, including running collectors, analyzers and after collection steps. Input arguments are specifications.