Confluence

Sie können mit dem Confluence-Connector Vorgänge zum Einfügen, Löschen, Aktualisieren und Lesen in Confluence ausführen.

Hinweise

Führen Sie die folgenden Aufgaben aus, bevor Sie den Confluence-Connector verwenden:

• In Ihrem Google Cloud-Projekt:
  • Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
  • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

  • Aktivieren Sie die folgenden Dienste:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

  Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Zur Seite „Verbindungen“

2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
   1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

   2. Tippen Sie auf Weiter.
4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
   1. Connector: Wählen Sie Confluence aus der Drop-down-Liste der verfügbaren Connectors aus.
   2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
   3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 63 Zeichen haben.
   4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
   5. Aktivieren Sie optional Cloud Logging und wählen Sie dann eine Logebene aus. Die Logebene ist standardmäßig auf „Fehler“ festgelegt.
   6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   7. Wählen Sie optional Archivierte Gruppenbereiche einschließen aus, um Inhalte aus archivierten Gruppenbereichen in das Ergebnis aufzunehmen. Der Standardwert lautet „falsch“.
   8. Geben Sie optional eine Leertaste für die Suche ein, um nur Inhalte aus diesem Bereich anzuzeigen.
   9. Optional: Konfigurieren Sie die Verbindungsknoteneinstellungen:
      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

   Hinweis: Sie können die Verbindungsknotenwerte nur anpassen, wenn Sie ein „Pay as you go”-Kunde sind.
   10. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   11. Tippen Sie auf Weiter.
5. Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
   1. Destination Type: Wählen Sie einen Destination Type aus.
      • Wählen Sie aus der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse für das Ziel anzugeben.
      • Wenn Sie eine private Verbindung zu Ihren Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang und dann den erforderlichen Endpunktanhang aus der Liste Endpunktanhang aus.
        Hinweis : Informationen zum Erstellen eines Endpunktanhangs finden Sie unter PSC-Dienstanhang und Endpunktanhang. Nachdem Sie den Endpunktanhang erstellt haben, ist er in der Liste Endpunktanhang sichtbar.

      Wenn Sie eine öffentliche Verbindung zu Ihren Back-End-Systemen mit zusätzlicher Sicherheit herstellen möchten, können Sie statische ausgehende IP-Adressen für Ihre Verbindungen konfigurieren und dann Ihre Firewallregeln konfigurieren, um nur bestimmte statische IP-Adressen zuzulassen.

      Wenn Sie weitere Ziele eingeben möchten, klicken Sie auf + ZIEL HINZUFÜGEN.

   2. Tippen Sie auf Weiter.
6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
   1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden vom Confluence-Connector unterstützt:

      • Basic
      • APIToken
      • OAuth2.0

   Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

   2. Tippen Sie auf WEITER.
7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
8. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

• Basis
  • Nutzername: Das für die Authentifizierung verwendete Confluence-Nutzerkonto.
  • Passwort: das mit dem Konto verknüpfte Passwort.
• APIToken
  • Nutzername: Der Confluence-Nutzername, der zum Erstellen des API-Tokens verwendet wurde.
  • API Token: Das Passwort für den Nutzernamen ist ein API-Token. Wählen Sie das Secret Manager-Secret mit dem API-Token aus, das mit dem Confluence-Nutzernamen verknüpft ist.
• OAuth 2.0 – Autorisierungscode
  • Client-ID: Client-ID, die von Ihrer externen Anwendung bereitgestellt wird.
  • Bereiche: Berechtigungsbereiche. Der Bereich offline_access muss mit dem Confluence-Connector verwendet werden. Weitere Informationen zu Confluene-Bereichen finden Sie unter Confluence-Bereiche.
  • Client-Secret: Wählen Sie das Secret Manager-Secret aus. Sie sollten das Secret Manager-Secret erstellt haben, bevor Sie diese Autorisierung konfigurieren.
  • Secret-Version: Secret Manager-Secret-Version für den Clientschlüssel.

  Für den Authentifizierungstyp Authorization code müssen Sie nach dem Erstellen der Verbindung einige zusätzliche Schritte zum Konfigurieren der Authentifizierung ausführen. Weitere Informationen finden Sie unter Zusätzliche Schritte nach dem Erstellen der Verbindung.

  Hinweis: Wenn Sie die Authorization code-Authentifizierung verwenden eingegeben und die Kofiguration in Confluence geändert haben, müssen Sie Ihr Confluence-Verbindung. Informationen zur erneuten Autorisierung finden Sie unter Erneute Autorisierung für Autorisierungscode.

