DokumentationAEM GuidesDokumentation zu AEM Guides

Konfigurieren der mikrodienstbasierten Veröffentlichung mit OAuth-Authentifizierung

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Admin

Mit dem Publishing-Microservice können Sie große Veröffentlichungsarbeitslasten gleichzeitig auf Experience Manager Guides as a Cloud Service ausführen und die branchenführende Server-lose Adobe I/O Runtime-Plattform nutzen.

Für jede Veröffentlichungsanforderung führt Experience Manager Guides as a Cloud Service einen separaten Container aus, der entsprechend den Benutzeranforderungen horizontal skaliert wird. Dies bietet die Möglichkeit, mehrere Veröffentlichungsanfragen auszuführen und eine bessere Leistung zu erzielen als die großen On-Premise-Adobe Experience Manager-Server.

NOTE
Microservice-basierte Veröffentlichung in Experience Manager Guides unterstützt die Typen von PDF (nativ und DITA-OT-basiert), HTML5, JSON und benutzerdefinierten Ausgabevorgaben.

Da der Cloud Publishing-Dienst durch die Adobe IMS OAuth-basierte Authentifizierung geschützt ist, führen Sie die folgenden Schritte aus, um ihre Umgebungen mit sicheren Token-basierten Authentifizierungsarbeitsabläufen zu integrieren und mit der Cloud-basierten skalierbaren Publishing-Lösung zu beginnen.

Erstellen von IMS-Konfigurationen in Adobe Developer Console

Rolle, die zum Erstellen der Konfigurationen erforderlich ist: Systemadministrator

Führen Sie die folgenden Schritte aus, um IMS-Konfigurationen in Adobe Developer Console zu erstellen:

NOTE
Wenn Sie bereits ein OAuth-Projekt erstellt haben, um die KI-gestützten intelligenten Vorschläge für das Authoring zu konfigurieren, können Sie die folgenden Schritte überspringen, um das Projekt zu erstellen.

  1. Öffnen Sie Developer Console: https://developer.adobe.com/console.

  2. Wechseln Sie oben zur Registerkarte Projekte .

    Projekt-Tab {width="500"}

    Wählen Sie die Registerkarte Projekte ​auf der Registerkarte Adobe Developer Console aus.

  3. Um ein neues leeres Projekt zu erstellen, wählen Sie Leeres Projekt aus der Dropdown-Liste Neues Projekt erstellen aus.

    Neues Projekt erstellen {width="500"}

    Erstellen Sie ein neues leeres Projekt.

  4. Wählen Sie API aus der Dropdown-Liste Zum Projekt hinzufügen aus, um die IO Management-API zu Ihrem Projekt hinzuzufügen.

    Projekt hinzufügen {width="300"}

    Wählen Sie ein API-Projekt aus der Dropdown-Liste aus.

    IO-Management {width="500"}

    Fügen Sie Ihrem Projekt die I/O-Management-API hinzu.

  5. Erstellen Sie eine neue OAuth-Berechtigung und speichern Sie sie.

    Schlüsselpaar generieren {width="500"}

    Konfigurieren Sie die OAuth-Berechtigung für Ihre API.

  6. Kehren Sie zur Registerkarte Projekte zurück und wählen Sie links die Option Projektübersicht aus.

    Projektübersicht {width="500"}

    Beginnen Sie mit dem neuen Projekt.

  7. Klicken Sie oben auf die Schaltfläche Herunterladen , um die Service-JSON herunterzuladen.

    JSON herunterladen {width="500"}

    Laden Sie die Details zum JSON-Dienst herunter.

Sie haben die OAuth-Authentifizierungsdetails konfiguriert und die Details zum JSON-Dienst heruntergeladen. Halten Sie diese Datei so bereit, wie es im nächsten Abschnitt erforderlich ist.

Hinzufügen der IMS-Konfiguration zur Umgebung

NOTE
Wenn Sie bereits ein OAuth-Projekt für intelligente Vorschläge erstellt haben, können Sie dasselbe Projekt für Microservices wiederverwenden und die folgenden Schritte überspringen, um die IMS-Konfiguration zur Umgebung hinzuzufügen.

Aktualisieren vorhandener Konfigurationen (JWT) zu OAuth Shift )

Wenn Sie bereits einen Microservice für die Veröffentlichung mit JWT (nicht mehr unterstützt) verwenden, führen Sie die folgenden Schritte aus, um die Konfigurationen zu aktualisieren:

  1. Öffnen Sie Experience Manager und wählen Sie das Programm aus, das die Umgebung enthält, die Sie konfigurieren möchten.

  2. Wechseln Sie zur Registerkarte Umgebungen .

  3. Wählen Sie den Namen der Umgebung aus, die Sie konfigurieren möchten. Dies sollte Sie zur Seite Umgebungsinformationen führen.

  4. Wechseln Sie zur Registerkarte Konfiguration .

  5. Aktualisieren Sie das JSON-Feld SERVICE_ACCOUNT_DETAILS mit der neuen JSON-Datei OAuth , die Sie heruntergeladen haben.

  6. Löschen Sie das Feld PRIVATE_KEY .

    IMS-Dienstkontokonfiguration {width="500"}

    Aktualisieren Sie die vorhandenen JWT-Umgebungskonfigurationen.

