Advise: Retriever install
log10x_advise_retrieverGenerates an install, verify, or teardown plan for Log10x Retriever from a discovery snapshot, validating required AWS SQS, S3, and IRSA resources.
Instructions
Given a DiscoverySnapshot (from log10x_discover_env), produce an install/verify/teardown plan for the Log10x Retriever. Unlike Reporter + Receiver, the Retriever has no forwarder choice — it is a standalone set of workloads (indexer + query-handler + stream-worker + filter CronJobs) that read from S3 via SQS and serve an HTTP query endpoint. The advisor detects existing AWS infra (input bucket with indexing-results/ prefix, four SQS queues — index/query/subquery/stream — and an IRSA-annotated ServiceAccount) from the discovery snapshot, or accepts explicit overrides. Preflight fails closed when any required resource is missing — the Retriever depends on Terraform-provisioned infra that this advisor does NOT create. Verify probes: pods Ready, indexer processing messages, query endpoint responding, S3 indexing-results/ getting writes, SQS queue drainage. Teardown uninstalls the Helm release but leaves AWS infra alone (Terraform's concern).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | Plan scope. Default: `all`. | |
| namespace | No | Target namespace. Default: snapshot.recommendations.suggestedNamespace. | |
| infra_mode | No | How the customer provisions AWS infra. **terraform** = emit .tf module block. **cli** = emit aws-cli commands. **existing** = infra already provisioned, wizard skips infra steps and jumps to helm values. Auto-detected as "existing" when the snapshot already has all four SQS URLs + IRSA. | |
| destination | No | Destination SIEM for the kept slice (e.g. `datadog`, `cloudwatch`, `splunk`). Gates SIEM down-tier sub-sections in the offload markdown. | |
| snapshot_id | Yes | ID returned by `log10x_discover_env`. The snapshot is cached for 30 min. | |
| iam_role_arn | No | IAM role ARN for the Retriever ServiceAccount (IRSA) (module output: iam_role_arn). Auto-detected from snapshot. | |
| index_bucket | No | S3 path for indexed results (include prefix). Default: `<index_source_bucket>/indexing-results/`. | |
| release_name | No | Helm release name. Default: `my-retriever`. | |
| license_source | No | How the wizard acquires the engine license JWT. Defaults to `"signin"` — emits `signin_required` mode when no Auth0 session exists. Pass `"demo"` for a 14-day anonymous JWT. Pass `"paste"` with `license_jwt_paste` to supply an existing JWT. | signin |
| index_queue_url | No | SQS URL for index operations (module output: index_queue_url). Auto-detected from snapshot. | |
| query_queue_url | No | SQS URL for query operations (module output: query_queue_url). Auto-detected from snapshot. | |
| stream_queue_url | No | SQS URL for stream operations (module output: stream_queue_url). Auto-detected from snapshot. | |
| license_jwt_paste | No | License JWT supplied by the user when `license_source: "paste"`. | |
| subquery_queue_url | No | SQS URL for sub-query operations (module output: subquery_queue_url). Auto-detected from snapshot. | |
| index_source_bucket | No | S3 bucket for source logs (module output: index_source_bucket_name). Auto-filled from snapshot.recommendations.retrieverS3Bucket when present. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | ||
| tool | Yes | ||
| view | No | summary | |
| images | No | ||
| actions | No | ||
| summary | Yes | ||
| warnings | No | ||
| truncated | No | ||
| next_cursor | No | ||
| render_hint | No | ||
| generated_at | Yes | ||
| schema_epoch | Yes | ||
| schema_version | Yes |