Confluence

Puoi utilizzare il connettore Confluence per eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura su Confluence.

Prima di iniziare

Prima di utilizzare il connettore Confluence, esegui le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM al account di servizio che vuoi utilizzare per il connettore:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente non umano che deve eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, vedi Creare un service account.

    • Attiva i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per capire come abilitare i servizi, consulta Abilitazione dei servizi.

    Se questi servizi o queste autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti viene chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione separata per ciascuna origine dati. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Integration Connectors > Connessioni e poi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + CREA NUOVA per aprire la pagina Crea connessione.
  3. Nella sezione Località, scegli la località per la connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le regioni supportate, consulta Località.

    2. Fai clic su AVANTI.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Confluence dall'elenco a discesa dei connettori disponibili.
    2. Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. (Facoltativo) Abilita Cloud Logging e seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Errore.
    6. Service Account: seleziona un account di servizio con i ruoli richiesti.
    7. (Facoltativo) Seleziona Includi spazi archiviati per includere i contenuti degli spazi archiviati nel risultato. Il valore predefinito è false.
    8. (Facoltativo) Inserisci una chiave dello spazio per fare in modo che la ricerca mostri i contenuti solo di questo spazio specifico.
    9. (Facoltativo) Configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, viceversa, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta la sezione Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita i nodi minimi sono impostati su 2 (per una migliore disponibilità) e i nodi massimi su 50.

    10. (Facoltativo) Fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    11. Fai clic su AVANTI.
  5. Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
    1. Tipo di destinazione: seleziona un Tipo di destinazione.
      • Per specificare il nome host o l'indirizzo IP di destinazione, seleziona Indirizzo host e inserisci l'indirizzo nel campo Host 1.
      • Per stabilire una connessione privata, seleziona Collegamento endpoint e scegli il collegamento richiesto dall'elenco Collegamento endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi valutare la possibilità di configurare indirizzi IP statici in uscita per le tue connessioni e poi configurare le regole del firewall in modo da consentire solo gli indirizzi IP statici specifici.

      Per inserire altre destinazioni, fai clic su +AGGIUNGI DESTINAZIONE.

    2. Fai clic su AVANTI.
  6. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      Il connettore Confluence supporta i seguenti tipi di autenticazione:

      • Basic
      • APIToken
      • OAuth2.0
    2. Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.

    3. Fai clic su AVANTI.
  7. Rivedi: rivedi i dettagli di connessione e autenticazione.
  8. Fai clic su Crea.

Configura l'autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • Basic
    • Nome utente: l'account utente Confluence utilizzato per l'autenticazione.
    • Password: la password associata all'account.
  • APIToken
    • Nome utente: il nome utente Confluence utilizzato per creare il token API.
    • Token API: la password per il nome utente è un token API. Seleziona il secret di Secret Manager contenente il token API associato al nome utente Confluence.
  • OAuth 2.0 - Authorization code
    • ID client : l'ID client fornito dall'applicazione esterna.
    • Ambiti : ambiti di autorizzazione. L'ambito offline_access deve essere utilizzato con il connettore Confluence. Per ulteriori informazioni sugli ambiti di Confluence, consulta Ambiti di Confluence.
    • Client secret : seleziona il secret di Secret Manager. Prima di configurare questa autorizzazione, devi aver creato il secret Secret Manager.
    • Versione secret : la versione secret di Secret Manager per il client secret.
    • Per il tipo di autenticazione Authorization code, dopo aver creato la connessione, devi eseguire alcuni passaggi aggiuntivi per configurare l'autenticazione. Per saperne di più, consulta Passaggi aggiuntivi dopo la creazione della connessione.

Passaggi aggiuntivi dopo la creazione della connessione

Se hai selezionato OAuth 2.0 - Authorization code per l'autenticazione, devi eseguire i seguenti passaggi aggiuntivi dopo aver creato la connessione:

  1. Nella pagina Connessioni, individua la connessione appena creata.

    Tieni presente che lo Stato del nuovo connettore sarà Autorizzazione richiesta.

  2. Fai clic su Autorizzazione obbligatoria.

    Viene visualizzato il riquadro Modifica autorizzazione.

  3. Copia il valore URI di reindirizzamento nell'applicazione esterna.
  4. Verifica i dettagli dell'autorizzazione.
  5. Fai clic su Autorizza.

    Se l'autorizzazione va a buon fine, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Nuova autorizzazione per il codice di autorizzazione

