Skip to content

Latest commit

 

History

History
62 lines (39 loc) · 4.22 KB

synchronize_sites.md

File metadata and controls

62 lines (39 loc) · 4.22 KB
Raw

Synchronize Sites

amazee.io leverages Drush and Drush Aliases to run site synchronizations. You need the aliases.drushrc.php file correctly placed in order for site synchronizations to work, see Drush Configuration Files

Synchronizing Databases

dsql @<site>

This command synchronizes the Database from the given site to the site you're running the command from.

Examples
  • dsql @prod inside the local Docker Container: Synchronizes the database from the prod site into the local Docker database
  • dsql @staging while connected via SSH to the develop site: Synchronizes the database from the staging site into the database on the develop site.
Remarks

dsql is actually a Bash alias for drush sql-sync $1 default -d -v

{% hint style='info' %} We suggest though to use dsql in stead of drush sql-sync, as there is a danger to switch the source and destination of the command and with that synchronize in the wrong direction and override a production database!. {% endhint %}

{% hint style='info' %} drush sql-sync and also dsql will not remove a possible existing database on the target site. Already existing tables will be completely overwritten though if they exist on the source database. Existing tables on the target database, which do not exist on the source database, will still exist and can cause issues (like when enabling a new module that will not install because a new table already exists). In order to have an exact copy of a source database on the target database, run drush sql-drop first and then dsql. {% endhint %}

Synchronizing Files

dfiles @<environment>

This command synchronizes the file directory from the given site to the files directory of the site you're running the command from. This command needs a Drupal site correctly running, as it needs to bootstrap Drupal in order to discover the location of the files directory.

Examples
  • dfiles @prod inside the local Docker Container: Synchronizes the files directory from the prod site into the local files directory.
  • dfiles @staging while connected via SSH to the develop site: Synchronizes the files directory from the staging site into the files directory on the develop site.
Remarks

dfiles is actually a Bash alias for drush rsync $1:%files default:%files -d -v

{% hint style='info' %} We suggest though to use dfiles in stead of drush rsync, as there is a danger to switch the source and destination of the command and with that synchronize in the wrong direction and override production files!. {% endhint %}

{% hint style='info' %} drush rsync and also dfiles will not remove already existing files on the target files directory. Already existing files will be overwritten though. Please see https://drushcommands.com/drush-8x/rsync to learn more about additional parameters for drush rsync {% endhint %}

Pro Tipp: Do not synchronize files - use Stage File Proxy

Synchronizing files can take very long and use huge amount of storage space. In order to prevent that, amazee.io suggest to use the Drupal Module Stage File Proxy.

Stage File Proxy will tell Drupal to connect to the production site and download a requested file if it does not exist on the current site. With that the need to synchronize files to local Docker Sites or any development sites is completely gone.

amazee.io has full support for Stage File Proxy and exposes an environment variable called AMAZEEIO_PRODUCTION_URL which contains the URL to the production site. Stage File Proxy supports setting the production URL via settings.php. Additionally the functionality of the module can be disabled without the need to uninstall the module. This is required on production sites, as on production sites the module does not make sense, but selective deinstalled modules is very hard to achieve with Configuration Management or Features.

Please see https://github.com/amazeeio/drupal-setting-files for examples on how to use Stage File Proxy with amazee.io (check the development.settings.php and production.settings.php files for your Drupal Version).