Zusätzliche Schritte nach dem Erstellen der Verbindung

Wenn Sie OAuth 2.0 - Authorization code für Authentifizierung verwenden, müssen Sie nach dem Erstellen der Verbindung die folgenden zusätzlichen Schritte ausführen:

1. Gehen Sie auf der Seite „Verbindungen“ so vor: finden Sie die neu erstellte Verbindung.

   Der Status für den neuen Connector lautet Autorisierung erforderlich.

2. Klicken Sie auf Autorisierung erforderlich.

   Daraufhin wird der Bereich Autorisierung bearbeiten angezeigt.

3. Kopieren Sie den Wert für den Weiterleitungs-URI in Ihre externe Anwendung.
4. Prüfen Sie die Autorisierungsdetails.
5. Klicken Sie auf Autorisieren.

   Ist die Autorisierung erfolgreich, wird der Verbindungsstatus im Seite „Verbindungen“.

Erneute Autorisierung für Autorisierungscode

Wenn Sie den Authentifizierungstyp Authorization code verwenden und in Ihrer Confluence-Anwendung Änderungen an der Konfiguration vorgenommen haben: müssen Sie Ihre Confluence-Verbindung noch einmal autorisieren. So autorisieren Sie eine Verbindung noch einmal:

1. Klicken Sie auf der Seite Verbindungen auf die erforderliche Verbindung.

   Die Seite mit den Verbindungsdetails wird geöffnet.

2. Klicken Sie auf Bearbeiten, um die Verbindungsdetails zu bearbeiten.
3. Überprüfen Sie die Angaben unter OAuth 2.0 – Autorisierungscode im Abschnitt Authentifizierung.

   Nehmen Sie bei Bedarf die erforderlichen Änderungen vor.

4. Klicken Sie auf Speichern. Die Seite mit den Verbindungsdetails wird geöffnet.
5. Klicken Sie im Abschnitt Authentifizierung auf Autorisierung bearbeiten. Daraufhin wird der Bereich Autorisieren angezeigt.
6. Klicken Sie auf Autorisieren.

   Wenn die Autorisierung erfolgreich war, wird der Verbindungsstatus auf der Seite Verbindungen auf Aktiv gesetzt.

Systembeschränkungen

Der Confluence-Connector kann 28 Transaktionen pro Sekunde und pro Knoten verarbeiten. Transaktionen, die dieses Limit überschreiten, werden drosselt. Standardmäßig werden von Integration Connectors zwei Knoten (für eine bessere Verfügbarkeit) für eine Verbindung zugewiesen.

Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Beschränkungen.

Hinweis: Die Anzahl der Integration Connectors-Knoten wird dynamisch automatisch skaliert. basierend auf Ihrer Nutzung. Wenn Sie jedoch Kapazitäten für große Volumes reservieren möchten, wenn Sie auf das Autoscaling warten, können Sie den minimalen Knotenwert für eine Verbindung anpassen. Mehr Knoten sind erforderlich, um mehr Transaktionen für eine Verbindung zu verarbeiten. Umgekehrt sind weniger Knoten erforderlich, wenn über eine Verbindung weniger Transaktionen verarbeitet werden. Knoten konfigurieren Gehen Sie so vor:

• Konfigurieren Sie als „Pay as you go“-Kunde den minimalen und maximalen Knotenwert auf der Seite „Verbindung bearbeiten“.
• Wenn du einen Abotarif hast, wende dich an den Support.

