On November 15th, 2022, Netlify will be fully removing support for the Ubuntu 16.04 (Xenial) build image. Ubuntu Xenial finished its Long Term Support period in 2021 and is no longer supported by Canonical. This means no new bug fixes and security updates, nor new versions of included software.
Builds on Xenial make up a very small percentage of total Netlify builds, but we know this is a significant change so we’re giving you time to migrate.
Timeline
Date | What happens |
---|---|
September 27th, 2022 |
First Brownout Builds using the Xenial build image will error for 10 minutes at a time during the following periods:
|
October 12th, 2022 |
Second Brownout Builds using the Xenial build image will error for 10 minutes at a time during the following periods:
|
October 18th, 2022 |
Deprecation of Xenial Build image selection
Sites will no longer be able to select the Xenial build image. Upgrading to Focal after this date will be final. |
October 26th, 2022 |
Third Brownout Builds using the Xenial build image will error for 1 hour at a time during the following periods:
|
November 8th, 2022 |
Fourth Brownout Builds using the Xenial build image will error for 3 hours at a time during the following periods:
|
November 15th, 2022 |
Xenial build image end of life. Builds using the Xenial build image will fail going forward. |
How do I know if my site is using Xenial?
If you’re not sure whether your site is building with Xenial then you can check in a few places:
- You sites list or site detail page. Sites using the Xenial image have a warning icon next to the site name.
- Your deploy logs. Check for a log line that says:
DEPRECATION NOTICE: Builds using the Xenial build image will fail after November 15th, 2022
- Your site settings. Go to Site settings > Build & deploy > Continuous Deployment > Build image selection.
What’s different about the new build image?
In May of 2021, we released a new build image based on Ubuntu 20.04 (Focal). In addition to a newer version of Ubuntu Linux, it includes some version updates to included language and software dependencies.
What will happen if I don’t update my site’s build image?
Starting on the week of September 27th we will be doing a series of “brownouts”, that means builds using the Xenial image will fail during certain hours for a finite period of time. An error will be logged in the build logs informing that Xenial image is not supported.
After November 15th, 2022, any new builds using the Xenial build image will fail. We will continue to serve traffic to your existing site, and you will still be able to deploy manually via Netlify CLI, but you will not be able to run new builds of your site on Netlify until you update to a newer build image.
How do I update my build image?
You can upgrade to the latest build image in the Netlify UI under Site settings > Build & deploy > Continuous Deployment > Build image selection.
Please note that after October 18th this change will be final. Once you upgrade to Focal, you will not be able to downgrade back to Xenial.
How can I run a test build with the new image?
One way to run a test build is through the Netlify UI:
- From your site’s Deploys page, select the current published deploy (usually the most recent production deploy).
- At the top of the deploy’s log page, click the Lock to stop auto publishing button. With deploys locked, you can run new deploys without changing your published site.
- Click the Deploy settings button, scroll down to Build image selection, and select the Focal build image.
- Go back to your Deploys page and click the Trigger deploy button.
- The new deploy will start building. If it succeeds, click Preview deploy to visit that version of your site. If the site is working normally then you’re set! Go back to your Deploys page and click Start auto-publishing to keep builds running normally, now with their fancy new build image.
- If the deploy fails or the site isn’t working properly, you will need to do some troubleshooting. If you don’t have time to do that now, you can switch back to the Xenial image and Start auto-publishing again. You can repeat the steps above when you’re ready to troubleshoot, or create a new site for testing that’s linked to the same repository. Here’s how:
- Create a brand new site by clicking the New site from Git button on your team dashboard. Be sure to link to the same repository that you use for your existing site!
- Once you’ve created your new site, go to Site settings > Build & deploy > Continuous Deployment > Build image selection and select the new build image.
- Trigger a deploy to test the new build image.
How can I make my site work with the new image?
Generally speaking, a change in available language or software dependency versions is the cause of the error. This could be a version you set yourself or one that was set for you by default when the site was first created. Here are some general steps for troubleshooting:
-
Check for error messages in the deploy log. They will often indicate which language or software dependency is causing the problem.
-
Check the Focal image included software list to find which versions are available for the dependency that is causing your issue.
-
Try setting the dependency to use an included version. Refer to the docs on managing dependencies to learn how to do this.
Note: if the dependency version was not explicitly set by you, then it’s set to a version selected by default when you created your site. You can override this as described in the dependency management docs. Select a version already installed on the image to avoid unneeded installations.
If you prefer not to set a version explicitly, you can “reset” your site defaults by re-linking your site repository, but please note that this will also remove any environment variables set in the Netlify UI. Be sure to copy your variables before re-linking, then re-enter them after re-linking.
-
Run a new test build to see if it works.
-
If it doesn’t work, and you’ve tried all available versions on the new image, you may have the option to specify a version that isn’t pre-installed on the image. Dependencies with this option are labeled in the included software list with “Any version” as one of the version options.
- For dependencies that don’t offer an option to download any version, you will need to update your site code to work with a version available on the new image. You can search for migration guides for the dependency version to help you identify necessary changes.
If you get through these steps and you’re still stuck, or if you have any other questions along the way, let us know!