As a best practice for managing your code and updating your live site and stores, we strongly recommend following a development and deployment process. This process includes at a minimum developing code in code branches, using a testing or staging server, deploying to staging and testing, then finally deploying to production and testing.
Depending on your environments and Magento version, you may have additional best practices, recommended, or required steps. This article walks through the general processes and provides additional in-depth links for more information in DevDocs.
Environment and technologies
- Magento Commerce
- Magento Commerce (Cloud)
Prerequisites
See the prerequisites and requirements per Magento version (select another version in DevDocs to review that information):
Magento Commerce deployment
We include a couple options for deploying your code for Magento Commerce based on the size of your environment.
Pipeline Deployment
For advanced deployment reducing downtime and ensuring consistent configurations across Magento environments, we recommend Pipeline Deployment (requires 2.2). We recommend this deployment method for anyone with a large site who does not want downtime during deployment.
Environments
- Development system: Machine on which developers work to customize code; and install extensions, themes, and language packages from Magento Marketplace. In addition, you make all configuration changes on your development system. You can have many development systems.
- Build system: One system on which you deploy static assets and compile code for your production system. Because you build these assets on a system not in production, your production system’s downtime is minimized. Your build system does not have to have Magento installed on it. It needs only the Magento code but no database connection is required. Also, your build system doesn’t need to be a physically separate server.
- Staging system: Optional. You can optionally set up a staging system to use for final testing of all integrated code, including User Acceptance Testing (UAT). Set up a staging system the same way you set up a production system. Except for the fact that staging is not your live store and doen’t process orders from customers, it’s identical to production.
- Production system: Your live store. You should make minimal configuration changes here and no changes to websites, stores, store views, products, or the catalog. You should make all those types of changes in your development system.
Deployment Process
After you have modified your code and configured your system, you can use a command to generate a PHP file (config.php) populated with all configuration information including modules, store configurations, sensitive data, and more.
You add the config.php file to your Git branch for compiling through your build system. The code and configurations are then deployed to Staging (optional) and Production.
Once you have generated the file, and configuration included in the file is read-only through the Magento Admin.
To modify or remove existing settings, you need to manually edit the file, located at app/etc/config.php. To add new configurations to the file, you can follow the steps to generate the file. New configurations are appended to the file.
Single Machine Deployment
For smaller merchant installations, we recommend single machine deployment. This process may incur a longer deployment and downtime process.
Magento Commerce (Cloud) deployment
Magento Commerce (Cloud) includes multiple environments for your Pro and Starter plans to best develop, test, and deploy your stores. You develop and test initially in your Integration environments. When code is ready for further "live" testing, you deploy to Staging, a pre-production environment with all Production services available. When all testing and UAT is complete, you can deploy to Production to complete go live steps.
Cloud Environments
All Cloud plans receive a set of environments for developing, testing, and going live. These environments are read-only, receiving deployed code from your local.
Starter environments:
- Integration: The ultimate developer environments, Integration provides three testable environments. Each environment includes an active Git branch, database, web server, caching, services, environment variables, and configurations.
- Staging: We highly recommend you create an active staging branch as one of the three Integration environments. Create this branch directly from master. As code and extensions pass your tests, you can merge your Integration branches to staging. This Staging environment becomes your pre-Production testing environment. It includes the staging active branch, database, web server, caching, services, environment variables, configurations, and Production services like Fastly and New Relic.
- Production: When code is ready and tested, all code merges to master for deployment to the Production live site. This environment includes your active master Git branch, database, web server, caching, services, environment variables, and configurations. This environment includes additional services like Fastly.
Pro environments:
- Integration: The ultimate developer environment, Integration provides eight testable environments including a master. Each environment includes an active Git branch, database, web server, caching, services, environment variables, and configurations. Actively develop, deploy, and test your code before merging to master to push to Staging.
- Staging: As code and extensions pass your tests, deploy the Integration master Git branch to Staging for pre-Production testing. This environment includes a database, web server, caching, services, environment variables, configurations, and Production services like Fastly and New Relic.
- Production: When code is ready and testing complete, deploy the Integration master Git branch into Production for your live store. The container includes a three node high-availability architecture for your data, services, caching, and store. This is your live, public store environment with environment variables, configurations, and Fastly.
For detailed information, see:
- Starter architecture and deployment process content
- Pro architecture and deployment process content
Cloud Development and Deployment
For development, you work in Git branches on your local and push updates to the remote Git branch. This kicks off build and deploy scripts to automatically compile, build, and deploy code to an Integration environment.
We recommend developing in a series of branches, adding extensions, third party integrations, themes, and your custom code incrementally. Adding everything at once to build and deploy into one branch could encounter issues and dependencies.
Every push of code deploys to a full Integration environment with applications and services to fully test your sites and stores.
When ready, you can then deploy to Staging. Deployments can also be incremental to Staging to test in a pre-production environment with full production services and features. We recommend using sandbox credentials for some services, like payment gateways, in this environment.
Finally, you can deploy to Production to complete testing and configurations and go live.
For continuous integration, you can quickly follow this process and use features like Configuration Management (or Pipeline Deployment) to reduce deployment time (moving static content deploy to build phase) and ensure consistent configurations across environments.
More information
Magento Commerce:
- Configuration Guide
- Pipeline Deployment (requires 2.2)
- Single machine deployment
Magento Commerce (Cloud):
- Starter architecture and deployment process content
- Pro architecture and deployment process content
- Deploy your store process, walk-through, and content from local to Integration to Staging and Production
- Go live content for launching
- Configuration Management (or Pipeline Deployment), requires 2.1.4 and later, 2.2 and later