Download as PDF, PPTX
![$config_directories[CONFIG_SYNC_DIRECTORY] = '../config/sync';
Put this in settings.php](https://image.slidesharecdn.com/drupal8config-190313105742/75/Getting-Into-Drupal-8-Configuration-34-2048.jpg)
![$config['config_split.config_split.dev']['status'] = TRUE;](https://image.slidesharecdn.com/drupal8config-190313105742/75/Getting-Into-Drupal-8-Configuration-84-2048.jpg)
![if ($sitename == 'site1' && $environment == 'dev') {
$config['config_split.config_split.site1_dev']['status'] = TRUE;
}](https://image.slidesharecdn.com/drupal8config-190313105742/75/Getting-Into-Drupal-8-Configuration-93-2048.jpg)
![$settings['config_readonly'] = TRUE;](https://image.slidesharecdn.com/drupal8config-190313105742/75/Getting-Into-Drupal-8-Configuration-101-2048.jpg)
![if (PHP_SAPI !== 'cli') {
$settings['config_readonly'] = TRUE;
}](https://image.slidesharecdn.com/drupal8config-190313105742/75/Getting-Into-Drupal-8-Configuration-102-2048.jpg)
![$settings['config_readonly_whitelist_patterns'] =
[
'config_name.to.ignore',
'wildcards*allowed',
];](https://image.slidesharecdn.com/drupal8config-190313105742/75/Getting-Into-Drupal-8-Configuration-105-2048.jpg)
Uploaded byPhilip Norton
Getting Into Drupal 8 Configuration
Phil Norton's talk at DrupalCamp London 2019 covers best practices in managing configuration in Drupal. He discusses the challenges of configuration, how to export and import it effectively, and the importance of version control using Git. Additionally, he explains advanced techniques such as configuration splits for different environments and preventing configuration changes on production sites.
More Related Content
![[Srijan Wednesday Webinars] Ruling Drupal 8 with #d8rules](https://cdn.slidesharecdn.com/ss_thumbnails/d8rulessrijanwebinarapril2016-160421035926-thumbnail.jpg?width=640&height=640&fit=bounds)
Similar to Getting Into Drupal 8 Configuration
![Vibe Coding vs. Spec-Driven Development [Free Meetup]](https://cdn.slidesharecdn.com/ss_thumbnails/vibecodingvsspecdrivendevelopment-251209105622-43f455e7-thumbnail.jpg?width=640&height=640&fit=bounds)
Getting Into Drupal 8 Configuration
- 1. Getting Into Config. PhilNorton - DrupalCamp London 2019
- 2. Phil Norton. Blog atwww.hashbangcode.com Technical Lead Access Help run North West Drupal User Group @philipnorton42
- 4. Why Talk AboutConfig? ➔ Access have taken on a few 'rescue' projects. ➔ Due to relationships breaking down with other agencies. ➔ Sites are a bit of a mess. ➔ Configuration always a problem ➔ Problems range from configuration not used to being used once and forgotten. ➔ Is configuration hard?
- 5. What is thisconfig stuff anyway?
- 6. What is config? ➔Some things in Drupal are controlled by configuration. ➔ This governs how a site is put together. ➔ Modules can plug into this and define their own config. ➔ Configuration to be used to set up sites in a particular way.
- 7. Types Of DataIn Drupal 8. Content Blog post, Taxonomy terms etc. Session Logged in status, shopping carts etc. State Last cron run, API authentication details etc. Configuration Everything else
- 8. What is config? Basic sitesettings
- 9. What is config? system.site inconfig table > select * from config where name = 'system.site' limit 1G ************* 1. row ************* collection: name: system.site data: a:11:{s:4:"uuid";s:36:"02805fbf-b1c7-45a3- aa71-1f9ca4cd2736";s:4:"name";s:7:"#! code";s:4:"mail";s: 24:"noreply@hashbangcode.com";s:6:"slogan";s:50:"Code Tips, Snippets, Resources, Tutorials And Help";s:4:"page";a:3:{i:403;s:0:"";i:404;s: 0:"";s:5:"front";s:9:"/articles";}s:18:"admin_compact_mode";b:0;s: 17:"weight_select_max";i:100;s:8:"langcode";s:2:"en";s: 16:"default_langcode";s:2:"en";s:5:"_core";a:1:{s: 19:"default_config_hash";s:43:"yXadRE77Va- G6dxhd2kPYapAvbnSvTF6hO4oXiOEynI";}s:17:"mail_notification";s:0:"";} 1 row in set (0.00 sec)
- 10. What is config? system.site.yml uuid: 02805fbf-b1c7-45a3-aa71-1f9ca4cd2736 name:'#! code' mail: noreply@hashbangcode.com slogan: 'Code Tips, Snippets, Resources, Tutorials And Help' page: 403: '' 404: '' front: /articles admin_compact_mode: false weight_select_max: 100 langcode: en default_langcode: en _core: default_config_hash: yXadRE77Va-G6dxhd2kPYapAvbnSvTF6hO4oX mail_notification: ''
- 11. uuid: 02805fbf-b1c7-45a3-aa71-1 name: '#!code' mail: noreply@hashbangcode.com slogan: 'Code Tips, Snippets, R page: 403: '' 404: '' front: /articles admin_compact_mode: false weight_select_max: 100 langcode: en default_langcode: en
- 12.
- 13. Is it config? Aquiz!
- 14.
- 15.
- 16.
- 17.
- 18.
- 19.
- 20.
- 21.
- 22.
- 23.
- 24.
- 25.
- 26.
- 27.
- 28.
- 29. Permissions Field Definition Vocabulary Menu Block Placement Sitesetting Users Blog Post Taxonomy Term Menu Item Block Content Webform submission Views Default Content Taxonomy Access Control Permissions By Term Configuration Content
- 30.
- 31. Getting the configurationout of your site can be done in two ways: ➔ Download direct from site ➔ Drush export Exporting Configuration.
- 32. ➔ Configuration willneed somewhere to live first. ➔ In order for Drush to export config it needs to know where to put your config. ➔ Drupal also needs to know what directory to scan to pick up your configuration. Exporting Configuration.
- 33. Exporting Config. Create a directorythat your configuration will be kept. Best practice is to place this outside the web root. /config/default /docroot/ /vendor/
- 34. $config_directories[CONFIG_SYNC_DIRECTORY] = '../config/sync'; Putthis in settings.php
- 35.
- 37. Exporting Config. Extract zip file. Thereis your config!
- 38.
- 40.
- 41. Importing Config. ➔ Importingconfig will take whatever is in your configuration directory and apply it to your site. ➔ This will override any settings you (or your users) have changed. ➔ New configuration will be created. ➔ Deleted configuration will be removed* * Drupal protects you from deleting config that contains content.
- 42. Importing Config. Change config of system.site.yml uuid:02805fbf-b1c7-45a3-aa71-1f9ca4cd2736 name: '#! code' mail: noreply@hashbangcode.com slogan: 'Code Tips, Snippets, Resources, Tutorials And Help' page: 403: '' 404: '' front: /articles admin_compact_mode: false weight_select_max: 100 langcode: en default_langcode: en _core: default_config_hash: yXadRE77Va- G6dxhd2kPYapAvbnSvTF6hO4oXiOEynI mail_notification: ''
- 43. Importing Config. Change config of system.site.yml uuid:02805fbf-b1c7-45a3-aa71-1f9ca4cd2736 name: '#! code' mail: noreply@hashbangcode.com slogan: 'Changing the site slogan.' page: 403: '' 404: '' front: /articles admin_compact_mode: false weight_select_max: 100 langcode: en default_langcode: en _core: default_config_hash: yXadRE77Va- G6dxhd2kPYapAvbnSvTF6hO4oXiOEynI mail_notification: ''
- 44.
- 45. Importing Config. Click on viewdifferences to view a diff of the changes.
- 47.
- 50.
- 51.
- 52. drush config:export drush config:export drushconfig:export --diff drush config:export --destination drush config:export --add drush cex
- 53. drush config:import drush config:import drushconfig:import --diff drush config:import --source drush config:import --partial drush cim
- 54. drush config:get <thing> drushconfig:get drush config:get system.site drush config:get system.site slogan drush config:get system.site --include-overridden drush cget system.site
- 55. drush config:set <thing><value> drush config:set drush config:set system.site slogan "The Slogan" drush config:set system.performance css.preprocess 0 drush cset system.site slogan "The Slogan"
- 56. drush config:status drush config:status drushconfig:status --prefix=system.site drush config:status --prefix=system.site --format=json drush cst
- 57. drush config:pull <source><destination> drush config:pull drush config:pull @prod @self drush cpull @prod @self drush config:pull @prod @self:../config/default
- 58.
- 59. What is theone tool you need to rely on when using configuration?
- 60.
- 61. Working with configuration. ➔After you install Drupal, export the configuration. ➔ Commit this to git straight away. ➔ Every change to the configuration can then be exported and tracked in git. ➔ Allows you to see the changes you make. ➔ Makes collaboration much easier.
- 62.
- 63.
- 64. Deploying configuration. Local config change Export config Git commit Deploy changeto production Import config on production New feature available
- 65. Working with configuration. dev/master feature …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... feature …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... feature …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... …………… …………… …………… …………… …………… …………… …………… …………… …………… ………... config config config
- 66. Production configuration. ➔ Yoursite users can alter production configuration through using the site. ➔ Any configuration you import will overwrite existing configuration on the site. ➔ Be careful not to overwrite your site configuration. ➔ Treat the production configuration as the single source of truth. ➔ Always pull down your production configuration before starting work.
- 67. Making Configuration Changes. Production config change Gitcommit Export config Change local config Sync config to local Git commit Export new config Deploy config Import config on production New feature available
- 68. Updates. ➔ Module updatesmay change config. ➔ When you update your code, run database updates and then export the config. ➔ Then run database updates before importing config.
- 69. UUID? ➔ Every itemof configuration gets a UUID. ➔ Every site is given a UUID (stored in system.site). ➔ This can occasionally cause problems with different streams of configuration coming together. ➔ Solution here is to pick one.
- 70. Configuration Merge Conflicts? ➔Rare, but it can happen. ➔ Ensure both streams of configuration are present. ➔ Do not manually alter your configuration. ➔ Test import and export of configuration.
- 71.
- 72. Auto Install Config. ➔Add configuration to a module so when it is installed that configuration is applied to the site. ➔ Configuration files in module/config/install will be installed. ➔ Configuration files in module/config/optional will be installed if all their dependencies are met.
- 73.
- 74. Auto Install Config. ➔Although possible, it should be used sparingly. ➔ Rely on your main configuration to manage and deploy your configuration.
- 75.
- 76. Configuring Environments. ➔ Whathappens if you want to treat your staging environment differently to your production environment? ➔ The Configuration Split module will split the configuration into sections.
- 77. Configuration Split Use. ➔Repoint an API to a sandbox environment on staging. ➔ Turn off emails on your staging environment. ➔ Disable development or UI modules on production. ➔ Turn on the Shield module for dev and staging environments.
- 78. Config Split. Set up directories. Everyenvironment gets its own directory. /config/default /config/dev /config/stage /config/prod /docroot/ /vendor/
- 79. Configuration Split. Complete /Blacklist Configuration that only exists in this split. It doesn't exist in the default configuration. Conditional / Graylist Configuration that exists in the default configuration, but which is overridden on this site. eg. config for modules only enabled on this site eg. API endpoints
- 81.
- 82. Config Split. Configuration split file. uuid:3f454816-79d5-4293-91ca-67d7307e09a6 langcode: en status: false dependencies: { } id: dev label: Dev description: '' folder: ../config/dev module: dblog: 0 devel: 0 field_ui: 0 views_ui: 0 theme: { } blacklist: { } graylist: - core.extension graylist_dependents: true graylist_skip_equal: true weight: 0
- 83.
- 84.
- 85.
- 86. Config Split. Dev is nowset up. /config/default /core.extension.yml /config/dev /core.extension.yml /dblog.settings.yml /devel.settings.yml /devel.toolbar.settings.yml /field_ui.settings.yml /system.menu.devel.yml /views.view.watchdog.yml /config/stage /config/prod
- 87. Configuration Split. ➔ Youcan use drush cex and drush cim as you normally to export and import the configuration. ➔ Just make sure you have the right configuration split set to active when you do this.
- 88.
- 89. Multi-Site Configuration. ➔ Configurationsplit can be used to split configurations across different sites. ➔ Same principles apply, with some minor alterations.
- 90. Multi-site Split. Full/Complete Split Everysite is fully split away from everything else. Partial Split A default site is created and sites split away from that.
- 91. Config Split. Multi-site directories setup. Config splitcan't handle nested configurations. /config/default /config/site1/default /config/site1/dev /config/site1/stage /config/site1/prod /config/site2/default /config/site2/dev /config/site2/stage /config/site2/prod /docroot/ /vendor/
- 92. Deployments. ➔ Be carefulwith deployments to ensure that the right site (and environment) gets the right configuration imported. ➔ Activating configuration splits using logic is only half the solution. ➔ You also need to inform Drush what site configuration you want to import.
- 93. if ($sitename =='site1' && $environment == 'dev') { $config['config_split.config_split.site1_dev']['status'] = TRUE; }
- 94.
- 95.
- 96. Configuration Ignore. ➔ TheConfiguration Ignore module allows Drupal to skip certain parts of configuration when exporting or importing. ➔ Allowing a site (or split) to have a different configuration that is not part of other configurations. ➔ Essential part of multi-site configuration setups.
- 97.
- 98. Config Ignore. ➔ webform.webform.contact- ignore specific configuration. ➔ webform.webform.* - ignore any Webform in your site, but not the generic webform.settings configuration. ➔ webform.webform.contact:status - ignore just that setting. ➔ ~webform.webform.contact - do not ignore configuration.
- 99.
- 100. Preventing config changes. ➔Lock all changes to any active configuration using the Configuration Read-only Mode module ➔ Any item in configuration on disk will be locked. ➔ Useful if you want to prevent changes to certain this. ➔ Permissions, roles, site information, content types etc. are good candidates for this.
- 101.
- 102. if (PHP_SAPI !=='cli') { $settings['config_readonly'] = TRUE; }
- 103. Config Read Only. All formsthat change configuration will be locked like this.
- 104. Preventing config changes. ➔You may want to allow some changes through. ➔ Configuration Ignore will allow this as the configuration won’t be on disk. ➔ Configuration Read-only Mode has options to allow configuration to be changed.
- 105.
- 106.
- 107. Content Block Placement. ➔Content blocks are not in configuration. ➔ Their position on sites is in configuration. ➔ This creates an interesting problem where content is required to work with the configuration present. ➔ There is no real solution to this currently. ➔ https://www.drupal.org/project/drupal/issues/2756331
- 108. Configuration Originates FromA Different Site. ➔ If the UUID of your site differs from the value in system.site.yml then Drupal will refuse to use it. ➔ Make sure you understand why this has happened. ➔ To get your site UUID from the database use this: drush config-get "system.site" uuid ➔ To set your site UUID use this: drush config-set "system.site" uuid "<value from system.site.yml>"
- 109. Entities Stop ConfigurationImport. ➔ Drupal will stop the configuration importing if it detects a destructive change. ➔ Ensure that your config isn't deleting anything that contains content. ➔ Use update hooks to remove those entities before the configuration is imported.
- 110. Disabled Module Configuration. ➔If a configuration item for a module is in your configuration but the module will not be enabled after config import. ➔ Can happen if a module was added or removed but the core.extensions.yml file was not updated in git. ➔ Either remove the configuration item or ensure that the module will be enabled via config.
- 111. Configuration Is Corrupted. ➔Broken configuration can cause Drupal to crash. ➔ Missing references tends to be the main culprit. ➔ Use update hooks to sort out the configuration in the database. ➔ Export the new configuration.
- 112. Tie That AllTogether?
- 113. Everything at once. ➔Drush - used to export and import configuration. ➔ Git - the gatekeeper of the configuration. ➔ Configuration Split - allows platform and multi-site setups. ➔ Configuration Ignore - allows splits to have special configurations. ➔ Configuration Read-only Mode - prevents your users from changing config.
- 114.
- 115.
- 116.