Upgrading Jets to some releases might require some extra changes. For example, the Jets project structure can possible change. Also, some version upgrades require a blue-green deployments. Here’s a summary of the releases requiring some upgrade work.
The following table summarizes the releases and upgrade paths.
|0.10.0||Bug fix: CloudFormation routing logical ids changed to allow multiple routes to point to the same controller action. Also removed the managed
|0.9.0||CloudFormation Logical ids changed to be more concise.||Yes|
The following section provides a little more detail on each version upgrade. Note, not all versions required more details.
Some notable changes for version 1.2.0:
- For binary support, the API Gateway binary_media_types settings needs to have
multipart/form-data. With this version, automated blue-green deployments was introduced. So Jets will do an automated blue-green deployment as part of adding the
- Jets also added managed custom domains for vanity endpoints. This requires an additional minimal Route53 IAM permission. This is noted in Minimal Deploy IAM. You will have to add this permission to your IAM deploy permission.
jets upgrade:v1 command was introduced here. You can use it to upgrade the code structure.
In this version, the managed
Jets::WelcomeController was removed. This means you’ll have to update your
You can use the
jets upgrade:v1 command to automatically update the
The reason a blue-green deployment sometimes required is that enough of Jets has changed where a regular CloudFormation stack update rolls back. An example is in
v0.9.0, Jets changes a few of the CloudFormation logical ids. In this case, CloudFormation fails to create Lambda functions with the same name and switch over to them because the Lambda functions already exist with their old logical ids. If you’re seeing the CloudFormation stack rollback after upgrading, you might want to try a blue-green deployment.
It is easy to do a blue-green deployment with Jets, and you will only need to do a blue-green deployment once after upgrading Jets for that version. Once done, you can normally deploy again.
Important: With blue-green deployments, the API Gateway endpoint will change. Any applications referencing the endpoint will need to be updated. For this reason, it is recommended to use an API Gateway Custom Domain, so you do not have to update the endpoint in the future.
Here’s a typical in-place deploy:
cd demo # your project bundle update jets deploy # in place deploy
For a blue-green deployment, you use
JETS_ENV_EXTRA to create a brand new Jets environment. You then switch to it and destroy the old environment. First, create the new environment:
cd demo # your project bundle update JETS_ENV_EXTRA=2 jets deploy # creates an additional jets environment for your app
Then update the Gateway API Custom Domain to point to the newly deployed
Gateway API Custom Domain
- Test the new environment and make sure you’re happy with it.
- Go to API Gateway Console.
- Click on Custom Domains.
- Find the Custom domain you are currently using and click on it.
- Update the custom domain so it points to the newly created Jets environment.
- Make sure there’s no traffic hitting the old Jets environment. You can do this by checking out the CloudWatch metrics. Nothing should be hitting it aside from the pre-warming requests. You can disable the pre-warming requests manually by using the CloudWatch console also.
- Destroy the old environment.
Pro tip: Use the <- and -> arrow keys to move back and forward.