Built on the same architecture as Configuration Split, Config Distro provides a framework for managing configuration updates from distributions.

Requirements

The 8.x-2.x branch of Configuration Synchronizer provides filters that make it possible to use Config Distro to import configuration updates from installed modules and themes.

How to Use it

  • Install Config Distro.
  • Install one or more modules that provide Config Filter plugins that integrate with this module, such as Configuration Synchronizer.
  • Update your installed modules or themes to a new versions that include configuration changes or updates. Run database updates and clear caches.
  • If using the UI, navigate to Configuration > Development > Distribution Update (/admin/config/development/configuration/distro). Review and run updates.
  • If using Drush, use the Drush command config-distro-update to run imports.

Where to Use it

Config Distro is designed to be installed and used at the base of a site's configuration management workflow--that is, the environment where extension updates are made.

Say you have a dev > test > prod workflow, where code updates are done in the dev environment and staged to test and prod. Config Distro would be installed and used on dev, since that's where extension updates are done.

Alternately, if you have a site with only a single environment, that's where Config Distro should be installed and used, since that's where code updates are done.

If you're using Config Distro and also staging configuration updates, you'll want to run your distro updates first and then stage them to other environments.

How it Works

Config Distro provides a configuration storage for use with Config Filter. It also provides a UI parallel to core's Configuration Synchronization UI.

While Config Filter by default adds filters to core's sync config storage - the storage that's used when staging configuration from one environment to another - Config Distro adds filters to the site's active configuration storage. This means that changes are merged into the active configuration.

Supporting organizations: 
Drupal 10 compatibility and ongoing maintenance

Project information

Releases