Konfigurieren von OSGi

OSGi ist ein wesentlicher Bestandteil der Technologien von Adobe Experience Manager (AEM). OSGi wird zur Steuerung der AEM-Bundles und ihrer Konfiguration verwendet.

OSGi bietet standardisierte Grundbausteine – kleine, wiederverwendbare, gemeinsame genutzte Komponenten. Diese Komponenten können zu einer Anwendung zusammengefügt und bereitgestellt werden".

Dies ermöglicht die einfache Verwaltung von Bundles, da diese einzeln angehalten, installiert und gestartet werden können. Die gegenseitigen Abhängigkeiten werden automatisch verwaltet. Jede OSGi-Komponente (siehe OSGi-Spezifikation) ist in einem der Bundles enthalten.

Für die Festlegung der Konfigurationseinstellungen derartiger Bundles haben Sie folgende Möglichkeiten:

• mit der Adobe CQ Web-Konsole
• mit Konfigurationsdateien
• Konfigurieren von content-nodes ( sling:OsgiConfig) im Repository

Jede dieser Methoden kann verwendet werden, es gibt aber leichte Unterschiede vor allem in Bezug auf Ausführungsmodi:

• Adobe CQ Web-Konsole

  • Die Web-Konsole ist die Standard-Benutzeroberfläche für die OSGi-Konfiguration. In dieser Benutzeroberfläche können Sie die unterschiedlichen Eigenschaften bearbeiten, indem Sie aus vordefinierten Listen einen Wert auswählen.

    Dies ist die einfachste Methode.

  • Alle über die Web-Konsole durchgeführten Konfigurationen werden unmittelbar auf die aktuelle Instanz angewendet, und zwar unabhängig davon, welcher Ausführungsmodus gerade aktiv ist oder wie dieser zu einem späteren Zeitpunkt geändert werden könnte.

• Konfigurationsdateien

  • Enthalten die in der Web-Konsole definierten Einstellungen
  • Können in Inhaltspakete zur Verwendung in anderen Instanzen eingeschlossen werden.

• Inhaltsknoten (sling:osgiConfig) im Repository

  • Dies erfordert die manuelle Konfiguration mithilfe von CRXDE Lite.
  • Aufgrund der Namenskonventionen der sling:OsgiConfig-Knoten können Sie die Konfiguration an einen bestimmten Ausführungsmodus knüpfen. Sie können sogar Konfigurationen für mehrere Ausführungsmodi im selben Repository speichern.
  • Alle Konfigurationen werden sofort angewendet (abhängig vom Ausführungsmodus).

Unabhängig von der verwendeten Konfigurationsmethode bieten die Konfigurationen Folgendes:

• Sie gewährleisten, dass das Kopieren oder Replizieren von Inhalten im Repository identische Konfigurationen erzeugt.
• Sie ermöglichen es Ihnen, Konfigurationen entweder zur Verbesserung der Sicherheit oder für Aktualisierungen an das FileVault- oder Subversion-Tool zu übermitteln.
• Sie können in Paketen gespeichert werden, die zur Einrichtung anderer Instanzen verwendet werden können.
• Sie ermöglichen es Ihnen, mithilfe von Skripts Konfigurations-Rollouts zur Verteilung der Konfigurationsdetails durchzuführen.

OSGi-Konfiguration mit der Web-Konsole

Die Web-Konsole in AEM bietet eine standardisierte Benutzeroberfläche für die Konfiguration der Bundles. Die Registerkarte Konfiguration dient zur Konfiguration der OSGi-Bundles und bildet deshalb den zugrunde liegenden Mechanismus für die Konfiguration der AEM-Systemparameter.

Alle Änderungen werden unverzüglich auf die entsprechende OSGi-Konfiguration angewendet. Es ist kein Neustart erforderlich.

Um eine Konfiguration mit der Web-Konsole zu aktualisieren, gehen Sie folgendermaßen vor:

1. Öffnen Sie die Registerkarte Konfiguration in der Web-Konsole, indem Sie einen dieser Schritte ausführen:

   • Öffnen Sie die Web-Konsole über den Link im Menü Tool > Vorgänge. Nach dem Anmelden bei der Konsole können Sie das Dropdown-Menü von:

     OSGi >

   • die direkte URL; Beispiel:

     http://localhost:4502/system/console/configMgr
     Eine Liste wird angezeigt.

2. Wählen Sie das Bundle aus, das Sie konfigurieren möchten, indem Sie eine dieser Optionen auswählen:

   • Klicken Sie auf das Symbol Bearbeiten für dieses Bundle.
   • Klicken Sie auf den Namen des Bundles.

