Scan env
Read-only probes of kubectl and aws — only calls kubectl get and aws describe/list. Returns a markdown report plus a snapshot_id the install advisors (Reporter, Reducer, Retriever) read for the next 30 minutes. Every shell command run is recorded in the snapshot's probeLog.
Example
"scan env for install candidates"
Probes via kubectl get:
- Existing workloads: DaemonSets, Deployments, Helm releases
- Log forwarder detection: fluent-bit / fluentd / filebeat / logstash / otel-collector
- Log10x apps already installed (and in which namespace)
- Storage classes, ingress classes
- ServiceAccounts with IRSA annotations (IAM roles for pods)
Detected on this run: fluent-bit DaemonSet (3 replicas) in logging ns · EKS 1.28 · no Log10x apps · 4 storage classes · gp3 default.
Probes via aws describe / list:
- EKS clusters in the region
- S3 buckets matching
log10x/tenx/retriever/bucket_hint - SQS queues following the Retriever convention (
*-index-queue,*-query-queue,*-subquery-queue,*-stream-queue) - CloudWatch log groups
Detected on this run: AWS account 123456 · 1 EKS cluster acme-prod · S3 bucket logs-archive matched · 0 SQS queues · 12 CloudWatch log groups.
More to ask
- "scan us-east-1, cluster
acme-prod, namespaces logging+observability" - "AWS-only — no kubectl available"
- "K8s-only scan, skip AWS"
Prerequisites
kubectl and/or aws CLI on PATH with working credentials. Either is optional — missing probes are reported as available: false. No Log10x components needed.
Tool schema (advanced)
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
namespaces |
string[] | no | auto | Kubernetes namespaces to probe. If omitted, auto-picks up to 5 likely candidates (demo, logging, observability, otel-demo, default) plus kube-system. |
region |
string | no | from CLI profile | AWS region to probe. |
eks_cluster_name |
string | no | auto | EKS cluster to describe. Auto-selected when exactly one cluster exists in the account/region. |
bucket_hint |
string | no | retriever |
Substring match for S3 bucket names. Also matches log10x and tenx out of the box. |
forwarder_hint |
string | no | — | Override forwarder detection. Use when multiple forwarders are running. One of: fluent-bit, fluentd, filebeat, logstash, otel-collector. |
namespace_hint |
string | no | logging or detected |
Preferred namespace for new installs. |
skip_kubectl |
boolean | no | false |
Skip all kubectl probes (AWS-only discovery). |
skip_aws |
boolean | no | false |
Skip all AWS probes (cluster-only discovery). |