Se utilizzi il tipo di autenticazione Authorization code e hai apportato modifiche alla configurazione nell'applicazione Confluence, devi autorizzare nuovamente la connessione a Confluence. Per autorizzare nuovamente una connessione:

  1. Fai clic sulla connessione richiesta nella pagina Connessioni.

    Viene visualizzata la pagina dei dettagli della connessione.

  2. Fai clic su Modifica per modificare i dettagli della connessione.
  3. Verifica i dettagli di OAuth 2.0 - Codice di autorizzazione nella sezione Autenticazione.

    Se necessario, apporta le modifiche necessarie.

  4. Fai clic su Salva. Viene visualizzata la pagina dei dettagli della connessione.
  5. Fai clic su Modifica autorizzazione nella sezione Autenticazione. Viene visualizzato il riquadro Autorizza.
  6. Fai clic su Autorizza.

    Se l'autorizzazione va a buon fine, lo stato della connessione verrà impostato su Attiva nella pagina Connessioni.

Limitazioni di sistema

Il connettore Confluence può elaborare 28 transazioni al secondo, per nodo, e limita le transazioni oltre questo limite. Per impostazione predefinita, Integration Connectors alloca due nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Utilizzare la connessione Confluence in un'integrazione

Una volta creata la connessione, questa diventa disponibile sia in Apigee Integration che in Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

  • Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
  • Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene mostrata come entità, operazioni e azioni.

  • Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio connesso. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore del file server, le cartelle sono le entità e in un connettore del sistema di messaggistica, le code sono le entità.

    Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

  • Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una delle seguenti operazioni su un'entità:

    Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

  • Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Azioni

Il connettore Confluence fornisce azioni come DownloadAttachment e UploadAttachment. Per capire come configurare le azioni, consulta Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: scaricare l'allegato

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DownloadAttachment, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:
      {
        "AttachmentId": "xyz"
      }

Esempi di operazioni sulle entità

Esempio: elencare tutte le richieste

Questo esempio elenca tutte le richieste nell'entità Requests.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Richieste dall'elenco Entity.
  3. Seleziona l'operazione LIST, quindi fai clic su Fine.

Esempio: recuperare un utente da un ID account specifico

Questo esempio recupera l'utente con AccountId 6035864ce2020c0070b5285b dall'entità Users.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Users dall'elenco Entity.
  3. Seleziona l'operazione LIST, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su filterClause e poi inserisci AccountId=6035864ce2020c0070b5285b nel campo Valore predefinito.

    In questo caso, AccountId è il valore della chiave primaria dell'entità Users.

Esempio: pagine di elenchi

Questo esempio elenca le pagine dell'entità Pages.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Pages dall'elenco Entity.
  3. Seleziona l'operazione LIST, quindi fai clic su Fine.

Esempio: recuperare le pagine

Questo esempio recupera un record di pagina dall'entità Pages.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Pages dall'elenco Entity.
  3. Seleziona l'operazione GET, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 123 nel campo Valore predefinito.

    In questo caso, 123 è un identificatore univoco per l'entità risorsa Pages.

Esempio: crea pagine

Questo esempio crea un record di pagina nell'entità Pages.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Pages dall'elenco Entity.
  3. Seleziona l'operazione CREATE, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:
    {
          "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. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 12345 nel campo Valore predefinito.
  6. Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore conterrà la risposta dell'operazione di aggiornamento.

    {
        "Id": 1234
        }

Esempio: eliminare una pagina

Questo esempio elimina una pagina dall'entità Pages.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Pages dall'elenco Entity.
  3. Seleziona l'operazione DELETE, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 123 nel campo Valore predefinito.

    In alternativa, se l'entità ha chiavi primarie composite anziché specificare entityId, puoi impostare filterClause. Ad esempio: Id='123'.

Creare connessioni utilizzando Terraform

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione della connessione, consulta Modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro Tipo di dati Obbligatorio Descrizione
proxy_enabled BOOLEANO Falso Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme ENUM Falso Il tipo di autenticazione da utilizzare per l'autenticazione al proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user STRING Falso Un nome utente da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_password SECRET Falso Una password da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_ssltype ENUM Falso Il tipo di SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Ricevere assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community di Google Cloud nei forum di Cloud.

Passaggi successivi