Wie funktioniert das Drupal Configuration Update Modul?

Wenn ein Modul aktualisiert wird, kann es neue Konfigurationselemente hinzufügen oder bestehende ändern. Um diese Änderungen in Konfigurationselementen zu verfolgen, zu exportieren, zu importieren und rückgängig zu machen, kann das Modul Configuration Update verwendet werden.

Beachten Sie, dass es nicht empfehlenswert ist, Konfigurationen auf einer Live-Seite zu ändern.

Konfigurationsdateien in Drupal werden verwendet, um Informationen wie grundlegende Seiteneinstellungen, Blocklayouts, Berechtigungen, Inhaltstypen, Taxonomievokabulare usw. zu speichern. Diese Konfigurationsdateien werden als YAML-Dateien gespeichert, wobei Daten in Schlüssel-Wert-Paaren gespeichert werden. Drush kann verwendet werden, um alle Konfigurationsdateien in einer Drupal-Seite anzuzeigen:

$ drush config-list
oder
$ drush cli 

Sie aktualisieren ein Modul, und es hat entweder die von ihm bereitgestellte Standardkonfiguration geändert oder neue Konfigurationselemente hinzugefügt. Sie möchten in der Lage sein, die neuen Elemente zu importieren, die Unterschiede zwischen der Seitenkonfiguration und der geänderten Konfiguration anzuzeigen und möglicherweise auf die neu bereitgestellte Standardkonfiguration "zurückzusetzen" (oder es ist ein Update)." - Drupal.org

Konfigurationsdateien können als aktiv und Staging klassifiziert werden. Die aktiven Konfigurationsdateien sind die aktuell importierten Konfigurationen und werden in der Konfigurationstabelle in der Datenbank gespeichert. Immer wenn ein Modul oder Theme installiert wird, werden seine Konfigurationsdateien in die aktive Konfiguration der Seite importiert. Die Standardkonfigurationen eines Moduls werden in seinem config/install-Verzeichnis abgelegt. Configuration Update funktioniert, indem es die Standardkonfigurationen mit der aktiven Konfiguration der Seite vergleicht.

Das Configuration Update-Projekt besteht aus zwei Modulen - Configuration Update Base und Configuration Update Reports. Das erste ist ein Basismodul, das die Unterschiede zwischen Konfigurationen berechnet, und das zweite bietet die Benutzeroberfläche zum Generieren von Berichten.

Voraussetzungen

Das Configuration Update Base Modul benötigt das Configuration Manager Modul, das mit Drupal Core geliefert wird, und Configuration Update Reports benötigt Configuration Update Base, um aktiviert zu werden.

Herunterladen und Installieren des Configuration Update Moduls
Das Configuration Update Modul kann mit einer der folgenden Methoden heruntergeladen und installiert werden:

Verwendung der Benutzeroberfläche

1. Navigieren Sie zu Verwalten → Erweitern → Neues Modul installieren und geben Sie die .tar.gz- oder .zip-URL des Configuration Update Moduls ein und klicken Sie auf Installieren

   

2. Sobald der Downloader und das Installationsprogramm mit dem Herunterladen fertig sind, klicken Sie auf "Neu hinzugefügte Module aktivieren".
    
3. Suchen Sie Configuration Update Base und Configuration Update Reports in der Liste der Module, wählen Sie sie aus und klicken Sie auf Installieren.

Für die restlichen Methoden navigieren Sie zuerst zum Stammverzeichnis Ihrer Drupal-Seite,

$ cd /var/www/html/drupal-8.4.4

Verwendung von Composer

• Fügen Sie das Configuration Update-Paket mit Composer hinzu

$ composer require "drupal/config_update"

• Aktivieren Sie die Module Configuration Update Base und Configuration Update Reports, indem Sie zu Verwalten → Erweitern navigieren, sie auswählen und auf Installieren klicken

Verwendung von Drush

• Laden Sie Configuration Update herunter und aktivieren Sie es mit Drush

$ drush dl config_update
$ drush en config_update config_update_ui

Verwendung der Drupal-Konsole

• Laden Sie Configuration Update herunter und installieren Sie es mit der Drupal-Konsole

$ drupal module:download config_update
$ drupal module:install config_update config_update_ui

Generieren von Berichten mit Configuration Update Reports

Die Berichte zeigen die Unterschiede zwischen der aktiven Konfiguration Ihrer Drupal-Seite und der Standardkonfiguration, die von den Themes, Modulen und Installationsprofilen bereitgestellt wird. Diese Berichte können sowohl mit Drush als auch über die Benutzeroberfläche generiert werden.

Navigieren Sie zu Verwalten → Konfiguration → Entwicklung → Konfigurationssynchronisation → Registerkarte Berichte aktualisieren

Ihnen werden die folgenden Arten von Berichten angezeigt, die generiert werden können:

• Vollständiger Bericht: Listet alle Konfigurationsdateien Ihrer Drupal-Seite auf.
   
