Deployment

Indexify is a Function Execution Engine, not a container orchestration engine. Self Hosting Indexify involves -

1. Deploying the Indexify Server
2. Building and Deploying Container Images capable of running functions of your workflow.
3. Deploying your Graphs to Indexify Server using the SDK.

Indexify doesn’t depend on Kubernetes or Docker, it is very flexible and can be deployed in the following manner -

• Bare Metal and VMs
• Docker Compose
• Kubernetes (or any other container orchestrator)

​

Bare Metal

​

Download Indexify Server and Python SDK

• The server can be downloaded from here.
• Install the Python SDK using pip.

pip install indexify

​

Start Server

Start the server on one machine. Read the configuration reference to understand how to customize the server to use blob stores for storing function outputs.

indexify-server

​

Start Executor

Start as many executors you want in different machines.

indexify-cli executor --server-addr <server-ip>:<server-port>

​

Docker Compose

You can spin up the server and executor using docker compose, and deploy and run in a production-like environment. Copy the docker-compose.yaml file from here.

docker compose up

This starts the server and two replicas of the executor in separate containers. Change the replicas field for the executor in docker compose to add more executors (i.e parallelism) to the workflow.

This uses a default executor container based on Debian and a vanilla Python installation. We generally provide docker compose files for local testing of every example project in the repository.

​

Kubernetes

We provide some basic Helm charts to deploy Indexify on Kubernetes. If you’d like to try with your own cluster, check out the instructions.