Overview
The operator provisions and maintains the platform through an automated installer and a deploy process based on versioned images. The goal is to bring up and update the installation predictably, with rollback on hand.
Prerequisites
- Infrastructure access (single server or cluster).
- Image registry credentials and the domain's DNS/TLS.
Step by step
- Provision the infrastructure (single server or cluster) with the installer.
- Configure domains, DNS and TLS certificates.
- Deploy the platform's versioned image.
- Run database migrations and verify service health.
- For updates, deploy the new version with a gradual rollout strategy.
Settings & options
- Environment variables: installation secrets and parameters.
- Versioned images: pin the version to deploy (avoid generic tags in production).
- Migrations: run migrations as a controlled deploy step.
Use cases
- Stand up a new installation from scratch.
- Update to a new version with rollback available.
Tips, limits & best practices
- Always have the rollback command written down before starting a deploy.
- Update one service at a time and verify health before proceeding.
- Never expose secrets in versioned files.
Troubleshooting
- Service won't start: check environment variables and service logs.
- Migration failed: check database connectivity and run the migration in isolation.