Deployment Instructions
Getting Started
For deployment instructions please see the Getting Started section in the OpenFn developer docs site.
The developer docs site is built automatically from the Lightning GitHub repository. You're welcome to simply browse the repo, if you'd prefer.
General Considerations
Deployment has information on encryption, basic worker configuration, mail, storage, environment variables, and much more.
Workers has more information on workers and networking.
Adaptors has more information on adaptors and using local registries.
Benchmarking
Benchmarking contains instructions for k6 load testing.
Upgrading
Upgrading your OpenFn deployment is often as simple as modifying the image tag
in your manifest for openfn/lightning and openfn/ws-worker but depends
entirely on how you've chosen to deploy. (You may run
migrations manually, for example, or your deployment tooling may do this for
you.)
In short, you should always:
- Back up your database
- Read the Lightning changelog and the Worker changelog
- Ensure your selected Lightning and Worker versions are compatible
- Run the database migrations.
Contributors with an active support agreement will get access to new builds still under security embargo and are upgraded according to their SLAs. If you're not a contributor with an active support agreement, please contact your DevOps team for more information about how to upgrade your instance.