Operator Guide overview
This guide is for system integrators and operators who deploy Octostar on Kubernetes. If you are an analyst who uses the platform UI, see the User Guide instead.
You install Octostar with one script, bin/install.sh, against an existing
Kubernetes cluster. The script deploys the full platform: the Octostar API, the
Fusion knowledge layer, ClickHouse (the store for entities and relationships),
search, object storage, workflow, AI/ML services and monitoring.
Choose your path
| Situation | Use |
|---|---|
| The cluster can reach the internet | Quick start, then Online installation |
| The cluster has no internet access | Air-gapped installation |
| The cluster runs other workloads | Read Shared clusters first |
⚠️ Production — Install production systems on a highly available cluster that meets Prerequisites. Docker Desktop and single-node clusters are for labs and light testing only.
How to read this guide
- Architecture — a short orientation.
- Prerequisites — check your host and cluster.
- Quick start — the fastest path to a running platform.
- Configuration — the settings you choose at install time. Also read Storage and S3 before the first install.
- Keycloak and custom OIDC and Users and roles — single sign-on and roles.
- Online or Air-gapped installation — the full procedure.
- After go-live: Upgrading, Backup & restore, Alerting, GPU deployments and Operations & uninstallation.