Deployment¶

Nixiesearch is distributed as a single Docker container (with a special flavors for CPU and GPU inference) and can be deployed as a regular dockerized app:

Standalone: simple single-node install with Docker, with search and index API colocated within a single process. Recommended for dev environments and installs with no need for fault tolerance.
Distributed: distributed setup with separate indexer and searcher services, backed by S3-compatible block storage. Recommended for large and fault-tolerant installs.

Standalone¶

In standalone mode searcher and indexer are colocated on a single Nixiesearch process:

standalone

Standalone mode is easy to start as it enforces a set of simplifications for the setup:

only REST API based document indexing is possible.
S3-based index sync is not enabled.

To start nixiesearch in a standalone mode, use the nixiesearch standalone subcommand (where config.yml is an index mapping configuration file):

docker run -i -t -v <data dir>:/data/ -p 8080:8080 nixiesearch/nixiesearch:latest\
  standalone --config config.yml

Distributed¶

For production installs Nixiesearch can be rolled out in a distributed manner:

separate searchers and indexer. Potentially searchers can be auto-scaled, and even scaled to zero.
sync between indexer and searchers happens via S3-compatible block storage.

distributed

Nixiesearch has separate nixiesearch index and nixiesearch search sub-commands to run these sub-tasks.

Helm chart for smooth k8s deployment is planned for v0.3.