3. Ein Dialogfeld wird geöffnet. Hier können Sie nach Bedarf Änderungen vornehmen. Beispielsweise können Sie für die Protokollebene INFO festlegen:

   

   HINWEIS

   Aktualisierungen werden im Repository als Konfigurationsdateien gespeichert. Um diese anschließend zu finden (z. B. um sie in ein Inhaltspaket einzuschließen, das auf einer anderen Instanz verwendet werden soll), sollten Sie die beständige Identität ( PID) beachten.

4. Klicken Sie auf Speichern.

   Ihre Änderungen werden unmittelbar auf die relevante OSGi-Konfiguration des aktuellen Systems angewendet. Es ist kein Neustart erforderlich.

   HINWEIS

   Sie können nun die zugehörige(n) Konfigurationsdatei(en) suchen. z. B. zur Verwendung in einer anderen Instanz in ein Inhaltspaket einschließen.

OSGi-Konfiguration mit Konfigurationsdateien

Konfigurationsänderungen, die mithilfe der Web Console vorgenommen werden, bleiben im Repository als Konfigurationsdateien ( .config) unter:

/apps

Diese können in Inhaltspaketen eingeschlossen und in anderen Instanzen wiederverwendet werden.

Die Web-Konsole zeigt nicht an, wo im Repository Ihre Änderungen gespeichert wurden, sie können aber einfach gefunden werden:

1. Erstellen Sie die Konfigurationsdatei, indem Sie eine Änderung in der Web-Konsole vornehmen.

2. Öffnen Sie CRXDE Lite.

3. Wählen Sie im Menü Tools die Option Abfrage … aus.

4. Führen Sie eine Abfrage vom Typ SQL durch, um nach der PID der Konfiguration zu suchen, die Sie aktualisiert haben.

   Beispiel: Apache Felix OSGi Management Console hat den Persistent Identifier (PID):

   org.apache.felix.webconsole.internal.servlet.OsgiManager

   Die SQL-Abfrage könnte also folgendermaßen lauten:

   select * from nt:base where jcr:path like '/apps/%' and contains(*, 'org.apache.felix.webconsole.internal.servlet.OsgiManager')
   

5. Der Knoten der Konfigurationsdatei wird angezeigt.

   Für das oben genannte Beispiel:

   /apps/system/config/org.apache.felix.webconsole.internal.servlet.OsgiManager.config

   VORSICHT

   Sie können diese Datei öffnen, um sich Ihre Änderungen anzusehen, doch um Schreibfehler zu vermeiden, wird empfohlen, die tatsächlichen Änderungen in der Konsole vorzunehmen.

6. Sie können jetzt ein Inhaltspaket erstellen, das diesen Knoten enthält, und es nach Bedarf in Ihren anderen Instanzen verwenden.

OSGi-Konfiguration im Repository

Neben der Verwendung der Web-Konsole ist die Definition der Konfigurationsdetails auch im Repository möglich. Damit können Sie die unterschiedlichen Ausführungsmodi einfach konfigurieren.

Diese Konfigurationen werden vorgenommen, indem sling:OsgiConfig-Knoten im Repository erstellt werden, auf die das System verweist. Diese Knoten bilden die OSGi-Konfigurationen ab und stellen für sie eine Benutzeroberfläche bereit. Um die Konfigurationsdaten zu aktualisieren, aktualisieren Sie die Knoteneigenschaften.

Wenn Sie die Konfigurationsdaten im Repository ändern, werden die Änderungen sofort auf die entsprechende OSGi-Konfiguration angewendet, so als ob die Änderungen in der Web-Konsole vorgenommen worden wären, einschließlich der entsprechenden Validierungs- und Konsistenzprüfungen. Dies gilt auch für das Kopieren einer Konfiguration von /libs/ nach /apps/.

Da derselbe Konfigurationsparameter an mehreren Orten gespeichert werden kann, geht das System folgendermaßen vor:

• sucht nach allen Knoten des Typs sling:OsgiConfig
• Es filtert nach dem Dienstnamen;
• Es filtert nach dem Ausführungsmodus.

Hinzufügen einer neuen Konfiguration zum Repository

Informationen, die Sie dafür benötigen

Um eine neue Konfiguration zum Repository hinzuzufügen, benötigen Sie folgende Informationen:

1. Die Persistente Identität (PID) des Dienstes.

   Verweisen Sie auf das Feld Konfigurationen in der Webkonsole. Der Name wird in Klammern hinter dem Bundle-Namen (oder in der Konfigurationsinformationen unten auf der Seite) angezeigt.

   Erstellen Sie beispielsweise einen Knoten com.day.cq.wcm.core.impl.VersionManagerImpl., um AEM WCM Version Manager zu konfigurieren.

   

