Upgrading

Updating Extralit¶

This guide covers the update process for Extralit across different deployment options: quickstart, Docker, and Kubernetes.

General Update Notes¶

Always backup your data before performing updates.
Test updates in a development environment before applying to production.
Check the Extralit release notes for any specific update instructions or breaking changes.
After updating, verify that all services are functioning correctly and that data is accessible.

Kubernetes Deployment Update¶

Update the extralit repository code from a release version tag, e.g. v0.2.2
```
git fetch origin tag v0.2.2 && git checkout tags/v0.2.2
```

Rebuild the package, which contains the Extralit server and web interface

First, build the extralit-frontend code

npm install --prefix extralit-frontend
npm run build --prefix extralit-frontend

Finally, build the wheel containing the built extralit-frontend/dist

cp -r extralit-frontend/dist extralit-server/src/extralit_server/static
rm -rf extralit-server/dist && python -m build -s extralit-server/

Rebuild the extralit Python client package

rm -rf extralit/dist && python -m build -s extralit/

If using Tilt for development:
Tilt will automatically detect changes and rebuild/redeploy the service.
Manually trigger a rebuild using the ↻ button in the Tilt web interface if needed.
For production updates without Tilt:
Push the updated Docker image to your repository:

docker push {DOCKER_REPO}/extralit-server:tag
docker push {DOCKER_REPO}/extralit-server:tag

Apply the updated Kubernetes configuration:

kubectl apply -f examples/deployments/k8s/extralit-server-deployment.yaml -n {NAMESPACE}
kubectl apply -f examples/deployments/k8s/extralit-deployment.yaml -n {NAMESPACE}

Monitor the rollout:

kubectl rollout status deployment/extralit-server-deployment -n {NAMESPACE}

For database schema changes:

Run migrations using the extralit_server CLI:

kubectl exec -it deployment/extralit-server-deployment -n {NAMESPACE} -- \
extralit_server database migrate

Quickstart Deployment Update¶

Pull the latest Extralit image:

docker pull extralit/extralit-hf-space:latest

Stop and remove the existing container:

docker stop extralit-quickstart
docker rm extralit-quickstart

Start a new container with the updated image:

docker run -d --name extralit-quickstart -p 6900:6900 \
  -e EXTRALIT_AUTH_SECRET_KEY=$(openssl rand -hex 32) \
  extralit/extralit-hf-space:latest

Docker Deployment Update¶

Update the docker-compose.yaml file with the latest Extralit image version.
Pull the updated images:

docker compose pull

Restart the services with the new images:

docker compose up -d

For database schema changes, run migrations:

docker compose exec extralit extralit_server database migrate

^{Powered by Swimm}