The nodeResources filter examples incorrectly used `allocatableMemory`
instead of `memoryAllocatable`. This causes YAML parsing to silently
ignore the field, resulting in empty filter values and unexpected
analyzer behavior.
Changed in 3 files (5 instances total):
- examples/preflight/node-resources.yaml (3 instances)
- examples/preflight/e2e.yaml (1 instance)
- examples/support-bundle/e2e.yaml (1 instance)
The correct field names according to pkg/apis/troubleshoot/v1beta2/analyzer_shared.go
are:
- memoryAllocatable (not allocatableMemory)
- cpuAllocatable (not allocatableCPU)
- memoryCapacity (not capacityMemory)
- cpuCapacity (not capacityCPU)
This bug caused users copying from these examples to experience false
failures in preflight checks, as documented in the bug report where
a GKE cluster with 85Gi memory failed a check requiring only 8Gi.
* Change workflow branch from 'main' to 'v1beta3'
* Auto updater (#1849)
* added auto updater
* updated docs
* commit to trigger actions
* Auto-collectors: foundational discovery, image metadata, CLI integrat… (#1845)
* Auto-collectors: foundational discovery, image metadata, CLI integration; reset PRD markers
* Address PR review feedback
- Implement missing namespace exclude patterns functionality
- Fix image facts collector to use empty Data field instead of static string
- Correct APIVersion to use troubleshoot.sh/v1beta2 consistently
* Fix bug bot issues: API parsing, EOF error, and API group corrections
- Fix RBAC API parsing errors in rbac_checker.go (getAPIGroup/getAPIVersion functions)
- Fix FakeReader EOF error to use standard io.EOF instead of custom error
- Fix incorrect API group from troubleshoot.sh to troubleshoot.replicated.com in run.go
These changes address the issues identified by the bug bot and ensure proper
interface compliance and consistent API group usage.
* Fix multiple bug bot issues
- Fix RBAC API parsing errors in rbac_checker.go (getAPIGroup/getAPIVersion functions)
- Fix FakeReader EOF error to use standard io.EOF instead of custom error
- Fix incorrect API group from troubleshoot.sh to troubleshoot.replicated.com in run.go
- Fix image facts collector Data field to contain structured JSON instead of static strings
These changes address all issues identified by the bug bot and ensure proper
interface compliance, consistent API usage, and meaningful data fields.
* Update auto_discovery.go
* Fix TODO comments in Auto-collector section
Fixed 3 of 4 TODOs as requested in PR review:
1. pkg/collect/images/registry_client.go (line 46):
- Implement custom CA certificate loading
- Add x509 import and certificate parsing logic
- Enables image collection from private registries with custom CAs
2. cmd/troubleshoot/cli/diff.go (line 209):
- Implement bundle file count functionality
- Add tar/gzip imports and getFileCountFromBundle() function
- Properly counts files in support bundle archives (.gz/.tgz)
3. cmd/troubleshoot/cli/run.go (line 338):
- Replace TODO with clarifying comment about RemoteCollectors usage
- Confirmed RemoteCollectors are still actively used in preflights
The 4th TODO (diff.go line 196) is left as-is since it's explicitly marked
as Phase 4 future work (Support Bundle Differencing implementation).
Addresses PR review feedback about unimplemented TODO comments.
---------
Co-authored-by: Benjamin Yang <benjaminyang@Benjamins-MacBook-Pro.local>
* resetting make targets and github workflows to support v1beta3 releas… (#1853)
* resetting make targets and github workflows to support v1beta3 release later
* removing generate
* remove
* removing
* removing
* Support bundle diff (#1855)
implemented support bundle diff command
* Preflight docs and template subcommands (#1847)
* Added docs and template subcommands with test files
* uses helm templating preflight yaml files
* merge doc requirements for multiple inputs
* Helm aware rendering and markdown output
* v1beta3 yaml structure better mirrors beta2
* Update sample-preflight-templated.yaml
* Added docs and template subcommands with test files
* uses helm templating preflight yaml files
* merge doc requirements for multiple inputs
* Helm aware rendering and markdown output
* v1beta3 yaml structure better mirrors beta2
* Update sample-preflight-templated.yaml
* Added/updated documentation on subcommands
* Update docs.go
* commit to trigger actions
* Updated yaml spec (#1851)
* v1beta3 spec can be read by preflight
* added test files for ease of testing
* updated v1beta3 guide doc and added tests
* fixed not removing tmp files from v1beta3 processing
* created v1beta2 to v1beta3 converter
* Updated yaml spec (#1863)
* v1beta3 spec can be read by preflight
* added test files for ease of testing
* v1beta3 renderer fixes
* fixed gitignore issue
* Auto support bundle upload (#1860)
* basic auto uploading support bundles
* added upload command
* added default vendor endpoint
* added auth system from replicated cli
* fixed case sensitivity issue in YAML parsing
* support bundle uploads for end customers
* app slug flag and detection without licenseID
* moved v1beta3 examples to proper directory
* does not auto update for package managers (#1850)
* V1beta3 cleanup (#1869)
* moving some files around
* more cleanup
* removing more unused
* update ci for v1beta3 (#1870)
* fmt:
* removing unused examples
* add a v1beta3 fixture
* removing coverage reporting
* adding brew (#1872)
* Fixing testing errors (#1871)
fix: resolve failing unit tests and diff consistency in v1beta3
- Fix readLinesFromReader to return lines WITH newlines (like difflib.SplitLines)
- Update test expectations to match correct function behavior with newlines
- This ensures consistency between streaming and non-streaming diff paths
- Fix timeout test by changing from 10ms to 500ms to eliminate flaky failures
Fixes TestReadLinesFromReader and Test_loadSupportBundleSpecsFromURIs_TimeoutError
Resolves diff output inconsistency between code paths
* Fix/exec textanalyze path clean (#1865)
* created roadmap and yaml claude agent
* Update roadmap.md
* Fix textAnalyze analyzer to auto-match exec collector nested paths
- Auto-detect exec output files (*-stdout.txt, *-stderr.txt, *-errors.json)
- Convert simple filenames to wildcard patterns automatically
- Preserve existing wildcard patterns
- Fixes 'No matching file' errors for exec + textAnalyze workflows
---------
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
* bump goreleaser to v2
* remove collect binary and risc binary
* remove this check
* add debug logging
* larger runner for release
* dropping goreleaser
* fix syntax
* fix syntax
* goreleaser
* larger
* prerelease auto and more
* publish to directory:
* some more goreleaser/homebrew stuffs
* removing risc
* bump example
* Advanced analysis clean (#1868)
* created roadmap and yaml claude agent
* Update roadmap.md
* feat: Clean advanced analysis implementation - core agents, engine, artifacts
* Remove unrelated files - keep only advanced analysis implementation
* fix: Fix goroutine leak in hosted agent rate limiter
- Added stop channel and stopped flag to RateLimiter struct
- Modified replenishTokens to listen for stop signal and exit cleanly
- Added Stop() method to gracefully shutdown rate limiter
- Added Stop() method to HostedAgent to cleanup rate limiter on shutdown
Fixes cursor bot issue: Rate Limiter Goroutine Leak
* fix: Fix analyzer config and model validation bugs
Bug 1: Analyzer Config Missing File Path
- Added filePath to DeploymentStatus analyzer config in convertAnalyzerToSpec
- Sets namespace-specific path (cluster-resources/deployments/{namespace}.json)
- Falls back to generic path (cluster-resources/deployments.json) if no namespace
- Fixes LocalAgent.analyzeDeploymentStatus backward compatibility
Bug 2: HealthCheck Fails Model Validation
- Changed Ollama model validation from prefix match to exact match
- Prevents false positives where llama2:13b would match request for llama2:7b
- Ensures agent only reports healthy when exact model is available
Both fixes address cursor bot reported issues and maintain backward compatibility.
* fixing lint errors
* fixing lint errors
* adding CLI flags
* fix: resolve linting errors for CI
- Remove unnecessary nil check in host_kernel_configs.go (len() for nil slices is zero)
- Remove unnecessary fmt.Sprintf() calls in ceph.go for static strings
- Apply go fmt formatting fixes
Fixes failing lint CI check
* fix: resolve CI failures in build-test workflow and Ollama tests
1. Fix GitHub Actions workflow logic error:
- Replace problematic contains() expression with explicit job result checks
- Properly handle failure and cancelled states for each job
- Prevents false positive failures in success summary job
2. Fix Ollama agent parseLLMResponse panics:
- Add proper error handling for malformed JSON in LLM responses
- Return error when JSON is found but invalid (instead of silent fallback)
- Add error when no meaningful content can be parsed from response
- Prevents nil pointer dereference in test assertions
Fixes failing build-test/success and build-test/test CI checks
* fix: resolve all CI failures and cursor bot issues
1. Fix disable-ollama flag logic bug:
- Remove disable-ollama from advanced analysis trigger condition
- Prevents unintended advanced analysis mode when no agents registered
- Allows proper fallback to legacy analysis
2. Fix diff test consistency:
- Update test expectations to match function behavior (lines with newlines)
- Ensures consistency between streaming and non-streaming diff paths
3. Fix Ollama agent error handling:
- Add proper error return for malformed JSON in LLM responses
- Add meaningful content validation for markdown parsing
- Prevents nil pointer panics in test assertions
4. Fix analysis engine mock agent:
- Mock agent now processes and returns results for all provided analyzers
- Fixes test expectation mismatch (expected 8 results, got 1)
Resolves all failing CI checks: lint, test, and success workflow logic
---------
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
* Auto-Collect (#1867)
* Fix auto-collector missing files issue
- Add KOTS-aware detection for diagnostic files
- Replace silent RBAC filtering with user warnings
- Enhance error file collection for troubleshooting
- Achieve parity with traditional support bundles
Resolves issue where auto-collector was missing:
- KOTS diagnostic files (now 4 vs 3)
- ConfigMaps (now 6 vs 6)
- Maintains superior log collection (24 vs 0)
Final result: [SUCCESS] comprehensive collection achieved
* fixing bugbog
* fix: resolve production readiness issues in auto-collect branch
1. Fix diff test expectations (lines should have newlines for difflib consistency)
2. Fix preflight tests to use existing v1beta3 example file
3. Fix autodiscovery test context parameter (function signature update)
Resolves TestReadLinesFromReader and preflight v1beta3 test failures
* fix: resolve autodiscovery tests and cursor bot image matching issues
1. Fix cursor bot image matching bug in isKotsadmImage:
- Replace flawed prefix matching with proper image component detection
- Handle private registries correctly (registry.company.com/kotsadm/kotsadm:v1.0.0)
- Prevent false positives with proper delimiter checking
- Add helper functions: containsImageComponent, splitImagePath, removeTagAndDigest
2. Fix autodiscovery test failures:
- Add TestMode flag to DiscoveryOptions to control KOTS diagnostic collection
- Tests use TestMode=true to get only foundational collectors (no KOTS diagnostics)
- Preserves production behavior while enabling clean testing
Resolves failing TestDiscoverer_DiscoverFoundational tests and cursor bot issues
* Cron job clean (#1862)
* created roadmap and yaml claude agent
* Update roadmap.md
* chore(deps): bump sigstore/cosign-installer from 3.9.2 to 3.10.0 (#1857)
Bumps [sigstore/cosign-installer](https://github.com/sigstore/cosign-installer) from 3.9.2 to 3.10.0.
- [Release notes](https://github.com/sigstore/cosign-installer/releases)
- [Commits](https://github.com/sigstore/cosign-installer/compare/v3.9.2...v3.10.0)
---
updated-dependencies:
- dependency-name: sigstore/cosign-installer
dependency-version: 3.10.0
dependency-type: direct:production
update-type: version-update:semver-minor
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* chore(deps): bump the security group with 2 updates (#1858)
Bumps the security group with 2 updates: [github.com/vmware-tanzu/velero](https://github.com/vmware-tanzu/velero) and [helm.sh/helm/v3](https://github.com/helm/helm).
Updates `github.com/vmware-tanzu/velero` from 1.16.2 to 1.17.0
- [Release notes](https://github.com/vmware-tanzu/velero/releases)
- [Changelog](https://github.com/vmware-tanzu/velero/blob/main/CHANGELOG.md)
- [Commits](https://github.com/vmware-tanzu/velero/compare/v1.16.2...v1.17.0)
Updates `helm.sh/helm/v3` from 3.18.6 to 3.19.0
- [Release notes](https://github.com/helm/helm/releases)
- [Commits](https://github.com/helm/helm/compare/v3.18.6...v3.19.0)
---
updated-dependencies:
- dependency-name: github.com/vmware-tanzu/velero
dependency-version: 1.17.0
dependency-type: direct:production
update-type: version-update:semver-minor
dependency-group: security
- dependency-name: helm.sh/helm/v3
dependency-version: 3.19.0
dependency-type: direct:production
update-type: version-update:semver-minor
dependency-group: security
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* chore(deps): bump helm.sh/helm/v3 from 3.18.6 to 3.19.0 in /examples/sdk/helm-template in the security group (#1859)
chore(deps): bump helm.sh/helm/v3
Bumps the security group in /examples/sdk/helm-template with 1 update: [helm.sh/helm/v3](https://github.com/helm/helm).
Updates `helm.sh/helm/v3` from 3.18.6 to 3.19.0
- [Release notes](https://github.com/helm/helm/releases)
- [Commits](https://github.com/helm/helm/compare/v3.18.6...v3.19.0)
---
updated-dependencies:
- dependency-name: helm.sh/helm/v3
dependency-version: 3.19.0
dependency-type: direct:production
update-type: version-update:semver-minor
dependency-group: security
...
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Add cron job support bundle scheduler
Complete implementation with K8s integration:
- pkg/schedule/job.go: Job management and persistence
- pkg/schedule/daemon.go: Real-time scheduler daemon
- pkg/schedule/cli.go: CLI commands (create, list, delete, daemon)
- pkg/schedule/schedule_test.go: Comprehensive unit tests
- cmd/troubleshoot/cli/root.go: CLI integration
* fixing bugbot
* Fix all bugbot errors: auto-update stability, job cooldown timing, and daemon execution
* Deleting Agent
* removed unused flags
* fixing auto-upload
* fixing markdown files
* namespace not required flag for auto collectors to work
* loosened cron job validation
* writes logs to logfile
* fix: resolve autoFromEnv variable scoping issue for CI
- Ensure autoFromEnv variable and its usage are in correct scope
- Fix build errors: declared and not used / undefined variable
- All functionality preserved and tested locally
- Force add to override gitignore
---------
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* feat: clean tokenization system implementation (#1874)
Core tokenization functionality with minimal file changes:
✅ Core Features:
- Intelligent tokenization engine (tokenizer.go)
- Context-aware secret classification (PASSWORD, APIKEY, DATABASE, etc.)
- Cross-file correlation with deterministic HMAC-SHA256 tokens
- Optional encrypted mapping for token→original value resolution
✅ Integration:
- CLI flags: --tokenize, --redaction-map, --encrypt-redaction-map
- Updated all redactor types: literal, single-line, multi-line, YAML
- Support bundle integration with auto-upload compatibility
- Backward compatibility: preserves ***HIDDEN*** when disabled
✅ Production Ready:
- Only 11 essential files (vs 31 in original PR)
- No excessive test files or documentation
- Clean build, all functionality verified
- Maintains existing redaction behavior by default
Token format: ***TOKEN_<TYPE>_<HASH>*** (e.g., ***TOKEN_PASSWORD_A1B2C3***)
* Removes silent failing (#1877)
* preserves stdout and stderr from collectors
* Delete eliminate-silent-failures.md
* Update host_kernel_modules_test.go
* added error logs when a collector fails to start
* Update host_filesystem_performance_linux.go
* fixed error saving logic inconsistency
* Update collect.go
* Improved error handling for support bundles and redactors for windows (#1878)
* improved error handling and window locking
* Delete all-windows-collectors.yaml
* addressing bugbot concerns
* Update host_tcpportstatus.go
* Update redact.go
* Add regression test suite to github actions
* Update regression-test.yaml
* Update regression-test.yaml
* Update regression-test.yaml
* create test/output directory
* handle node-specific files and multiple report arguments
* simplify comparison to detect code regressions only
* handle empty structural_compare rules
* removed v1beta3 branch from github workflow
* Update Makefile
* removed outdated actions
* Update Makefile
---------
Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Noah Campbell <noah.edward.campbell@gmail.com>
Co-authored-by: Benjamin Yang <82779168+bennyyang11@users.noreply.github.com>
Co-authored-by: Benjamin Yang <benjaminyang@Benjamins-MacBook-Pro.local>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* filter on cpu architecture
* filter by cpu architecture
* fail if we dont have a label match too
* add tests for cpu arch filter
* update for make schemas
For a postgres collector spec targeting a server configured to accept
(m)TLS connections we need to pass in the necessary parameters in order
to successfully connect to the server. Both preflight and support bundle
specs use this collector.
This change allows us to pass in the necessary TLS parameters via inlined
TLS configuration or via a secret reference.
Fixes#747
feat(collectors): Add mTLS parameters to the redis collector
For a redis collector spec targeting a redis server configured to accept
(m)TLS connections we need to pass in the necessary TLS parameters in order
to successfully connect to the server. Both preflight and support bundle
specs use this collector.
This change allows us to pass in the necessary TLS parameters via inlined
TLS configuration or via a secret reference.
Fixes#746
* feat(collectors): Store all pod logs in cluster-resources directory
All pod logs collected by the logs collector will now be stored in
/cluster-resources/pods/logs/[namespace]/[pod]/[container].log. This
will provide consistency and allow sbctl to find the logs when we run
`kubectl logs <pod>`. To allow backwards compatibility, symlinks of the
log files will be created in the current expected locations.
Closes: #744
## Description:
Currently, when we install an k8s with kurl and we run kubectl preflight https://preflight.replicated.com it will fail:
> ------------
> Check FAIL
> Title: Ingress
> Message: Contour ingress not found!
Therefore, Contour ingress does not seems a pre-requirement to kURL. So, should we have this check in the default example/test?
* collector/analyzer for host operating system
* address cr comments
* cleanup
* fix invoking the analyzer
code cleanup
* fix cr comments
* add corner case unit-test
* fix kernel version parsing
* address review comments
* add default case
* parse using regex
* added more testcases and fixed the bug found in cr
* few small things
* Add collect command and remote host collectors
Adds the ability to run a host collector on a set of remote k8s nodes.
Target nodes can be filtered using the --selector flag, with the same
syntax as kubectl. Existing flags for --collector-image,
--collector-pullpolicy and --request-timeout are used. To run on a
specified node, --selector="kubernetes.io/hostname=kind-worker2" could
be used.
The collect command is used by the remote collector to output the
results using a "raw" format, which uses the filename as the key, and
the value the output as a escaped json string. When run manually it
defaults to fully decoded json. The existing block devices,
ipv4interfaces and services host collectors don't decode properly - the
fix is to convert their slice output to a map (fix not included as
unsure what depends on the existing format).
The collect command is also useful for troubleshooting preflight issues.
Examples are included to show remote collector usage.
```
bin/collect --collector-image=croomes/troubleshoot:latest examples/collect/remote/memory.yaml --namespace test
{
"kind-control-plane": {
"system/memory.json": {
"total": 1304207360
}
},
"kind-worker": {
"system/memory.json": {
"total": 1695780864
}
},
"kind-worker2": {
"system/memory.json": {
"total": 1726353408
}
}
}
```
The preflight command has been updated to run remote collectors. To run
a host collector remotely it must be specified in the spec as a
`remoteCollector`:
```
apiVersion: troubleshoot.sh/v1beta2
kind: HostPreflight
metadata:
name: memory
spec:
remoteCollectors:
- memory:
collectorName: memory
analyzers:
- memory:
outcomes:
- fail:
when: "< 8Gi"
message: At least 8Gi of memory is required
- warn:
when: "< 32Gi"
message: At least 32Gi of memory is recommended
- pass:
message: The system has as sufficient memory
```
Results for each node are analyzed separately, with the node name
appended to the title:
```
bin/preflight --interactive=false --collector-image=croomes/troubleshoot:latest examples/preflight/remote/memory.yaml --format=json
{memory running 0 1}
{memory completed 1 1}
{
"fail": [
{
"title": "Amount of Memory (kind-worker2)",
"message": "At least 8Gi of memory is required"
},
{
"title": "Amount of Memory (kind-worker)",
"message": "At least 8Gi of memory is required"
},
{
"title": "Amount of Memory (kind-control-plane)",
"message": "At least 8Gi of memory is required"
}
]
}
```
Also added a host collector to allow preflight checks of required kernel
modules, which is the main driver for this change.
Fixed bug caused by host preflights not handling empty when clauses, this cropped up because we now handle multiple host preflight results. Also expanded test coverage and added integration test script.
Add a background IOPS feature to the filesystem performance collector
that specifies separate read and write background IOPS to perform while
measuring latency. This allows for better assessment of whether etcd
will be stable when running alongside other workloads on the same
cluster.
Also add templating to the outcome message of the filesystem performance
analyzers to allow printing individual latency percentiles or the entire
table.
Remove the random IOPS benchmark since it was attempting to perform
unaligned direct I/O.
The random IOPS benchmark attempts to replicate the results of this
fio command:
fio --ioengine=psync --direct=1 --bs=4k --size=1Gi --readwrite=randread --serialize_overlap=1
Across three tests the fio command reported 1877 IOPS and the preflight
1822 IOPS with the same block and file size.
The included example found P99 latency of 2.6ms.
Fio reported P99 latency of 2.5ms with this command:
fio --rw=write --ioengine=sync --fdatasync=1 --directory=/var/lib/etcd
--size=220m --bs=2300
Add all supported analyzers to host preflight sample.
Don't log transient errors waiting for TCP connection.
Begin human stdout results on new line after spinner.