2. Ob ein bestimmter Ausführungsmodus erforderlich ist. Erstellen Sie den Ordner:

   • config - für alle Ausführungsmodi
   • config.author - für die Umgebung des Verfassers
   • config.publish - Umgebung zur Veröffentlichung
   • config.<run-mode> - gegebenenfalls

3. Ob eine Konfiguration oder Factory Configuration erforderlich ist.

4. Die einzelnen Parameter, die konfiguriert werden müssen, einschließlich etwaiger vorhandener Parameterdefinitionen, die neu erstellt werden müssen.

   Referenzieren Sie das einzelne Parameterfeld in der Web-Konsole. Der Name wird für jeden Parameter in Klammern angezeigt.

   Erstellen Sie beispielsweise eine Eigenschaft
   versionmanager.createVersionOnActivation , um Version auf Aktivierung erstellen zu konfigurieren.

   

5. Ist eine Konfiguration bereits in /libs vorhanden? Um alle Konfigurationen in Ihrer Instanz Liste, verwenden Sie in CRXDE Lite das Tool Abfrage, um die folgende SQL-Abfrage zu senden:

   select * from sling:OsgiConfig

   In diesem Fall kann diese Konfiguration nach /apps/<yourProject>/ kopiert und dann am neuen Speicherort angepasst werden.

Erstellen der Konfiguration im Repository

Um die neue Konfiguration zum Repository hinzuzufügen, gehen Sie folgendermaßen vor:

1. Navigieren Sie mit CRXDE Lite zu:

   /apps/<yourProject>

2. Wenn noch nicht vorhanden, erstellen Sie den Ordner config ( sling:Folder):

   • config – anwendbar auf alle Ausführungsmodi
   • config.<run-mode> - spezifisch für einen bestimmten Ausführungsmodus

3. Erstellen Sie unter diesem Ordner einen Knoten:

   • Typ: sling:OsgiConfig

   • Name: die beständige Identität (PID);

     zum Beispiel AEM WCM Version Manager com.day.cq.wcm.core.impl.VersionManagerImpl

   HINWEIS

   Hängen Sie bei einer Factory-Konfiguration -<identifier> an den Namen an.

   Wie in: org.apache.sling.commons.log.LogManager.factory.config-<identifier>

   wobei <identifier> durch freien Text ersetzt wird, den Sie (müssen) eingeben müssen, um die Instanz zu identifizieren (Sie können diese Informationen nicht weglassen); Beispiel:

   org.apache.sling.commons.log.LogManager.factory.config-MINE

4. Erstellen Sie für jeden Parameter, den Sie konfigurieren möchten, eine Eigenschaft auf diesem Knoten:

   • Name: der Parametername, wie er in der Web-Konsole gezeigt wird. Der Name erscheint in Klammern am Ende der Feldbeschreibung. Beispiel: Verwenden Sie für Create Version on Activation versionmanager.createVersionOnActivation
   • Typ: entsprechend
   • Wert: nach Bedarf

   Sie müssen nur Eigenschaften für die Parameter erstellen, die Sie konfigurieren möchten. Die anderen übernehmen die Standardwerte von AEM.

5. Speichern Sie alle Änderungen.

   Die Änderungen werden angewendet, wenn der Knoten durch den Neustart des Dienstes aktualisiert wird (ebenso wie die in der Web-Konsole vorgenommenen Änderungen).

Konfigurationsdetails

Auflösungsreihenfolge beim Start

Die folgende Reihenfolge wird verwendet:

1. Repository-Knoten unter /apps/*/config....Entweder mit dem Typ sling:OsgiConfig oder Eigenschaftendateien.

2. Repository-Knoten mit dem Typ sling:OsgiConfig unter /libs/*/config.... (vorgefertigte Definitionen).

3. Alle .config-Dateien von <*cq-installation-dir*>/crx-quickstart/launchpad/config/.... im lokalen Dateisystem.

Das bedeutet, dass eine allgemeine Konfiguration in /libs durch eine projektspezifische Konfiguration in /apps maskiert werden kann.

Auflösungsreihenfolge während der Laufzeit

Konfigurationsänderungen, die während der Laufzeit des Systems vorgenommen werden, lösen einen neuen Ladevorgang mit der geänderten Konfiguration aus.

Anschließend wird die folgende Reihenfolge angewendet:

1. Die Änderung einer Konfiguration in der Web-Konsole wird sofort angewendet, da sie während der Laufzeit Vorrang hat.
2. Das Ändern einer Konfiguration in /apps wird sofort wirksam.
3. Das Ändern einer Konfiguration in /libs wird sofort wirksam, es sei denn, sie wird durch eine Konfiguration in /apps maskiert.

Auflösung mehrerer Ausführungsmodi

Für Ausführungsmodus-spezifische Konfigurationen können mehrere Ausführungsmodi kombiniert werden. Beispielsweise können Sie Konfigurationsordner vom folgenden Typ erstellen:

/apps/*/config.<runmode1>.<runmode2>/

Konfigurationen in derartigen Ordnern werden angewendet, wenn alle Ausführungsmodi mit einem beim Start definierten Ausführungsmodus übereinstimmen.

Wenn beispielsweise eine Instanz mit den Ausführungsmodi author,dev,emea gestartet wurde, werden Konfigurationsknoten in /apps/*/config.emea, /apps/*/config.author.dev/ und /apps/*/config.author.emea.dev/ angewendet, während Konfigurationsknoten in /apps/*/config.author.asean/ und /config/author.dev.emea.noldap/ nicht angewendet werden.

Wenn mehrere Konfigurationen für dieselbe PID anwendbar sind, wird die Konfiguration mit der höchsten Anzahl an passenden Ausführungsmodi angewendet.

Wenn beispielsweise eine Instanz mit den Ausführungsmodi author,dev,emea gestartet wurde und sowohl /apps/*/config.author/ als auch /apps/*/config.emea.author/ eine Konfiguration für
com.day.cq.wcm.core.impl.VersionManagerImpl, /apps/*/config.emea.author/ wird die Konfiguration in angewendet.

Die Granularität dieser Regel liegt auf PID-Ebene.
Es ist nicht möglich, einige Eigenschaften für dieselbe PID in /apps/*/config.author/ und für dieselbe PID spezifische Eigenschaften in /apps/*/config.emea.author/ zu definieren.
Die Konfiguration mit der höchsten Anzahl von übereinstimmenden Ausführungsmodi tritt für die gesamte PID in Kraft.

Standardkonfigurationen

In der folgenden Liste finden Sie eine kleine Auswahl an verfügbaren Konfigurationen (in einer Standardinstallation) im Repository:

• Autor - AEM WCM-Filter:

  libs/wcm/core/config.author/com.day.cq.wcm.core.WCMRequestFilter

• Veröffentlichen - AEM WCM-Filter:

  libs/wcm/core/config.publish/com.day.cq.wcm.core.WCMRequestFilter

• Veröffentlichen - AEM WCM-Seitenstatistiken:

  libs/wcm/core/config.publish/com.day.cq.wcm.core.stats.PageViewStatistics

Um alle Konfigurationsknoten in Ihrer Instanz aufzulisten, senden Sie über die Abfrage-Funktion in CRXDE Lite die folgende SQL-Abfrage:

select * from sling:OsgiConfig

Persistenz von Konfigurationen

• Wenn Sie eine Konfiguration über die Web-Konsole ändern, wird sie (in der Regel) in das Repository unter folgender Adresse geschrieben:

  /apps/{somewhere}

  • Standardmäßig ist {somewhere} system/config so geschrieben, dass die Konfiguration

    /apps/system/config

  • Wenn Sie jedoch eine Konfiguration bearbeiten, die ursprünglich von einem anderen Speicherort im Repository stammt: Beispiel:

    /libs/foo/config/someconfig

    Anschließend wird die aktualisierte Konfiguration unter dem ursprünglichen Speicherort geschrieben. Beispiel:

    /apps/foo/config/someconfig

• Einstellungen, die von admin geändert werden, werden in *.config-Dateien unter:

     /crx-quickstart/launchpad/config
  

  • Dies ist der private Datenbereich der OSGi-Konfigurationsverwaltung. Er enthält alle Konfigurationsdetails, die durch admin spezifiziert wurden, und zwar unabhängig davon, wie sie in das System gelangt sind.

  • Dies ist ein Implementierungsdetail; Sie dürfen dieses Verzeichnis nie direkt bearbeiten.

  • Es ist jedoch hilfreich, den Speicherort dieser Konfigurationsdateien zu kennen, damit Sie Kopien zur Sicherung und/oder mehrere Installationen erstellen können:

    • Apache Felix OSGi-Management Console

      ../crx/org/apache/felix/webconsole/internal/servlet/OsgiManager.config

    • CRX Sling Client Repository

      ../com/day/crx/sling/client/impl/CRXSlingClientRepository/<pid-nr>.config