Connettore Confluence V2.0 - Amazon Kendra
Funzionalità supportatePrerequisitiIstruzioni di connessione

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Connettore Confluence V2.0

Confluence è uno strumento collaborativo di gestione del lavoro progettato per condividere, archiviare e lavorare sulla pianificazione di progetti, lo sviluppo di software e la gestione dei prodotti. È possibile utilizzare… Amazon Kendra per indicizzare gli spazi, le pagine (incluse le pagine annidate), i blog, i commenti e gli allegati di Confluence in pagine e blog indicizzati.

Per la risoluzione dei problemi relativi al Amazon Kendra Connettore di origine dati Confluence, vedi. Risoluzione dei problemi relativi alle origini dati

Funzionalità supportate

Amazon Kendra Il connettore di origine dati Confluence supporta le seguenti funzionalità:

  • Mappature dei campi

  • Controllo degli accessi degli utenti

  • Modelli di inclusione/esclusione

  • Sincronizzazione completa e incrementale dei contenuti

  • Cloud privato virtuale () VPC

Prerequisiti

Prima di poter usare Amazon Kendra per indicizzare la tua fonte di dati Confluence, apporta queste modifiche in Confluence e AWS conti.

In Confluence, assicurati di avere:

  • Hai copiato la tua istanza di Confluence. URL Per esempio: https://example.confluence.com, o https://www.example.confluence.com/, oppure https:// atlassian.net/. Hai bisogno della tua istanza Confluence URL a cui connetterti Amazon Kendra.

    Se utilizzi Confluence Cloud, il tuo host deve terminare con URL atlassian.net/.

    Nota

    I seguenti URL formati non sono supportati:

    • https://example.confluence.com/xyz

    • https://www.example.confluence.com//wiki/spacekey/xxx

    • https://atlassian.net/xyz

    Nota

    (In locale/server) Amazon Kendra verifica se le informazioni sull'endpoint sono incluse in AWS Secrets Manager sono le stesse informazioni sull'endpoint specificate nei dettagli di configurazione dell'origine dati. Questo aiuta a proteggersi dal problema del confuso vicario, che è un problema di sicurezza in cui un utente non ha il permesso di eseguire un'azione ma utilizza Amazon Kendra come proxy per accedere al segreto configurato ed eseguire l'azione. Se successivamente modifichi le informazioni sull'endpoint, devi creare un nuovo segreto per sincronizzare queste informazioni.

  • Credenziali di autenticazione di base configurate contenenti un nome utente (ID e-mail utilizzato per accedere a Confluence) e una password (token Confluence API come password). Vedi Gestire i API token per il tuo account Atlassian.

    Nota

    Ti consigliamo di aggiornare o ruotare regolarmente le credenziali e il segreto. Fornisci solo il livello di accesso necessario per la tua sicurezza. Non è consigliabile riutilizzare credenziali e segreti tra diverse fonti di dati e versioni dei connettori 1.0 e 2.0 (ove applicabile).

  • Facoltativo: credenziali OAuth 2.0 configurate contenenti una chiave dell'app Confluence, un segreto dell'app Confluence, un token di accesso Confluence e un token di aggiornamento Confluence per consentire Amazon Kendra per connetterti alla tua istanza Confluence. Se il token di accesso scade, puoi utilizzare il token di aggiornamento per rigenerare il token di accesso e la coppia di token di aggiornamento. In alternativa, puoi ripetere la procedura di autorizzazione. Per ulteriori informazioni sui token di accesso, consulta Gestire i token di OAuth accesso.

  • (Solo per Confluence Server/Data Center) Opzionale: hai configurato un token di accesso personale () in Confluence. PAT Vedi Utilizzo dei token di accesso personali.

Nel tuo Account AWS, assicurati di avere:

  • Hai creato un Amazon Kendra indice e, se si utilizza ilAPI, ha annotato l'ID dell'indice.

  • Ha creato un IAM ruolo per la fonte di dati e, se si utilizza ilAPI, ha annotato il ARN IAM ruolo.

    Nota

    Se modifichi il tipo di autenticazione e le credenziali, devi aggiornare il IAM ruolo per accedere a quello corretto AWS Secrets Manager ID segreto.

  • Hai archiviato le credenziali di autenticazione Confluence in un AWS Secrets Manager segreto e, se si utilizza ilAPI, ha annotato il ARN segreto.

    Nota

    Ti consigliamo di aggiornare o ruotare regolarmente le credenziali e il segreto. Fornisci solo il livello di accesso necessario per la tua sicurezza. Non è consigliabile riutilizzare credenziali e segreti tra diverse fonti di dati e versioni dei connettori 1.0 e 2.0 (ove applicabile).

