Configuration Management in Drupal 8: A preview (DrupalCamp Alpe Adria 2014)
4 likes5,633 views
The document provides an overview of configuration management in Drupal 8. It discusses how configuration is now defined and stored in files rather than the database for easier transport between environments. It outlines the process for modifying configuration on a development site, exporting changes, and importing them into production. It also looks under the hood at how configuration objects work for developers and some caveats, like configuration changes not being atomic and the risk of breaking the site during import.
![Configuration in settings.php
$config_directories['active'] =
'sites/default/files/config_al6ppw6/active';
$config_directories['staging'] =
'sites/default/files/config_al6ppw6/staging';
The random string is for extra security.
The two directories can be out of the Drupal root.](https://image.slidesharecdn.com/cmi-d7-to-d8-dcaa-140517-140606120957-phpapp01/85/Configuration-Management-in-Drupal-8-A-preview-DrupalCamp-Alpe-Adria-2014-26-320.jpg)
![Caveat: Import Can Break Things
$ [export config]
$ rm node.type.page.yml
$ [import config]
Existing pages are orphaned and unusable; always
make a backup dump or review changes carefully!](https://image.slidesharecdn.com/cmi-d7-to-d8-dcaa-140517-140606120957-phpapp01/85/Configuration-Management-in-Drupal-8-A-preview-DrupalCamp-Alpe-Adria-2014-37-320.jpg)
![Caveat: No Consistency Check
$ [export config]
$ vim system.theme.yml
$ cat system.theme.yml # Typo in name!
admin: seven
default: barTtik
$ [import config]
An invalid configuration is imported and applied; style
is broken.](https://image.slidesharecdn.com/cmi-d7-to-d8-dcaa-140517-140606120957-phpapp01/85/Configuration-Management-in-Drupal-8-A-preview-DrupalCamp-Alpe-Adria-2014-38-320.jpg)
![Settings overrides
Configuration can be locally overridden
CSS & JS aggregation
TWIG debugging
settings.local.php
$config['system.performance']['css']
['preprocess'] = FALSE;](https://image.slidesharecdn.com/cmi-d7-to-d8-dcaa-140517-140606120957-phpapp01/85/Configuration-Management-in-Drupal-8-A-preview-DrupalCamp-Alpe-Adria-2014-48-320.jpg)
Configuration Management in Drupal 8: A preview (DrupalCamp Alpe Adria 2014)
- 1. Configuration Management Drupal Camp Alpe-Adria 2014 Fabian Bircher
- 2. Agenda Introduction Configuration Management for site builders From Drupal 7 to Drupal 8 A Closer Look at CMI CMI for Developers
- 3. Fabian Bircher Developer at Nuvole Drupal company Brussels, Parma, Prague Pioneers of Code Driven Development: configuration management for Drupal 6 and Drupal 7. @fabianbircher @nuvoleweb
- 4. Configuration Management An overview and practical introduction for site builders
- 5. Configuration Management Initiative “Site configuration information in D8 is stored in files in your library’s directory, making it much simpler to transport configuration changes such as new content types, fields, or views from development to production.” The initial goal, with some implementation differences, was reached. CMI already works in the Drupal 8 branch.
- 6. Reference Use Case Modify the configuration of a production site: Keeping the site online all the time. Developing/testing the new configuration on a development copy. Exporting the configuration changes from development and importing them in production.
- 7. Step 1 of 6: Clone Site to Dev PRODUCTION Copy: Database Full Drupal tree Files DEVELOPMENT Restore the copy
- 8. Step 2 of 6: Modify Configuration PRODUCTION Site operates normally: new users new content DEVELOPMENT
- 9. Step 3 of 6: Export Configuration PRODUCTION Site operates normally: new users new content DEVELOPMENT
- 10. Step 4 of 6: Import in Staging PRODUCTION DEVELOPMENT
- 11. Step 5 of 6: Review Changes PRODUCTION DEVELOPMENT
- 12. Step 6 of 6: Apply Changes PRODUCTION DEVELOPMENT
- 13. There's Much More... This is only the site builder's user experience. CMI is still under active development. Significant changes can still occur before Drupal 8 is released.
- 14. From Drupal 7 to Drupal 8 What changed. What improved. What's still missing.
- 15. D7 to D8: Configuration is defined Are vocabularies configuration? Are taxonomy terms configuration? If it's in the config, it's configuration!
- 16. D7 to D8: Configuration Storage Database Text files (well... text files stored in DB by default)
- 17. D7 to D8: Uniform Approach Variables DB Tables CTools Features Black magic... Text files in YAML format
- 18. D7 to D8: Staging Configuration Through Features, revert to apply Native
- 19. D7 to D8: Interface to Developers “Exportables” from CTools and bag of (incompatible) tricks “Configurables” as PHP classes (entities)
- 20. D7 to D8: Comparison D7 core D7 core + features D8 core Export full site config (no content) NO NO YES Export selected config items NO YES YES Track config changes (full site) NO NO YES Track config changes (selected items) NO YES YES Stage configuration NO YES YES Package configuration NO YES NO Reuse configuration in other projects NO YES NO Collaborate on the same project NO YES NO*
- 21. Is CMI “Features Done Right”? No. It is a nice way to replace and improve one use case for Features: making configuration exportable into text files.
- 22. Is CMI “Features Done Wrong”? No. It is a huge step forward to developers and it paves the way for additional modules that could offer the same functionality of Drupal 7 + Features in a much cleaner and more reliable way.
- 23. A Closer Look at CMI Under the hood. Caveats and pending developments.
- 24. Key-Value store Concept Unique key Potentially complex data Declarative (no logic) Implementation Files Two columns in a database …
- 25. Two Levels of Configuration Active store The real site configuration. If you only configure “D7-style”, you'll use this one and never see CMI. Staging store Temporary area for configuration files that are to be reviewed and imported.
- 26. Configuration in settings.php $config_directories['active'] = 'sites/default/files/config_al6ppw6/active'; $config_directories['staging'] = 'sites/default/files/config_al6ppw6/staging'; The random string is for extra security. The two directories can be out of the Drupal root.
- 27. A Look at the Active Store $ ls sites/default/files/config_al6ppw6/active $ Empty?
- 28. Files are in Database +---------------------------------+ | name | +---------------------------------+ | bartik.settings | | ... | | views.view.who_s_new | | views.view.who_s_online | +---------------------------------+ 166 rows in set
- 29. Why the Database? Performance It's faster than reading/parsing files. Safety No temptation to edit files “because you can”. Changes ALWAYS need to be imported! Security Less likely to leave read access accidentally open.
- 30. YAML Example: in Drupal
- 31. YAML Example: in Exported Config $ cat image.style.large.yml name: large label: 'Large (480x480)' status: true uuid: 15dda024-4160-40e2-b305 langcode: en dependencies: { } effects: ddd73aa7-4bd6-4c85-b600: uuid: ddd73aa7-4bd6-4c85-b600 id: image_scale ...
- 32. YAML Example: in Default Config $ pwd .../core/modules/system/config/install $ cat system.site.yml uuid: '' name: Drupal mail: '' slogan: '' page: 403: '' 404: '' front: user admin_compact_mode: false
- 33. YAML Example: After Install
- 34. UUIDs Everywhere Good Prevent any possible conflicts. Bad “Universally Unique” clashes with “Reusable” (especially with relations).
- 35. Caveat: CMI is for the Same Site No portability, by design The export/import cycle is assumed to be between multiple version (dev, production) of the same Drupal project.
- 36. Caveat: CMI is not Atomic $ cat user.role.authenticated.yml id: authenticated label: 'Authenticated user' weight: 1 permissions: - 'use text format plain_text' - 'access content' - 'use text format basic_html' - 'access comments' Can't package a “feature” reusing whole files. Need for an intermediate layer.
- 37. Caveat: Import Can Break Things $ [export config] $ rm node.type.page.yml $ [import config] Existing pages are orphaned and unusable; always make a backup dump or review changes carefully!
- 38. Caveat: No Consistency Check $ [export config] $ vim system.theme.yml $ cat system.theme.yml # Typo in name! admin: seven default: barTtik $ [import config] An invalid configuration is imported and applied; style is broken.
- 39. Pending: Install from Existing Config Issue 1613424 Idea: create a clean copy (all config, no content) of a production site. Theoretically, possible by providing an “install fom existing config” choice as if it were an installation profile (see issue for discussion).
- 40. Pending: Robust Synchronization Issue 2121751 Idea: Synchronize sites in a stable way, handling possible conflicts. Use case: handle gracefully the case where the same View was created independently on production and development (see issue for discussion).
- 41. CMI for Developers Configurables. How to work with configuration.
- 42. Configurables As everything in Drupal 8, object-oriented interface: abstract class ConfigEntityBase Namespace DrupalCoreConfigEntity
- 43. Configurables are Entities class ConfigEntityBase extends Entity { ... } DrupalCoreEntityEntity |- DrupalCoreConfigEntityConfigEntityBase - DrupalCoreEntityContentEntityBase Two namespaces: one for config, one for content.
- 44. Retrieving Configuration Objects Drupal::config($name) Where $name is the configuration object (filename of the YAML file, without the .yml extension). Example: $site_name = Drupal::config('system.site') ->get('name');
- 45. Modifying Configuration Objects Drupal::config('system.site') ->set('name', 'Drupal 8 test') ->save(); The active store is immediately modified. The staging store is not used.
- 46. Drush 7.x Integration config-list (cli) List config names by prefix. config-export (cex) Export config from the active store. config-import (cim) Import config from a config dir. config-get (cget) Display a config value, or a whole configuration object. config-set (cset) Set a config value directly in the active configuration.
- 47. Configuration EVERYTHING? variable_xxx() is dead! How is the time of the last cron run saved? State API to the rescue! Environment specific settings Separation of configuration, state and content Content staging not implemented yet
- 48. Settings overrides Configuration can be locally overridden CSS & JS aggregation TWIG debugging settings.local.php $config['system.performance']['css'] ['preprocess'] = FALSE;
- 49. CSV workflow PRODUCTION Clone site don’t touch config Pull from git Import configuration DEVELOPMENT Insall clone Configure Export configuration into staging Commit&push to git
- 50. More… Jam’s virtual drupal camp featuring Rob Bayliss https://www.youtube.com/watch?v=St9s7DqFR7o
- 51. Thank you for your attention