Upgrading To Servd's Ingress Platform

Upgrading to Servd's new ingress platform is a simple process for the majority of projects and should only take a few minutes to complete.

Important Notes #

  • Upgrading will require updates to the DNS records being used for any domains pointing to Servd. Make sure you know where your DNS records are configured and that you have the ability to change them before proceeding.
  • The vanity domains associated with your project will change during the upgrade. If these are being used within the project's codebase or by any external services (such as static site generators) they will need to be updated in those locations.
  • Once the upgrade has been started, we'll also keep the old setup running for 14 days, so you have this time to update your DNS records and allow the change to propagate. During this time you can also cancel the upgrade which will restore the project to its previous configuration.
  • Private load balancers are still supported on the new platform, but private IPs are not. Any existing Private Load Balancer addon will be carried over during the upgrade, but any existing private IP will not.
  • There is now a limit on the number of domains that can be used as Primary Domains for an individual project. The upgrade process will let you know if you need to take any action due to this.
  • By default, static files, such as JS and CSS, will be cached in the ingress platform's edge caches. If these files are requested without any cache-busting query parameters, then old content may be returned when a new bundle is deployed. To get around this, static file edge caching can be disabled in the project's Assets page or cache-busting query parameters can be added to the static file URLs.

Upgrading #

  1. Visit your project's Domains page in the Servd dashboard.

  2. If your project is ready to be upgraded you will see an Upgrade panel. Click the 'Upgrade Now' button to continue.

  3. The following screen details the changes that are going to be made, along with any issues we have detected that might prevent the upgrade from going smoothly. Read through this information to get an understanding of how your domains will be organised after the upgrade has completed.

  4. Primary Domains

    These are the domains that end users will use to interact with the project. There is a limit to the number of Primary Domains that a project can have, but each Primary Domain can have an unlimited number of subdomains. We'll group any existing domains that you have registered into their appropriate Primary Domains as part of the upgrade process.

    If the upgrade requires more Primary Domains than your project's plan allows, you will be prompted to either purchase one or more Primary Domain Plan Addons, or remove one or more Primary Domains from the upgrade process.

    If you have any Primary Domains listed that you think should be converted to Team Domains, you can deselect them from the list of Primary Domains (more info on Team Domains below)

  5. Redirect Domains

    These are domains which are only acting as redirects to your Primary Domains. You can register as many of these as you need.

  6. Team Domains

    Team Domains are domains that can be used across all of the projects owned by a single team. This can be useful for agencies who want to provide a branded preview link for their projects.

    Team Domains are created by request, so get in touch to ask us to add one to your team and we'll walk you through the process. This can be done post-upgrade.

  7. If everything looks good, hit the 'Accept and Continue' button to run the upgrade!

  8. For each Primary Domain we need to verify ownership, activate SSL and update DNS records to repoint the domain. Instructions for each of these steps can be found be clicking the associated buttons next to your Primary Domains.

  9. For each Redirect Domain the associated DNS records will need updating as instructed and the domain will then need to be checked by clicking the 'Validate DNS' button to fully activate it.

  10. The old configuration for your domains will remain active for 14 days, giving you time to get your new Primary Domains and Redirect Domains activated and for DNS changes to roll out.

    During this period you will also see the option to roll back the upgrade at the top of the Domains page. This will immediately restore the project to its old settings and remove any configuration from the new ingress platform.

  11. One everything is verified and DNS records have been updated, you're done!