What you’ll learn
  • how to upgrade Webiny from 5.42.x to 5.43.x

Make sure to check out the 5.43.0 changelog to get familiar with the changes introduced in this release.

Step-by-Step Guide
anchor

1. Upgrade Webiny Packages
anchor

Upgrade all Webiny NPM packages by running the following command:

Once the upgrade has finished, running the yarn webiny --version command in your terminal should return 5.43.0.

2. Run the Upgrade Command
anchor

The next step is to run the project upgrade:

3. Breaking Changes❗
anchor

Amazon OpenSearch Service - VPC Configuration Issue (#4532external link)
anchor

📝📝📝

Prior to this release, when deploying a Webiny project with the existing Amazon VPCexternal link configuration in place, the Amazon OpenSearch service that Webiny deploys would not get correctly attached to the specified Amazon VPC (related subnets and security groups).

For example, the following configuration would not work as expected. Contrary to the expectation, the deployed Amazon OpenSearch cluster would not be attached to the specified OPENSEARCH_PRIVATE_SUBNETS subnets and OPENSEARCH_SECURITY_GROUPS security groups:

apps/core/webiny.application.ts

With this release, the underlying issue should no longer occur, and the above configuration will work as expected—with one minor change: instead of using elasticSearchDomainVpcConfig, users should now use opensearchDomainVpcConfig.

For more information on this change and also how to upgrade your existing Webiny project, please refer to the 5.43.0 migration guide guide.

Breaking Change❗

Because of the fact that, with this fix in place, the VPC configuration now gets correctly attached to the Amazon OpenSearch cluster, redeploying an existing Webiny instance will cause the cluster to be DESTROYED AND RECREATED️, which means all data in the existing cluster will be lost

Luckily, the data can be recreated via the Elasticsearch Reindexing Taskexternal link.

For more information on how to migrate your existing Webiny project to the new VPC configuration and also how to safely reindex your data, please refer to the 5.43.0 migration guide guide.

4. Deploy Your Project
anchor

Proceed by redeploying your Webiny project:

Make sure you deploy the entire system using the command shown above! You have to deploy all apps before using the system. Partial deploys will cause the upgrade to be applied incorrectly.
As stated in the Upgrade Webiny section, we recommend that you first deploy your changes into one of your pre-production environments, like dev or staging.
Learn more about different deployment environments in the CI/CD / Environments key topic.