Keystone 5 deployment strategies

[jesstelford]

As Keystone 5 begins to be used in production applications, we need to ensure the deployment story for a Keystone 5 instance is clear, works well under a number of different scenarios, and covers most use cases.

Here are some possible deployment types and notes on how to deploy a Keystone 5 instance to them.

NOTE: This is a work in progress and we'll continue to fill out this list as we go

Servers

Currently supported directly with the keystone build && keystone start commands, it's possible to get a production build up and running quickly.

For more flexibility, we also have Custom Servers.

PaaS

Heroku

See: How to deploy Keystone 5 to Heroku: #1265

Docker

Stand alone Docker Image

See How to create a Docker Image for Keystone 5: #1266

Docker Clusters on Kubernetes

coming soon...

Docker Clusters on AWS ECS

coming soon...

Lambda Functions (aka: Serverless)

Deploying to a serverless environment is not compatible with the current keystone CLI tool (or Custom Servers), and requires a different approach where each app is split into its own serverless function.

Lambdas on now.sh

See How to deploy Keystone 5 to now.sh v2 (serverless): #1258

Lambdas on Apex UP

coming soon...

Lambdas with Netlify Functions

coming soon...

Lambdas with Serverless Framework

coming soon...

Lambdas with Google Cloud Functions

coming soon...

Lambdas on Cloudflare Workers

coming soon...

Lambdas on Azure Functions

coming soon...

Lambdas on AWS Lambda

coming soon...

Lambdas with Claudia

coming soon...

[nathsimpson]

I have multiple KS5 apps on Heroku. I'm here to help any way I can :)

[stale]

It looks like there hasn't been any activity here in over 6 months. Sorry about that! We've flagged this issue for special attention. It wil be manually reviewed by maintainers, not automatically closed. If you have any additional information please leave us a comment. It really helps! Thank you for you contribution. :)

[kirillrogovoy]

Just dropping a note that I couldn't use Keystone on AWS Lambda because npm i @keystonejs/keystone @keystonejs/fields create more than 500Mb of node_modules/

The AWS hard limit, as of time of writing, is 250Mb.

The problem is 90% the fields package that depends on a lot of front-end stuff (for client-side field rendering), every data adapter and its dependencies, Babel, React, and so on.

[stale]

It looks like there hasn't been any activity here in over 6 months. Sorry about that! We've flagged this issue for special attention. It wil be manually reviewed by maintainers, not automatically closed. If you have any additional information please leave us a comment. It really helps! Thank you for you contribution. :)

[bladey]

Keystone 5 has officially moved into active maintenance mode as we push towards the next major new version Keystone Next, you can find out more information about this transition here.

In an effort to sustain the project going forward, we're cleaning up and closing old issues such as this one. If you feel this issue is still relevant for Keystone Next, please let us know.