Documentation
¶
Index ¶
- func AddFlags(flags *flag.FlagSet)
- func ConcatHostPreflightSpec(target *troubleshootv1beta2.HostPreflight, ...) *troubleshootv1beta2.HostPreflight
- func ConcatPreflightSpec(target *troubleshootv1beta2.Preflight, source *troubleshootv1beta2.Preflight) *troubleshootv1beta2.Preflight
- func HasStrictAnalyzer(analyzer *troubleshootv1beta2.Analyze) (bool, error)
- func HasStrictAnalyzers(preflight *troubleshootv1beta2.Preflight) (bool, error)
- func HasStrictAnalyzersFailed(preflightResult *UploadPreflightResults) bool
- func MergeMaps(base, overlay map[string]interface{}) map[string]interface{}
- func RenderWithHelmTemplate(templateContent string, values map[string]interface{}) (string, error)
- func RunPreflights(interactive bool, output string, format string, args []string) error
- func RunTemplate(templateFile string, valuesFiles []string, setValues []string, ...) error
- func SeedDefaultBooleans(templateContent string, values map[string]interface{})
- func SeedParentMapsForValueRefs(templateContent string, values map[string]interface{})
- type ClusterCollectResult
- type CollectOpts
- type CollectProgress
- type CollectResult
- func Collect(opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)
- func CollectHost(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
- func CollectHostWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
- func CollectRemote(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
- func CollectRemoteWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
- func CollectWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)
- type CollectorStatus
- type HostCollectResult
- type PreflightFlags
- type RemoteCollectResult
- type TextOutput
- type TextResultOutput
- type UploadPreflightError
- type UploadPreflightResult
- type UploadPreflightResults
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConcatHostPreflightSpec ¶ added in v0.50.0
func ConcatHostPreflightSpec(target *troubleshootv1beta2.HostPreflight, source *troubleshootv1beta2.HostPreflight) *troubleshootv1beta2.HostPreflight
func ConcatPreflightSpec ¶ added in v0.50.0
func ConcatPreflightSpec(target *troubleshootv1beta2.Preflight, source *troubleshootv1beta2.Preflight) *troubleshootv1beta2.Preflight
func HasStrictAnalyzer ¶ added in v0.31.1
func HasStrictAnalyzer(analyzer *troubleshootv1beta2.Analyze) (bool, error)
HasStrictAnalyzers - checks and returns true if a preflight's analyzer has strict:true, else false
func HasStrictAnalyzers ¶ added in v0.31.1
func HasStrictAnalyzers(preflight *troubleshootv1beta2.Preflight) (bool, error)
HasStrictAnalyzers - checks and returns true if a preflight's analyzer has strict:true, else false
func HasStrictAnalyzersFailed ¶ added in v0.31.1
func HasStrictAnalyzersFailed(preflightResult *UploadPreflightResults) bool
HasStrictAnalyzersFailed - checks if preflight analyzer's result is strict:true and isFail:true, then returns true else false
func MergeMaps ¶ added in v0.123.11
MergeMaps recursively merges two maps, with overlay taking precedence
func RenderWithHelmTemplate ¶ added in v0.123.0
RenderWithHelmTemplate renders a single YAML template string using Helm's engine with the provided values (corresponding to .Values in Helm templates).
func RunPreflights ¶ added in v0.44.0
func RunTemplate ¶ added in v0.123.0
func RunTemplate(templateFile string, valuesFiles []string, setValues []string, outputFile string) error
RunTemplate processes a templated preflight spec file with provided values
func SeedDefaultBooleans ¶ added in v0.123.0
SeedDefaultBooleans scans the template content for boolean-like value references such as .Values.<path>.enabled or .Values.<path>.create and ensures that any missing paths in the provided values map are initialized with a default value of false. This prevents nil dereference errors during Helm rendering when templates access nested fields on absent maps.
func SeedParentMapsForValueRefs ¶ added in v0.123.0
SeedParentMapsForValueRefs scans the template for .Values.<path> references and ensures that any missing parent maps along those paths are created in the provided values map. This prevents Helm/template evaluation errors like "nil pointer evaluating interface {}.foo" when the template dereferences nested maps that are absent. Only parent maps up to the last segment are created; leaf values are never set.
Types ¶
type ClusterCollectResult ¶ added in v0.10.0
type ClusterCollectResult struct {
AllCollectedData map[string][]byte
Collectors []collect.Collector
RemoteCollectors collect.RemoteCollectors
Spec *troubleshootv1beta2.Preflight
Context context.Context
// contains filtered or unexported fields
}
func (ClusterCollectResult) Analyze ¶ added in v0.10.0
func (c ClusterCollectResult) Analyze() []*analyze.AnalyzeResult
Analyze runs the analyze phase of preflight checks
func (ClusterCollectResult) IsRBACAllowed ¶ added in v0.10.0
func (cr ClusterCollectResult) IsRBACAllowed() bool
type CollectOpts ¶ added in v0.9.27
type CollectProgress ¶ added in v0.10.11
type CollectProgress struct {
CurrentName string
CurrentStatus string
CompletedCount int
TotalCount int
Collectors map[string]CollectorStatus
}
func (*CollectProgress) String ¶ added in v0.13.4
func (cp *CollectProgress) String() string
type CollectResult ¶ added in v0.9.27
type CollectResult interface {
Analyze() []*analyze.AnalyzeResult
IsRBACAllowed() bool
}
func Collect ¶ added in v0.9.27
func Collect(opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)
Collect runs the collection phase of preflight checks
func CollectHost ¶ added in v0.10.0
func CollectHost(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
CollectHost runs the collection phase of host preflight checks
func CollectHostWithContext ¶ added in v0.57.0
func CollectHostWithContext( ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.HostPreflight, ) (CollectResult, error)
func CollectRemote ¶ added in v0.15.0
func CollectRemote(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
Collect runs the collection phase of preflight checks
func CollectRemoteWithContext ¶ added in v0.57.0
func CollectRemoteWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (CollectResult, error)
func CollectWithContext ¶ added in v0.57.0
func CollectWithContext(ctx context.Context, opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult, error)
type CollectorStatus ¶ added in v0.28.2
type CollectorStatus struct {
Status string
}
type HostCollectResult ¶ added in v0.10.0
type HostCollectResult struct {
AllCollectedData map[string][]byte
Collectors []collect.HostCollector
Spec *troubleshootv1beta2.HostPreflight
Context context.Context
}
func (HostCollectResult) Analyze ¶ added in v0.10.0
func (c HostCollectResult) Analyze() []*analyze.AnalyzeResult
Analyze runs the analyze phase of host preflight checks
func (HostCollectResult) IsRBACAllowed ¶ added in v0.10.0
func (cr HostCollectResult) IsRBACAllowed() bool
type PreflightFlags ¶ added in v0.44.0
type PreflightFlags struct {
Interactive *bool
Format *string
CollectorImage *string
CollectorPullPolicy *string
CollectWithoutPermissions *bool
Selector *string
SinceTime *string
Since *string
Output *string
Debug *bool
}
func NewPreflightFlags ¶ added in v0.44.0
func NewPreflightFlags() *PreflightFlags
type RemoteCollectResult ¶ added in v0.15.0
type RemoteCollectResult struct {
AllCollectedData map[string][]byte
Collectors collect.RemoteCollectors
Spec *troubleshootv1beta2.HostPreflight
Context context.Context
}
func (RemoteCollectResult) Analyze ¶ added in v0.15.0
func (c RemoteCollectResult) Analyze() []*analyze.AnalyzeResult
Analyze runs the analyze phase of host preflight checks.
Runs the analysis for each node and aggregates the results.
func (RemoteCollectResult) IsRBACAllowed ¶ added in v0.15.0
func (cr RemoteCollectResult) IsRBACAllowed() bool
type TextOutput ¶ added in v0.70.3
type TextOutput struct {
Pass []TextResultOutput `json:"pass,omitempty" yaml:"pass,omitempty"`
Warn []TextResultOutput `json:"warn,omitempty" yaml:"warn,omitempty"`
Fail []TextResultOutput `json:"fail,omitempty" yaml:"fail,omitempty"`
}
func ShowTextResultsStructured ¶ added in v0.70.3
func ShowTextResultsStructured(preflightName string, analyzeResults []*analyzerunner.AnalyzeResult) *TextOutput
Used by both JSON and YAML outputs
type TextResultOutput ¶ added in v0.70.3
type UploadPreflightError ¶ added in v0.9.27
type UploadPreflightError struct {
Error string `json:"error"`
}
type UploadPreflightResult ¶ added in v0.9.27
type UploadPreflightResults ¶ added in v0.9.27
type UploadPreflightResults struct {
Results []*UploadPreflightResult `json:"results,omitempty"`
Errors []*UploadPreflightError `json:"errors,omitempty"`
}