> For the complete documentation index, see [llms.txt](https://doc.ozforensics.com/oz-knowledge/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.ozforensics.com/oz-knowledge/guides/administrator-guide/telemetry/echo-oz-telemetry-receiver/oz-echo-as-a-part-of-api-decomposed-oz-k8s.md). # oz-echo as a Part of api-decomposed (oz-k8s) `oz-k8s` is the full Oz API stack as a single Helm chart – API, BIO, Echo, Web UI, nginx, MongoDB, and so on, deployed together. **Echo is always deployed; there is no toggle to disable it and no separate install step.** If you're installing this chart for the API at all, you already get Echo. **Chart:** oz-k8s, version 0.20.32, app version 6.6.3. Echo image pinned at ozforensics/echo:1.0.4. This guide only covers the Echo-specific configuration. For the full install (prerequisites, core values, storage, ingress, database setup), follow api-decomposed's own `readme.md` (and `readme-s3.md` if using S3 storage) – this document assumes you're doing that install and just need to know what's configurable about the Echo piece. Shared concepts (authentication, endpoints, configuration reference) can be found on the [parent page](/oz-knowledge/guides/administrator-guide/telemetry/echo-oz-telemetry-receiver.md). ### Prerequisites (stack-wide, not Echo-specific) * Kubernetes 1.23+, Helm 3+. * ingress-nginx + cert-manager, or Kong 2.12+. * kube-metrics-server. * Prometheus. * External PostgreSQL with the pgcrypto extension. * An RWX storage class, or S3 (see `readme-s3.md`). ### Install ```shellscript helm repo add oz helm repo update helm install my-release oz/oz-k8s --version 0.20.32 -f my-values.yaml ``` Minimum required overrides are stack-wide (`UserParams.URLs.apiURL`, `UserParams.JWT.public/private`, `UserParams.DB.*`, `UserParams.Creds.apiAdminLogin`/`apiAdminPass`, `UserParams.BIO.licenseKey`/`clientToken`, `Params.mongo.security.Password`, storage class names) – see the chart's own readme for the full list. None of these are Echo-specific; Echo rides along automatically once the stack is up. ### Echo-specific configuration (`Params.echo.*`) | Key | Default | Purpose | | ------------------ | --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | tokenKey | "" | JWT signing secret – generate with `openssl rand -base64 129 \| tr -d '\n'`. Not listed in the chart's own "Required Passwords" table despite defaulting empty – set it explicitly. | | StaticTokens | \[] | {username, token} pre-shared bearer tokens | | Passwords | \[] | {username, password} login accounts | | ServiceUsers | \[] | Usernames (from the two lists above) granted GET access to session data | | publicKeys | {} | Map of filename → PEM public key, for JWS-signed request validation | | extraEnvVarsSecret | "" | Point at a pre-created Secret instead of letting the chart generate one – must contain a base64 MONGODB\_URL key | | resources | limits 6 CPU / 6Gi, requests 2 CPU / 2Gi | Sizing | | scaling | HPA on by default, min 2 / max 5 replicas, 75% CPU target | Autoscaling | | image.tag | "1.0.4" | Override to pin a different Echo build | ### How Echo is reached Echo has no separate hostname or ingress entry. It's reachable at `/api/event_sessions`, routed through the same Ingress (or Kong HTTPRoute, if using Kong) as the rest of the API. ### Verify ```shellscript kubectl get pods -l app=echo curl https:///api/event_sessions -H "Authorization: Bearer " ``` ### Version note Echo's own repository has moved past 1.0.4 (adding cursor-based pagination and an optional conversion-funnel logging feature) but this chart still pins 1.0.4 as of version 0.20.32. If you need features from a newer Echo release, override `Params.echo.image.tag` – check with Oz Forensics first for compatibility. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://doc.ozforensics.com/oz-knowledge/guides/administrator-guide/telemetry/echo-oz-telemetry-receiver/oz-echo-as-a-part-of-api-decomposed-oz-k8s.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.