Die maximale Anzahl von Transaktionen, die ein Knoten verarbeiten kann, hängt von verschiedenen Faktoren ab. Bevor Sie die Mindestknoten für einen besseren Durchsatz anpassen, sollten Sie daher prüfen, ob Ihre Backend-Systeme optimal für die Verarbeitung des erforderlichen Traffics eingerichtet sind.

Confluence-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in beiden Apigee-Integration und Anwendungsintegration Sie können die Verbindung über die Connectors-Aufgabe in einer Integration.

• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in der Apigee-Integration finden Sie unter Connectors-Aufgabe.
• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Tasks für Connectors.

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

Hinweis: Sie können die Entitäten, Vorgänge und Aktionen eines Connectors in der Connectors-Aufgabe aufrufen.

• Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

  Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

• Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Unterstützt ein Connector jedoch keine Entitätsvorgänge, Vorgänge sind nicht in der Operations-Liste aufgeführt.

• Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und eine Ausgabe . Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Hinweis : Allen Entitäten und Aktionen ist ein Schema zugeordnet. Ein Aktionsschema hat beispielsweise folgende Parameterdetails: den Parameter und den zugehörigen Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Backend abgerufen. Falls das Schema aktualisiert wird, werden diese Aktualisierungen nicht automatisch in Ihren bestehenden Verbindungen widergespiegelt; müssen Sie das Schema manuell aktualisieren. Aktualisieren das Schema für eine Verbindung. Öffnen Sie dazu die Seite Verbindungsdetails der Verbindung und klicken Sie auf Verbindungsschema aktualisieren

Aktionen

Der Confluence-Connector bietet Aktionen wie „DownloadAttachment“ und „UploadAttachment“. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

Aktionsbeispiele

In diesem Abschnitt wird beschrieben, wie Sie einige Aktionen in diesem Connector ausführen.

Beispiel – Downloadanhang

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DownloadAttachment aus und klicken Sie auf Fertig.
3. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:

     {
       "AttachmentId": "xyz"
     }

Beispiele für Entitätsvorgänge

Beispiel – Alle Anfragen auflisten

In diesem Beispiel werden alle Anfragen in der Entität Requests aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity „Anfragen“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.

Beispiel – Nutzer mit einer bestimmten Konto-ID abrufen

In diesem Beispiel wird der Nutzer mit der Konto-ID 6035864ce2020c0070b5285b aus der Entität Users abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Users aus der Entity-Liste aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf filterClause und Geben Sie dann AccountId=6035864ce2020c0070b5285b in das Feld Default Value (Standardwert) ein.

   Hier ist AccountId der Primärschlüssel der Entität Users.

Beispiel – Seiten auflisten

In diesem Beispiel werden die Seiten der Entität Pages aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Pages aus der Entity-Liste aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.

Verbindungen mit Terraform erstellen

Mit dem Terraform-Code Ressource, um eine neue Verbindung zu erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispiel-Terraform-Vorlage zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie in der Terraform-Konfigurationsdatei die folgenden Variablen festlegen:

Parametername	Datentyp	Erforderlich	Beschreibung
proxy_enabled	BOOLEAN	Falsch	Wählen Sie dieses Kontrollkästchen aus, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme	ENUM	Falsch	Der für die Authentifizierung beim ProxyServer-Proxy zu verwendende Authentifizierungstyp. Unterstützte Werte: BASIC, DIGEST, NONE
proxy_user	STRING	Falsch	Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
proxy_password	SECRET	Falsch	Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.
proxy_ssltype	ENUM	Falsch	Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll. Unterstützte Werte sind: AUTO, ALWAYS, NEVER, TUNNEL

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte

• Informationen zum Anhalten und Fortsetzen einer Verbindung
• Informationen zum Überwachen der Connector-Nutzung
• Weitere Informationen zum Aufrufen von Connector-Logs