This article discusses how to set up the Fastly full page cache service in your Magento Commerce Cloud project if you are using the Magento Commerce Starter plan.
Stages of Fastly setup and configuration (overview)
- Install the Fastly module locally, then push to the Integration, Staging, and Master environments.
- Submit a support ticket requesting to add Staging and Master to the Fastly service.
- Enable and verify Fastly on Staging and Master:
- Enable Fastly in Magento Admin
- Verify Fastly using the cURL command
- Submit a support ticket requesting a TXT record for domain validation (Master).
- Configure DNS settings for Master before going live:
- Point the production domain to Fastly in your DNS record
- Add the production domain to the Cloud project domains
- (Optional) Configure DNS for subdomains on Master (in case of pre-launch testing).
Related documentation:
- Magento DevDocs: Fastly
- Github: fastly-magento2 module documentation
- Fastly documentation: Guides
- Magento Support Knowledge Base: How to submit a support ticket
Stage 1: Install Fastly locally, then push to other branches
The installation steps are documented in details on the DevDocs, see the Set up Fastly article.
Use latest Fastly version
If your version of Fastly is out-to-date, you may experience issues — from security problems to complete Fastly failure, which leads to a dramatic decrease in your site's performance.
Stage 2: Submit a support ticket requesting to add Staging and Master to Fastly
You must submit a support ticket requesting the Cloud Infrastructure Team to add your Staging and Master environments to the Fastly service. In this ticket, you must specify:
- Origin URL's of your Staging and Master environments.
- Domain name of your Production site and the subdomain names you are using for pre-launch testing (if any).
See the Adding Staging branch to your Cloud project section below for more information.
Find origin URL
To find the origin URL of an environment, follow these steps:
- Access your Cloud Project Web Interface.
- Select the environment (Staging, Master) in the left navigation pane.
- Click Access site. The environment URL's are displayed in the dialog under Web Access.
Related documentation on DevDocs:
Stage 3: Enable and verify Fastly on Staging and Master
To start using Fastly on your Staging environment, follow these steps:
- Enable Fastly in Magento Admin.
- Verify Fastly configuration using the cURL command.
These steps are also required for the Master environment, but you need to configure your DNS settings to start using Fastly on your Production domain.
See the following sections of this article for more info:
- Tasks completed by Cloud Infrastructure Team to add Staging to Fastly service
- DNS configuration on Staging and Master
3.1. Enable Fastly in Magento Admin
The Cloud Infrastructure Team adds the Fastly tokens (Service ID and API Key) as environment variables to your Staging and Master environments. Once added, the values of these environment variables should be automatically transferred to the Fastly settings of your Magento Admin.
To enable Fastly in Magento Admin, follow these steps:
- Access the needed environment.
- Log in to Magento Admin as an administrator.
- Go to Stores > Settings > Configuration > Advanced > System.
- In the right pane, expand the Full Page Cache section.
- Go to the Caching Application menu:
- Clear the Use system value checkbox.
- Select Fastly CDN from the drop-down list.
- Expand the Fastly Configuration section.
- Verify that the values for the Fastly Service ID and Fastly API key settings are displayed in the corresponding fields.
- Click Upload VCL to Fastly to submit your configuration.
- Click Save Config at the top of the page.
- Clear cache according to the notification.
Upload VCL to Fastly: no actual snippet needed when enabling Fastly
At the stage of enabling Fastly on your environment, clicking Upload VCL to Fastly does not require to upload any actual VCL snippets. In this case, clicking this button enables the entire Fastly service based on the specified Fastly tokens and the settings you have specified.
Locate Fastly tokens in environment variables
If the Fastly tokens have not been automatically transferred from the corresponding environment variables, locate these variables in your Project Web Interface and manually copy their values to the Magento Admin settings.
To locate the environment variables that contain the Fastly tokens in your Project Web Interface, follow these steps:
- Access your Cloud Project Web Interface.
- Select a branch in the left navigation menu.
- In the central window, click Configure Environment.
- Go to the Variables tab.
- Find the following variables:
env:CONFIG__DEFAULT__SYSTEM__FULL_PAGE_CACHE__FASTLY__FASTLY_SERVICE_IDcorresponds to Fastly Service IDenv:CONFIG__DEFAULT__SYSTEM__FULL_PAGE_CACHE__FASTLY__FASTLY_API_KEYcorresponds to Fastly API Key
- Click the variable and copy its value to later add it in Magento Admin.
Related documentation on DevDocs:
3.2. Verify Fastly configuration using cURL command
You need this step to make sure the Fastly settings and tokens have been applied successfully and your site uses the Fastly's full page cache.
Related documentation on DevDocs:
Stage 4 (Going Live): Submit a support ticket requesting a TXT record for domain validation (Master)
When ready to go live, you must submit a support ticket requesting a TXT record to validate your Production domain. In this ticket, you must specify the final production domain name of your site (the one you go live with).
As a resolution to this ticket, you receive a TXT record to be added to your DNS record. Once the TXT record is added, and your domain is successfully validated, the Cloud Infrastructure Team issues an SSL certificate for your Production domain.
Do not to close the support ticket after receiving the TXT record but reply to the ticket letting the Cloud Infrastructure Team know you have added the TXT record to your DNS settings so that they could start the domain validation.
We recommend submitting this support ticket before adding the new production domain name to your DNS record settings and on the Domains tab of your Cloud Project Web Interface project.
Stage 5 (Going Live): Configure production DNS settings (Master)
If you are using production subdomains for the pre-launch testing, follow the steps from this stage on each of your subdomains. For details, see Step 6: Configure Fastly for subdomains on Master (optional).
As a Fastly prerequisite for going live, make sure Fastly has been enabled in Magento Admin and verified using the cURL command on your Master environment.
To configure your live DNS settings using Fastly, follow these steps:
- Edit your DNS record settings:
- Add the new production domain name.
- Point the production domain to Fastly (using Fastly's CNAME or Anycast IP's).
- Add the TXT record (obtained in Stage 4) for domain validation.
- Add the new production domain name on the Domains tab of your Cloud Project Web Interface.
After performing the steps below, your site goes live. The new production domain name becomes the base URL and is configured on the Web Server (Nginx) level.
Related documentation on DevDocs:
5.1. Point production domain name to Fastly
To point your production domain to the Fastly service, follow these steps:
- Add the domain name to your DNS record settings.
- Point the domain to the Fastly CNAME or Anycast IP's.
The Fastly CNAME is prod.magentocloud.map.fastly.net; Anycast IP's are:
- 151.101.1.124
- 151.101.65.124
- 151.101.129.124
- 151.101.193.124
Use Anycast IP's instead of CNAME if your DNS provider does not support CNAME.
5.2. Add production domain on Domains tab
To add your production domain to your Cloud project via the Domains tab, follow these steps:
- Access your Cloud Project Web Interface.
- Select your Master branch in the left navigation pane.
- Click Configure Environment.
- Go to the Domains tab.
- Specify the production domain name in the Name field.
- Click Add Domain.
Stage 6 (optional): Configure Fastly for subdomains on Master
If you want to perform additional pre-launch testing on your Master environment, you may add a subdomain and use a short URL (like prod.<yoursite>.com, which is more convenient for real-life testing scenarios) instead of the long origin URL. Such being the case, you must configure the DNS settings for the subdomain separately from your main production domain.
Important: This stage should be performed before Stage 5!
To configure Fastly for Master subdomains, follow these steps:
- Submit a support ticket in which you:
- Inform the Cloud Infrastructure Team that you are doing pre-launch testing on your Master environment using a subdomain.
- Specify the subdomain name.
- Request adding the subdomain to Fastly.
- Update your DNS record:
- Add the new subdomain.
- Point the subdomain to Fastly.
- Add the subdomain on the Domains tab of your Cloud Project Web Interface.
Important aspects to consider about Fastly configuration
Adding Staging branch to your Cloud project
To add a Staging branch to your Cloud project, create a new branch from your Master branch. The Cloud Infrastructure Team adds the Staging branch for you if it is not available at the moment the Team starts processing your Fastly ticket requesting to add Staging and Master to Fastly.
Make sure the Staging branch name is spelled as "staging" (with the lowercase "s") in git. Do not use capital "S" in your branch name in git!
You may request the Cloud Infrastructure Team to add the Staging branch for you. If you do so, we recommend submitting a single support ticket requesting both to:
- add the Staging branch to your Cloud project
- add your Staging and Master environments to the Fastly service.
Related documentation on DevDocs:
- Manage branches with the Project Web Interface
- Manage branches with the CLI
- Manage your Cloud project
Tasks completed by Cloud Infrastructure Team to add Staging to Fastly service
To resolve your ticket requesting to add the Staging environment to the Fastly service, the Cloud Infrastructure Team completes these tasks:
- Configure the DNS settings and add an SSL certificate (provided by Fastly) for the environment.
- Point the origin domain name of the environment to the Fastly service.
- Add the Fastly tokens (Service ID and API Key) as environment variables to the environment.
Production environment may have subdomains; Staging may not
You may add a subdomain for your Master (Production) environment for pre-launch testing, but this functionality is not available on the Staging environment for the Starter plan.
On the Staging branch, you must use the origin URL (long one) for all purposes, including testing. You can find the URL in your Cloud Project Web Interface.
DNS configuration on Staging and Production
You must configure your DNS record to use Fastly only on your Master (Production) environment, but this is not required on Staging: DNS configuration for your Staging branch is done on the Magento Infrastructure (Cloud) side.
Once you install and configure the Fastly module on your Staging branch and the branch is added by the Cloud Infrastructure Team to the Fastly service, the branch will resolve to Fastly.
Tasks that require submitting support tickets
- Adding your Staging and Master (Production) environments to Fastly.
- Setting the production domain name for your Master environment and the subdomain name you might use for the pre-launch testing.
In this case, the support ticket is needed for the Cloud Infrastructure Team to add the corresponding domain names to the Fastly service. - Requesting a TXT record to validate your production domain and obtain an SSL certificate for your live site.