Installation

Warning

This chapter is not written yet. The only installation material that exists today covers local development setup through environment variables, which is documented under Configuration.

Before this chapter can be written, the delivery shape has to be settled. Open questions:

  • How is ELS Compass delivered to a customer: RPM packages, containers, an installer script, or an appliance image?

  • What are the supported operating systems and versions?

  • What are the hardware requirements, split by CPU-only and GPU deployments?

  • Which components can be co-located and which must be separate hosts: API, ingestion workers, OpenSearch, Valkey/Redis, the LLM runtime?

  • Which OpenSearch or Energy Logserver versions are supported, and what does the platform expect to already exist there?

  • How are the embedding and reranking models distributed, given that they are read from models/embeddings and models/reranking on disk?

  • What does the upgrade path look like between versions?

Planned Structure

  1. Requirements: hardware, operating system, network, dependencies.

  2. Deployment topologies: single node, split worker, multi-node with shared coordination.

  3. Installation of the API service.

  4. Installation of ingestion workers.

  5. OpenSearch and Energy Logserver preparation.

  6. Model distribution and placement.

  7. LLM runtime setup.

  8. First login and administrator bootstrap, which today is covered in Bootstrap admin.

  9. Post-installation verification.

  10. Upgrade and rollback.