Se non ne hai uno esistente IAM ruolo o segreto, puoi usare la console per crearne uno nuovo IAM ruolo e Secrets Manager segreto quando colleghi la tua fonte di dati Confluence a Amazon Kendra. Se si utilizza ilAPI, è necessario fornire il ARN IAM ruolo e Secrets Manager segreto e un ID di indice.

Istruzioni di connessione

Connettersi Amazon Kendra alla tua fonte dati Confluence, devi fornire i dettagli necessari della tua fonte di dati Confluence in modo che Amazon Kendra può accedere ai tuoi dati. Se non hai ancora configurato Confluence per Amazon Kendra vedere. Prerequisiti

Console

Connettersi Amazon Kendra a Confluence

  1. Accedi a AWS Management Console e apri il Amazon Kendra console.

  2. Dal riquadro di navigazione a sinistra, scegli Indici, quindi scegli l'indice che desideri utilizzare dall'elenco degli indici.

    Nota

    Puoi scegliere di configurare o modificare le impostazioni del controllo dell'accesso degli utenti in Impostazioni dell'indice.

  3. Nella pagina Guida introduttiva, scegli Aggiungi origine dati.

  4. Nella pagina Aggiungi origine dati, scegli Confluence connector, quindi scegli Aggiungi connettore. Se utilizzi la versione 2 (se applicabile), scegli il connettore Confluence con il tag «V2.0".

  5. Nella pagina Specificare i dettagli dell'origine dati, inserisci le seguenti informazioni:

    1. In Nome e descrizione, per Nome dell'origine dati, inserisci un nome per l'origine dati. Puoi includere trattini ma non spazi.

    2. (Facoltativo) Descrizione: immetti una descrizione facoltativa per la tua fonte di dati.

    3. In Lingua predefinita: scegli una lingua per filtrare i documenti per l'indice. Se non diversamente specificato, la lingua predefinita è l'inglese. La lingua specificata nei metadati del documento ha la precedenza sulla lingua selezionata.

    4. In Tag, per Aggiungi nuovo tag, includi tag opzionali per cercare e filtrare le tue risorse o tenere traccia delle tue AWS costi.

    5. Scegli Next (Successivo).

  6. Nella pagina Definisci accesso e sicurezza, inserisci le seguenti informazioni:

    1. In Source, scegli Confluence Cloud o Confluence Server/Data Center.

    2. Confluence: inserisci l'host Confluence. URL URL Ad esempio, https://example.confluence.com.

    3. (Solo per Confluence Server/Data Center) posizione del certificato: opzionale: immettere il SSL Amazon S3 percorso del file di SSL certificato per Confluence Server.

    4. (Solo per Confluence Server/Data Center) Proxy Web: opzionale: immettere il nome host del proxy Web (senza il https:// protocollo http:// o) e il numero di porta (porta utilizzata dal protocollo di trasporto dell'host). URL Il numero di porta deve essere un valore numerico compreso tra 0 e 65535.

    5. Autorizzazione: attiva o disattiva le informazioni della lista di controllo degli accessi (ACL) per i tuoi documenti, se ne hai una ACL e desideri utilizzarla per il controllo degli accessi. ACLspecifica a quali documenti possono accedere utenti e gruppi. Le ACL informazioni vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente.

    6. Autenticazione: scegli l'autenticazione di base, l'autenticazione OAuth 2.0 o (solo per Confluence Server/Data Center) l'autenticazione con token di accesso personale.

    7. AWS Secrets Manager segreto: scegli un segreto esistente o creane uno nuovo Secrets Manager segreto per memorizzare le credenziali di autenticazione Confluence. Se scegli di creare un nuovo segreto, un AWS Secrets Manager si apre una finestra segreta. Inserisci le seguenti informazioni nella finestra:

      1. Nome segreto: un nome per il tuo segreto. Il prefisso 'AmazonKendra-Confluence-' viene aggiunto automaticamente al tuo nome segreto.

      2. Se utilizzi l'autenticazione di base, inserisci il nome segreto, il nome utente e la password (APItoken Confluence come password) che hai configurato in Confluence.

        Se utilizzi l'autenticazione OAuth2 2.0, inserisci il nome segreto, la chiave dell'app, il segreto dell'app, il token di accesso e il token di aggiornamento che hai configurato in Confluence.

        (Solo Confluence Server/Data Center) Se utilizzi l'autenticazione con token di accesso personale, inserisci il nome segreto e il token Confluence che hai configurato in Confluence.

      3. Salva e aggiungi il tuo segreto.

    8. Virtual Private Cloud (VPC): puoi scegliere di utilizzare unVPC. In tal caso, è necessario aggiungere sottoreti e VPC gruppi di sicurezza.

    9. Identity crawler: specifica se attivare Amazon Kendra del crawler di identità. Il crawler di identità utilizza le informazioni dell'elenco di controllo degli accessi (ACL) per i documenti per filtrare i risultati della ricerca in base all'accesso dell'utente o del gruppo di appartenenza ai documenti. Se ne hai una ACL per i tuoi documenti e scegli di usarlaACL, puoi anche scegliere di attivarla Amazon Kendra per configurare il filtraggio contestuale dell'utente dei risultati di ricerca. Altrimenti, se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo di accesso per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzarlo PutPrincipalMappingAPIper caricare le informazioni di accesso di utenti e gruppi per il filtraggio del contesto degli utenti.

    10. IAM ruolo: scegli un ruolo esistente IAM ruolo o creane uno nuovo IAM ruolo per accedere alle credenziali del repository e indicizzare il contenuto.

      Nota

      IAM i ruoli utilizzati per gli indici non possono essere utilizzati per le fonti di dati. Se non sei sicuro che un ruolo esistente venga utilizzato per un indice oppure FAQ scegli Crea un nuovo ruolo per evitare errori.

    11. Scegli Next (Successivo).

  7. Nella pagina Configura le impostazioni di sincronizzazione, inserisci le seguenti informazioni:

    1. Nell'ambito di sincronizzazione, per Sincronizza contenuti: scegli di sincronizzare tra i seguenti tipi di contenuto: pagine, commenti alle pagine, allegati di pagina, blog, commenti del blog, allegati di blog, spazi personali e spazi archiviati.

      Nota

      I commenti e gli allegati delle pagine possono essere selezionati solo se scegli di sincronizzare Pages. I commenti e gli allegati del blog possono essere selezionati solo se scegli di sincronizzare i blog.

      Importante

      Se non specifichi un pattern regex con chiave spaziale in Configurazione aggiuntiva, per impostazione predefinita, tutte le pagine e i blog verranno sottoposti a scansione.

    2. In Configurazione aggiuntiva, per Dimensione massima del file: specifica il limite di dimensione del file MBs Amazon Kendra striscierà. Amazon Kendra eseguirà la scansione solo dei file entro il limite di dimensione definito. La dimensione predefinita del file è 50 MB. La dimensione massima del file deve essere superiore a 0 MB e inferiore o uguale a 50 MB.

      Per i modelli regex di Spaces: specifica se includere o escludere spazi specifici nell'indice utilizzando:

      • Chiave spaziatrice (ad esempio, my-space-123)

        Nota

        Se non specifichi un pattern regex con chiave spaziale, per impostazione predefinita, tutte le pagine e i blog verranno sottoposti a scansione.

      • URL(ad esempio, .*/MySite/MyDocuments/)

      • Tipo di file (ad esempio .*\.pdf, .*\.txt)

      Per i modelli di espressione regolare dei titoli delle entità: specifica i modelli di espressioni regolari per includere o escludere determinati blog, pagine, commenti e allegati in base ai titoli.

      Nota

      Se desideri includere o escludere la scansione di una pagina o sottopagina specifica, puoi utilizzare i modelli di espressione regolare del titolo della pagina.

    3. Modalità di sincronizzazione: scegli come aggiornare l'indice quando il contenuto dell'origine dati cambia. Quando sincronizzi la tua fonte di dati con Amazon Kendra per la prima volta, per impostazione predefinita, tutto il contenuto viene sottoposto a scansione e indicizzato. È necessario eseguire una sincronizzazione completa dei dati se la sincronizzazione iniziale non è riuscita, anche se non si sceglie la sincronizzazione completa come opzione della modalità di sincronizzazione.

      • Sincronizzazione completa: indicizza di nuovo tutti i contenuti, sostituendo i contenuti esistenti ogni volta che l'origine dati si sincronizza con l'indice.

      • Sincronizzazione nuova, modificata ed eliminata: indicizza solo i contenuti nuovi, modificati ed eliminati ogni volta che l'origine dati si sincronizza con l'indice. Amazon Kendra può utilizzare il meccanismo dell'origine dati per tenere traccia delle modifiche ai contenuti e indicizzare i contenuti modificati dall'ultima sincronizzazione.

    4. Nella pianificazione di esecuzione della sincronizzazione, per Frequenza: scegli la frequenza con cui sincronizzare il contenuto della fonte di dati e aggiornare l'indice.

    5. Scegli Next (Successivo).

  8. Nella pagina Imposta mappature dei campi, inserisci le seguenti informazioni:

    1. Seleziona tra Amazon Kendra campi di origine dati predefiniti generati che desideri mappare all'indice. Per aggiungere campi di origine dati personalizzati, crea un nome di campo indice a cui mappare e il tipo di dati del campo.

    2. Scegli Next (Successivo).

  9. Nella pagina Rivedi e crea, verifica che le informazioni inserite siano corrette, quindi seleziona Aggiungi origine dati. Puoi anche scegliere di modificare le tue informazioni da questa pagina. L'origine dati verrà visualizzata nella pagina Origini dati dopo che l'origine dati sarà stata aggiunta correttamente.

API

Per connetterti Amazon Kendra a Confluence

È necessario specificare uno JSON degli schemi dell'origine dati utilizzando. TemplateConfigurationAPI È necessario fornire le seguenti informazioni:

  • Origine dati: specificare il tipo di origine dati come CONFLUENCEV2 quando si utilizza TemplateConfigurationJSONschema. Specificate anche l'origine dati come TEMPLATE quando chiamate il CreateDataSource API.

  • Host URL: specifica l'istanza host di Confluence. URL Ad esempio, https://example.confluence.com.

  • Modalità di sincronizzazione: specifica come Amazon Kendra dovrebbe aggiornare l'indice quando il contenuto della fonte di dati cambia. Quando sincronizzi la tua fonte di dati con Amazon Kendra per la prima volta, per impostazione predefinita, tutto il contenuto viene sottoposto a scansione e indicizzato. È necessario eseguire una sincronizzazione completa dei dati se la sincronizzazione iniziale non è riuscita, anche se non si sceglie la sincronizzazione completa come opzione della modalità di sincronizzazione. Puoi scegliere tra:

    • FORCED_FULL_CRAWLper indicizzare nuovamente tutti i contenuti, sostituendo i contenuti esistenti ogni volta che l'origine dati si sincronizza con l'indice.

    • FULL_CRAWLper indicizzare solo i contenuti nuovi, modificati ed eliminati ogni volta che l'origine dati si sincronizza con l'indice. Amazon Kendra può utilizzare il meccanismo dell'origine dati per tenere traccia delle modifiche ai contenuti e indicizzare i contenuti modificati dall'ultima sincronizzazione.

  • Tipo di autenticazione: specifica il tipo di autenticazione, se BasicOAuth2, (solo Confluence Server). Personal-token

  • (Facoltativo, solo per Confluence Server) posizione del certificato: specifica l'e che hai utilizzato per archiviare il SSL certificato. S3bucketName s3certificateName SSL

  • Nome risorsa Amazon segreto (ARN): fornisci il nome della risorsa Amazon (ARN) di un Secrets Manager segreto che contiene le credenziali di autenticazione configurate in Confluence. Se utilizzi l'autenticazione di base, il segreto viene archiviato in una JSON struttura con le seguenti chiavi: 

    {
    "username": "email ID or user name",
    "password": "Confluence API token"
}

    Se si utilizza l'autenticazione OAuth 2.0, il segreto viene archiviato in una JSON struttura con le seguenti chiavi:

    {
    "confluenceAppKey": "app key",
    "confluenceAppSecret": "app secret",
    "confluenceAccessToken": "access token",
    "confluenceRefreshToken": "refresh token"
}

    (Solo per Confluence Server) Se utilizzi l'autenticazione di base, il segreto viene archiviato in una JSON struttura con le seguenti chiavi:

    {
    "hostUrl": "Confluence Server host URL",
    "username": "Confluence Server user name",
    "password": "Confluence Server password"
}

    (Solo per Confluence Server) Se utilizzi l'autenticazione con token di accesso personale, il segreto viene archiviato in una JSON struttura con le seguenti chiavi:

    {
    "hostUrl": "Confluence Server host URL",
    "patToken": "personal access token"
}

  • IAM role: specifica RoleArn quando si chiama CreateDataSource per fornire un IAM ruolo con autorizzazioni per accedere al tuo Secrets Manager segreto e per chiamare il pubblico richiesto APIs per il connettore Confluence e Amazon Kendra Per ulteriori informazioni, consulta .IAM ruoli per le fonti di dati Confluence.

Puoi anche aggiungere le seguenti funzionalità opzionali:

  • Virtual Private Cloud (VPC): specifica VpcConfiguration quando si chiamaCreateDataSource. Per ulteriori informazioni, consulta Configurazione Amazon Kendra usare un Amazon VPC.

  • Dimensione del file: specifica la dimensione massima del file da sottoporre a scansione.

  • Tipi di documento/contenuto: specificate se eseguire la scansione di pagine, commenti di pagina, allegati di pagina, blog, commenti, allegati del blog, spazi e spazi archiviati.

  • Filtri di inclusione ed esclusione: specifica se includere o escludere determinati spazi, pagine, blog e relativi commenti e allegati.

    Nota

    La maggior parte delle fonti di dati utilizza modelli di espressioni regolari, che sono modelli di inclusione o esclusione denominati filtri. Se si specifica un filtro di inclusione, viene indicizzato solo il contenuto che corrisponde al filtro di inclusione. Qualsiasi documento che non corrisponde al filtro di inclusione non viene indicizzato. Se si specifica un filtro di inclusione ed esclusione, i documenti che corrispondono al filtro di esclusione non vengono indicizzati, anche se corrispondono al filtro di inclusione.

  • Proxy Web: specifica le informazioni sul proxy Web se desideri connetterti all'istanza URL Confluence tramite un proxy Web. Puoi utilizzare questa opzione per Confluence Server.

  • Elenco di controllo degli accessi (ACL): specifica se eseguire la scansione ACL delle informazioni dei documenti, se ne hai uno ACL e desideri utilizzarlo per il controllo degli accessi. ACLspecifica a quali documenti possono accedere utenti e gruppi. Le ACL informazioni vengono utilizzate per filtrare i risultati della ricerca in base all'accesso dell'utente o del relativo gruppo ai documenti. Per ulteriori informazioni, consulta Filtraggio del contesto utente.

  • Identity crawler: specifica se attivare Amazon Kendra del crawler di identità. Il crawler di identità utilizza le informazioni dell'elenco di controllo degli accessi (ACL) per i documenti per filtrare i risultati della ricerca in base all'accesso dell'utente o del gruppo di appartenenza ai documenti. Se ne hai una ACL per i tuoi documenti e scegli di usarlaACL, puoi anche scegliere di attivarla Amazon Kendra per configurare il filtraggio contestuale dell'utente dei risultati di ricerca. Altrimenti, se il crawler di identità è disattivato, tutti i documenti possono essere ricercati pubblicamente. Se desideri utilizzare il controllo di accesso per i tuoi documenti e il crawler di identità è disattivato, in alternativa puoi utilizzarlo PutPrincipalMappingAPIper caricare le informazioni di accesso di utenti e gruppi per il filtraggio del contesto degli utenti.

  • Mappature dei campi: scegli di mappare i campi delle sorgenti dati di Confluence ai tuoi Amazon Kendra campi indice. Per ulteriori informazioni, consulta la sezione Mappatura dei campi di origine dei dati.

    Nota

    Il campo relativo al corpo del documento o l'equivalente del corpo del documento è obbligatorio per Amazon Kendra per cercare i tuoi documenti. È necessario mappare il nome del campo del corpo del documento nella fonte dati al nome del campo indice_document_body. Tutti gli altri campi sono facoltativi.

Per un elenco di altre JSON chiavi importanti da configurare, consulta lo schema del modello di Confluence.

Note

  • Il token di accesso personale (PAT) non è disponibile per Confluence Cloud.