• Einzelner Konfigurationstyp: Listet die Konfigurationsdateien eines bestimmten Konfigurationsobjekts wie Aktion, Block, Ansicht usw. auf.
   
• Einzelnes Modul: Listet die Konfigurationsdateien eines bestimmten Moduls wie Devel, Pathauto, Redirect usw. auf.
   
• Einzelnes Theme: Listet die Konfigurationsdateien eines bestimmten Themes wie Bartik, Integrity, Mayo usw. auf.
   
• Installationsprofil: Listet die Konfigurationsdateien eines Installationsprofils wie Basic, Standard oder eines benutzerdefinierten Installationsprofils auf.

Klicken Sie auf die Schaltfläche "Alles", um die vollständige Liste der Konfigurationselemente aller Typen zu generieren. Eine Sache, die zu beachten ist, ist, dass die Berichte in drei Abschnitte unterteilt sind:

• Fehlende Konfigurationselemente: 

Zeigt die Konfigurationselemente an, die in der aktiven Konfiguration der Drupal-Seite fehlen und von den Modulen, Themes oder Installationsprofilen bereitgestellt werden. Diese Elemente können mit Drush oder über die Benutzeroberfläche importiert werden.

$ drush config-missing-report <type> <name>
oder
$ drush crm <type> <name>

Beispiel:  $ drush config-added-report block block.block.integrity.help 

• Hinzugefügte Konfigurationselemente:

Diese umfassen in der Regel die Elemente, die während des Site-Aufbaus hinzugefügt oder geändert wurden und nicht von den Modulen, Themes oder Installationsprofilen bereitgestellt werden.

$ drush config-added-report <name>
oder
$ drush cra <name>

Beispiel:  $ drush config-added-report system.all

• Geänderte Konfigurationselemente:

Dies sind die Elemente, die sich derzeit in der aktiven Konfiguration der Seite befinden und sich von der Standardkonfiguration unterscheiden, die von Modulen, Themes oder Installationsprofilen bereitgestellt wird. Beachten Sie, dass die Installationsprofile die Einstellungen eines Moduls im Differenz-Widget überschreiben können, da das Modul der Installationsprofilversion Vorrang einräumt.

$ drush config-different-report  <type> <name>
oder
$ drush crd  <type> <name>

Beispiel: 

$ drush config-different-report image_style image.style.max_325x325

Sie können Unterschiede sehen, zur Standardkonfiguration des Moduls, Themes oder Installationsprofils zurückkehren oder sie exportieren, um die YML-Datei anzuzeigen.

Importieren eines Elements aus der Quelle (Standardkonfiguration)

Konfigurationsdateien können aus der Standardkonfiguration des Moduls, Themes oder Installationsprofils in die aktive Konfiguration der Seite importiert werden. Diese Option ist nur für fehlende oder inaktive optionale Konfigurationselemente verfügbar.

 

1. Klicken Sie auf die Schaltfläche "Aus Quelle importieren" neben dem zu importierenden Konfigurationsobjekt.
    
2. Bestätigen Sie den Import, indem Sie auf der angezeigten Seite auf "Importieren" klicken.

Verwendung von Drush:

$ drush config-import-missing <name>
oder
$ drush cfi <name>

Beispiel: 

$ drush config-import-missing responsive_image.styles.narrow

Verwenden Sie drush config-diff <name>, um die Unterschiede zwischen aktiver und importierter Konfiguration anzuzeigen.

Exportieren eines Elements aus der Quelle (Standardkonfiguration)

Einige Konfigurationselemente können während des Site-Aufbaus hinzugefügt oder geändert werden. Diese können als YML-Dateien exportiert werden. Klicken Sie auf die Schaltfläche "Exportieren", um das Konfigurationselement zu exportieren.

Zurückkehren zur Standardkonfiguration

Um zur Standardkonfiguration des Moduls, Themes oder Installationsprofils zurückzukehren, klicken Sie im Dropdown-Menü der Schaltfläche neben dem Konfigurationselement auf die Option "Auf Quelle zurücksetzen". Klicken Sie dann auf die Schaltfläche "Zurücksetzen", um den Vorgang zu bestätigen.

Verwendung von Drush:

$ drush config-revert <name>
oder
$ drush cfr <name>

Beispiel: 

$ drush config-revert block.block.bartik_branding

Um alle Konfigurationselemente eines Moduls, Typs, Themes oder Installationsprofils zurückzusetzen, verwenden Sie drush config-revert-multiple (cfrm)

$ drush config-revert-multiple <type> <name>

Fazit

Das Configuration Update Modul ermöglicht die Vereinfachung der Verwaltung der Konfigurationsdateien von Modulen, Themes und Installationsprofilen durch die Generierung von Berichten. Es bietet auch die Möglichkeit, die hinzugefügten oder geänderten Konfigurationselemente zu exportieren und zur Standardkonfiguration zurückzukehren - sowohl über die Benutzeroberfläche als auch über Drush-Befehle.