Erstmalige Konfiguration

Um einen Publishing-Microservice zum ersten Mal zu verwenden, aktualisieren Sie die Konfigurationen wie folgt:

  1. Öffnen Sie Experience Manager und wählen Sie das Programm aus, das die Umgebung enthält, die Sie konfigurieren möchten.

  2. Wechseln Sie zur Registerkarte Umgebungen .

  3. Wählen Sie den Namen der Umgebung aus, die Sie konfigurieren möchten. Dies sollte Sie zur Seite Umgebungsinformationen führen.

  4. Wechseln Sie zur Registerkarte Konfiguration .

  5. Erstellen Sie eine neue Konfiguration mit dem Namen SERVICE_ACCOUNT_DETAILS. Fügen Sie als Wert den Inhalt der OAuth-JSON-Datei hinzu, den Sie von der Entwicklerkonsole heruntergeladen haben.

IMS-Dienstkontokonfiguration

Konfigurieren Sie die Umgebung zum ersten Mal.

Erstmalige Codeänderungen für die Aktivierung der mikrodienstbasierten Veröffentlichung

NOTE
Überspringen Sie die folgenden Schritte, wenn Sie bereits eine mikrodienstbasierte Veröffentlichung verwenden:

Nachdem Sie die IMS-Konfiguration zur Umgebung hinzugefügt haben, führen Sie die folgenden Schritte aus, um diese Eigenschaften mithilfe von OSGi mit Experience Manager Guides zu verknüpfen:

  1. Fügen Sie in Ihrem Git-Projektcode für Cloud Manager die folgenden beiden Dateien zu /apps/fmditaCustom/config hinzu (für Dateiinhalte siehe Anhang).

    • com.adobe.aem.guides.eventing.ImsConfiguratorService.cfg.json
    • com.adobe.fmdita.publishworkflow.PublishWorkflowConfigurationService.xml

  2. Stellen Sie sicher, dass die neu hinzugefügten Dateien von Ihrem filter.xml abgedeckt werden.

  3. Übernehmen Sie Ihre Git-Änderungen und übertragen Sie sie.

  4. Führen Sie die Pipeline aus, um die Änderungen auf die Umgebung anzuwenden.

Danach können Sie die Microservice-basierte Cloud-Veröffentlichung verwenden.

Häufig gestellte Fragen

  1. Wenn OSGi-Konfigurationen für die Verwendung von Microservice aktiviert sind, funktioniert der Veröffentlichungsprozess auf dem lokalen Experience Manager-Server mit derselben Codebasis?
    • Nein, wenn das Flag dxml.use.publish.microservice auf true gesetzt ist, sucht es immer nach Microservice-Konfigurationen. Setzen Sie dxml.use.publish.microservice auf false , damit die Veröffentlichung auf Ihrem lokalen Server funktioniert.
  2. Wie viel Speicher wird dem DITA-Prozess bei der Verwendung von mikrodienstbasierter Veröffentlichung zugewiesen? Wird dies über das DITA-Profil und die -Parameter gesteuert?
    • Bei mikrodienstbasierter Veröffentlichung wird die Speicherzuordnung nicht durch das DITA-Profil und die -Parameter gesteuert. Der im Dienstcontainer verfügbare Gesamtspeicher beträgt 8 GB, von denen 6 GB dem DITA-OT-Prozess zugeordnet sind.

Anhang appendix

Datei:
com.adobe.aem.guides.eventing.ImsConfiguratorService.cfg.json

Inhalt:

{
"service.account.details": "$[secret:SERVICE_ACCOUNT_DETAILS]",
}

Datei: com.adobe.fmdita.publishworkflow.PublishWorkflowConfigurationService.xml

Inhalt:

  • dxml.use.publish.microservice: Wechsel zur Aktivierung der Veröffentlichung auf Microservice-Basis mithilfe von DITA-OT
  • dxml.use.publish.microservice.native.pdf: Wechseln Sie zum Aktivieren der mikrodienstbasierten nativen PDF-Veröffentlichung.
<?xml version="1.0" encoding="UTF-8"?>
<jcr:root xmlns:jcr="http://www.jcp.org/jcr/1.0" xmlns:sling="http://sling.apache.org/jcr/sling/1.0"
          jcr:primaryType="sling:OsgiConfig"
          dxml.publish.microservice.url="https://adobeioruntime.net/api/v1/web/543112-guidespublisher/default/publishercaller.json"
          dxml.use.publish.microservice="{Boolean}true"
          dxml.use.publish.microservice.native.pdf="{Boolean}true"
/>
recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178