Confluence

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

Hinweis

Führen Sie vor der Verwendung des Confluence-Connectors die folgenden Aufgaben aus:

• In Ihrem Google Cloud-Projekt:
  • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
  • Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
  • 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 49 Zeichen haben.
   4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
   5. Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Standardeinstellung für die Protokollebene ist „Fehler“.
   6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   7. Optional können Sie Archivierte Gruppenbereiche einschließen auswählen, um Inhalte aus archivierten Gruppenbereichen in die Ergebnisse aufzunehmen. Der Standardwert ist "false".
   8. Optional können Sie einen Gruppenbereichsschlüssel für die Suche eingeben, damit nur Inhalte aus diesem Gruppenbereich angezeigt werden.
   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. Zieltyp: Wählen Sie einen Zieltyp aus.
      • Wählen Sie in der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse des Ziels 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, wird er in der Liste Endpunktanhang angezeigt.

      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.

• Einfach
  • Nutzername: Das Confluence-Nutzerkonto, das für die Authentifizierung verwendet wird.
  • Passwort: Das mit dem Konto verknüpfte Passwort.
• APIToken
  • Nutzername: Der Confluence-Nutzername, mit dem das API-Token erstellt 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 dem Confluence-Nutzernamen zugeordnet 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 Confluence-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 den Authentifizierungstyp Authorization code verwenden und Änderungen an der Konfiguration in Ihrer Confluence-Anwendung vorgenommen haben, müssen Sie Ihre Confluence-Verbindung noch einmal autorisieren. 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 die Authentifizierung ausgewählt haben, müssen Sie nach dem Erstellen der Verbindung die folgenden zusätzlichen Schritte ausführen:

1. Suchen Sie auf der Seite Verbindungen nach der neu erstellten Verbindung.

   Der Status des neuen Connectors lautet Autorisierung erforderlich.

2. Klicken Sie auf Autorisierung erforderlich.

   Daraufhin wird der Bereich Autorisierung bearbeiten angezeigt.

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

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

Erneute Autorisierung für Autorisierungscode

Wenn Sie den Authentifizierungstyp Authorization code verwenden und Änderungen an der Konfiguration in Ihrer Confluence-Anwendung 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 gewünschte Verbindung.

   Dadurch wird die Seite mit den Verbindungsdetails geöffnet.

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

   Nehmen Sie gegebenenfalls die erforderlichen Änderungen vor.

4. Klicken Sie auf Speichern. Daraufhin gelangen Sie zur Seite mit den Verbindungsdetails.
5. Klicken Sie im Abschnitt Authentifizierung auf Autorisierung bearbeiten. Daraufhin wird der Bereich Authorize (Autorisieren) angezeigt.
6. Klicken Sie auf Autorisieren.

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

Systemeinschränkungen

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

Informationen zu den Limits für Integration Connectors finden Sie unter Limits.

Hinweis:Die Anzahl der Integration Connectors-Knoten wird dynamisch basierend auf Ihrer Nutzung skaliert. Wenn Sie jedoch Kapazität für große Datenmengen reservieren möchten, ohne auf das Autoscaling zu warten, können Sie den Mindestknotenwert für eine Verbindung anpassen. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, wenn über eine Verbindung weniger Transaktionen verarbeitet werden. So konfigurieren Sie die Knotenwerte:

• Wenn Sie ein „Pay as you go“-Kunde sind, konfigurieren Sie den Mindest- und Höchstwert für Knoten auf der Seite zum Bearbeiten der Verbindung.
• 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 sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung über die Connectors-Aufgabe in einer Integration verwenden.

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

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. Wenn ein Connector jedoch keinen der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Liste Operations 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 einen Ausgabeparameter. 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 zugewiesen. Ein Aktionsschema enthält beispielsweise Parameterdetails wie die Parameternamen und den entsprechenden Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Backend abgerufen. Wenn es Aktualisierungen am Schema gibt, werden diese nicht automatisch in Ihren vorhandenen Verbindungen berücksichtigt. Sie müssen das Schema manuell aktualisieren. Wenn Sie das Schema für eine Verbindung aktualisieren möchten, öffnen Sie die Seite Verbindungsdetails der Verbindung und klicken Sie dann 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.

Beispiele für Aktionen

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

Beispiel: Anhang herunterladen

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 Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

     {
       "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 die Option „Anfragen“ aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.

Beispiel: Nutzer anhand 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ählen Sie in der Liste Entity die Option Users aus.
3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf filterClause und geben Sie dann AccountId=6035864ce2020c0070b5285b in das Feld Standardwert ein.

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

Beispiel: Listenseiten

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

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

Beispiel: Seiten abrufen

In diesem Beispiel wird ein Seiteneintrag aus der Entität Pages abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Pages aus.
3. Wählen Sie den Vorgang GET aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 123 in das Feld Standardwert ein.

   Hier ist 123 eine eindeutige Kennzeichnung für die Ressource Pages.

Beispiel: Seiten erstellen

In diesem Beispiel wird ein Seiteneintrag in der Pages-Entität erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Pages aus.
3. Wählen Sie den Vorgang CREATE aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Default Value ein:

   {
         "SpaceId": "12345",
         "Status": "Current",
         "Title": "FROM XYZ",
         "Storage": "XYZ1234"
       }
   

Example - Update Pages

This example updates a page record in the Pages entity.

1. In the Configure connector task dialog, click Entities.
2. Select Pages from the Entity list.
3. Select the UPDATE operation, and then click Done.
4. In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:

   {
       "Title": "Update abc"
       }

5. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 12345 in das Feld Standardwert ein.

Wenn die Integration erfolgreich war, enthält das Feld connectorOutputPayload der Connector-Aufgabe die Antwort des Aktualisierungsvorgangs.

{
    "Id": 1234
    }

Beispiel: Seite löschen

In diesem Beispiel wird eine Seite aus der Entität Pages gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie in der Liste Entity die Option Pages aus.
3. Wählen Sie den Vorgang DELETE aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 123 in das Feld Standardwert ein.

   Wenn die Entität zusammengesetzte Primärschlüssel hat, können Sie anstelle der entityId auch die filterClause festlegen. Beispiel: Id='123'

Verbindungen mit Terraform erstellen

Sie können die Terraform-Ressource verwenden, 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 einer Verbindung finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:

Parametername	Datentyp	Erforderlich	Beschreibung
proxy_enabled	BOOLEAN	Falsch	Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme	ENUM	Falsch	Der Authentifizierungstyp, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll. 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	VERTRAULICH	Falsch	Ein Passwort, das für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
proxy_ssltype	ENUM	Falsch	Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll. Unterstützte Werte: 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 Ansehen von Connector-Logs