Zephyrnet-logo

Indexeer uw Confluence-inhoud met behulp van de nieuwe Confluence-connector V2 voor Amazon Kendra | Amazon-webservices

Datum:

Amazon Kendra is een zeer nauwkeurige en gebruiksvriendelijke intelligente zoekservice die wordt aangedreven door machine learning (ML). Amazon Kendra biedt een reeks gegevensbronconnectoren om het proces van het opnemen en indexeren van uw inhoud te vereenvoudigen, waar deze zich ook bevindt.

Waardevolle data in organisaties wordt opgeslagen in zowel gestructureerde als ongestructureerde repositories. Een enterprise search-oplossing moet in staat zijn om gegevens uit verschillende gestructureerde en ongestructureerde repositories samen te brengen om te indexeren en te doorzoeken.

Een van die ongestructureerde gegevensopslagplaatsen is Confluence. Confluence is een teamwerkruimte die kenniswerkersteams een plek biedt om elk project of idee te creëren, vast te leggen en eraan samen te werken. Teamruimtes helpen teams bij het structureren, organiseren en delen van werk, zodat elk teamlid inzicht heeft in de institutionele kennis en toegang heeft tot de informatie die ze nodig hebben.

Er zijn twee Samenvloeiing aanbod:

  • Cloud – Dit wordt aangeboden als een software-as-a-service (SaaS) product. Het staat altijd aan, wordt voortdurend bijgewerkt en is uiterst veilig.
  • Datacenter (in eigen beheer) – Hier host u Confluence op uw infrastructuur, die zich op locatie of in de cloud kan bevinden. Hierdoor kunt u gegevens binnen uw netwerk houden en zelf beheren.

We zijn verheugd aan te kondigen dat je nu de nieuwe Amazon Kendra-connector V2 voor Confluence kunt gebruiken om informatie te doorzoeken die is opgeslagen in je Confluence-account, zowel in de cloud als in je datacenter. In dit bericht laten we zien hoe u informatie kunt indexeren die is opgeslagen in Confluence en hoe u de intelligente zoekfunctie van Amazon Kendra kunt gebruiken. Bovendien kan de door ML aangedreven intelligente zoekfunctie nauwkeurig informatie vinden uit ongestructureerde documenten met verhalende inhoud in natuurlijke taal, waarvoor zoeken op trefwoord niet erg effectief is.

Wat is er nieuw voor deze versie

Deze versie ondersteunt OAuth 2.0-authenticatie naast basisauthenticatie voor de Cloud-editie. Voor de Data Center (on-premises) editie hebben we OAuth2 toegevoegd naast basisauthenticatie en persoonlijke toegangstokens voor het tonen van zoekresultaten op basis van gebruikerstoegangsrechten. U kunt profiteren van de volgende functies:

  • U kunt nu naast ruimtes, pagina's, blogs en bijlagen ook opmerkingen crawlen
  • U heeft nu fijnmazige keuzes voor uw synchronisatiebereik: u kunt pagina's, blogs, opmerkingen en bijlagen specificeren
  • U kunt ervoor kiezen om identiteiten te importeren (of niet)
  • Deze versie biedt regex-ondersteuning voor het kiezen van entiteitstitels en bestandstypen
  • Je hebt de keuze uit meerdere synchronisatiemodi

Overzicht oplossingen

Met Amazon Kendra kunt u meerdere gegevensbronnen configureren om een ​​centrale plek te bieden voor het doorzoeken van uw documentrepository. Voor onze oplossing laten we zien hoe u een Confluence-repository kunt indexeren met behulp van de Amazon Kendra-connector voor Confluence. De oplossing bestaat uit de volgende stappen:

  1. Kies een authenticatiemechanisme.
  2. Configureer een app op Confluence en ontvang de verbindingsdetails.
  3. Bewaar de gegevens in AWS-geheimenmanager.
  4. Maak een Confluence-gegevensbron V2 via de Amazon Kendra-console.
  5. Indexeer de gegevens in de Confluence-repository.
  6. Voer een voorbeeldquery uit om de oplossing te testen.

Voorwaarden

Om de Amazon Kendra-connector voor Confluence uit te proberen, heb je het volgende nodig:

Kies een authenticatiemechanisme

Kies uw gewenste authenticatiemethode:

  • Basic - Dit werkt op zowel de Cloud- als de Data Center-editie. U hebt een gebruikers-ID en een wachtwoord nodig om deze methode te configureren.
  • Persoonlijke toegangstoken – Deze optie werkt alleen voor de Data Center-editie.
  • OAuth2 - Dit is meer betrokken en werkt voor zowel Cloud- als Data Center-edities.

Verzamel authenticatiegegevens

In dit gedeelte laten we de stappen zien om uw authenticatiegegevens te verzamelen, afhankelijk van uw authenticatiemethode.

Basisverificatie

Voor basisauthenticatie met de Data Center-editie heeft u alleen uw login en wachtwoord nodig. Zorg ervoor dat uw login rechten heeft om alle inhoud te verzamelen.

Voor de Cloud-editie dient uw gebruikers-ID als uw gebruikerslogin. Voor uw wachtwoord heeft u een token nodig. Voer de volgende stappen uit:

  1. Inloggen https://id.atlassian.com/manage-profile/security/api-tokens En kies API-token maken.

  1. Voor label, voer een naam in voor het token.
  2. Kies creëren.

  1. Kopieer de waarde en sla deze op om te gebruiken als uw wachtwoord.

Persoonlijke toegangstoken

Deze authenticatiemethode werkt alleen voor on-premises (datacenter). Voer de volgende stappen uit om authenticatiegegevens te verkrijgen:

  1. Meld u aan bij uw Confluence-URL met de gebruikers-ID en het wachtwoord die Amazon Kendra moet gebruiken bij het ophalen van inhoud.
  2. Kies het profielpictogram en kies Instellingen.

  1. Kies Persoonlijke toegangstokens in het navigatievenster en kies vervolgens Token maken.

token maken

  1. Voor Token naam, voer een naam in.
  2. Voor Vervaldatum, deselecteren Automatische vervaldatum.
  3. Kies creëren.

  1. Kopieer het token en bewaar het op een veilige plaats.

Om Secrets Manager te configureren, gebruiken we de login-URL en deze waarde.

OAuth2-authenticatie voor Confluence Cloud-editie

Deze authenticatiemethode volgt het volledige OAuth2.0 (3LO) documentatie van Samenvloeiing. We maken en configureren eerst een app op Confluence en schakelen deze in voor OAuth2. Het proces is iets anders voor de Cloud- en Data Center-edities. We krijgen dan een autorisatietoken en wisselen deze in voor een toegangstoken. Ten slotte krijgen we de klant-ID, het klantgeheim en de klantcode. Voer de volgende stappen uit:

  1. Log in op de Confluence-app.
  2. Navigeer naar https://developer.atlassian.com/.
  3. Naast Mijn apps, kiezen creëren En kies OAuth2-integratie.

  1. Voor Naam, voer een naam in.
  2. Kies creëren.

  1. Kies autorisatie in het navigatievenster.
  2. Kies Toevoegen naast uw autorisatietype.

  1. Voor Terugbel-URL, voer de URL in die je gebruikt om in te loggen bij Confluence.
  2. Kies Wijzigingen opslaan.

wijzigingen opslaan

  1. Onder Autorisatie-URL-generator, kiezen API's toevoegen.

api's toevoegen

  1. Naast API voor gebruikersidentiteit, kiezen Toevoegen, kies dan Configure .

machtigingen toevoegen

  1. Kies Bereiken bewerken om leesbereiken voor de app te configureren.
  2. kies Bekijk actief gebruikersprofiel en Gebruikersprofielen bekijken.

bereik bewerken

  1. Kies machtigingen in het navigatievenster.
  2. Naast Confluence-API, kiezen Toevoegen, kies dan Configure .
  3. Op de Klassieke scopes tabblad, kies Bereiken bewerken.
  4. Selecteer alle lees-, zoek- en downloadbereiken.
  5. Kies Bespaar.

granulaire scopes

  1. Op de Gedetailleerde scopes tabblad, kies Bereiken bewerken.
  2. Zoek naar read en selecteer alle gevonden scopes.
  3. Kies Bespaar.

scope keuze bevestiging

  1. Kies autorisatie in het navigatievenster.
  2. Kies naast uw autorisatietype Configure .

autorisatietype configureren

U zou drie URL's moeten zien staan.

gegenereerde URL's

  1. Kopieer de code voor Gedetailleerde Confluence API-autorisatie-URL.

Het volgende is voorbeeldcode:

https://auth.atlassian.com/authorize?
audience=api.atlassian.com
&client_id=YOUR_CLIENT_ID
&scope=REQUESTED_SCOPE%20REQUESTED_SCOPE_TWO &redirect_uri=https://YOUR_APP_CALLBACK_URL
&state=YOUR_USER_BOUND_VALUE
&response_type=code
&prompt=consent

  1. Als u een vernieuwingstoken wilt genereren zodat u dit proces niet hoeft te herhalen, voegt u toe offline_access (of %20offline_access) toe aan het einde van alle bereiken in de URL (bijvoorbeeld &scope=REQUESTED_SCOPE%20REQUESTED_SCOPE_TWO%20offline_access).
  2. Als u elke keer een nieuw token wilt genereren, voert u gewoon de URL in uw browser in.
  3. Kies ACCEPTEREN.

kies accepteren

Je wordt omgeleid naar je startpagina van Confluence.

  1. Inspecteer de browser-URL en zoek code=xxxxx.
  2. Kopieer deze code en sla deze op.

Dit is de autorisatiecode die we gebruiken om uit te wisselen met het toegangstoken.

autorisatiecode kopiëren

  1. Keer terug naar de Atlassian-ontwikkelaarsconsole en kies Instellingen in het navigatievenster.
  2. Kopieer de waarden van de client-ID en geheime ID en sla ze op.

We hebben deze waarden nodig om een ​​aanroep te doen om het autorisatietoken uit te wisselen met het toegangstoken.

postbode hulpprogramma

Vervolgens gebruiken we de Postbode hulpprogramma om de autorisatiecode te posten om het toegangstoken te krijgen. U kunt alternatieve tools gebruiken, zoals krullen om dit ook te doen.

  1. De URL om de autorisatiecode te plaatsen is https://auth.atlassian.com/oauth/token.
  2. De te posten JSON-body is als volgt:
    {"grant_type": "authorization_code", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET", "code": "YOUR_AUTHORIZATION_CODE", "redirect_uri": "https://YOUR_APP_CALLBACK_URL"}

De grant_type parameter is hard gecodeerd. We verzamelden de waarden voor client_id en client_secret in een vorige stap. De waarde voor code is de autorisatiecode die we eerder hebben verzameld.

Bij een succesvolle reactie wordt het toegangstoken geretourneerd. Als je eerder offline toegang tot de URL hebt toegevoegd, krijg je ook een vernieuwingstoken.

retourneer antwoord met toegangstoken

  1. Sla het toegangstoken op om te gebruiken bij het instellen van Secrets Manager.

Als u een nieuw token genereert op basis van het vernieuwingstoken, is het huidige token slechts 1 uur geldig. Als je een nieuw token nodig hebt, kun je helemaal opnieuw beginnen. Als u echter het vernieuwingstoken hebt, zoals voorheen, gebruikt u Postman om naar de volgende URL te posten: https://auth.atlassian.com/oauth/token. Gebruik de volgende JSON-indeling voor de hoofdtekst van het token:

{"grant_type": "refresh_token", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET", "refresh_token": "YOUR_REFRESH_TOKEN"}

De aanroep retourneert een nieuw toegangstoken

nieuw toegangstoken

OAuth2-authenticatie voor Confluence Data Center-editie

Als u de Data Center-editie met OAuth2-authenticatie gebruikt, voert u de volgende stappen uit:

  1. Log in op de Confluence Data Center-editie.
  2. Kies het tandwielpictogram en kies vervolgens Algemene configuratie.
  3. Kies in het navigatievenster Applicatielinks, kies dan Link maken.
  4. In het Link maken pop-upvenster, selecteer Externe applicatie en Inkomend, kies dan voortzetten.
  5. Voor Naam, voer een naam in.
  6. Voor Omleidings-URL, ga naar binnen https://httpbin.org/.
  7. Kies Bespaar.
  8. Kopieer de waarden voor de client-ID en het clientgeheim en sla deze op.
  9. Open de URL op een apart browsertabblad https://example-app.com/pkce.
  10. Kies Willekeurige reeks genereren en Hasj berekenen.
  11. Kopieer de waarde eronder Code-uitdaging.

  12. Keer terug naar je oorspronkelijke tabblad.
  13. Gebruik de volgende URL om de autorisatiecode op te halen:
    https://<confluence url>/rest/oauth2/latest/authorize
    ?client_id=CLIENT_ID
    &redirect_uri=REDIRECT_URI
    &response_type=code
    &scope=SCOPE
    &code_challenge=CODE_CHALLENGE
    &code_challenge_method=S256

Gebruik de client-ID die u eerder hebt gekopieerd, en https://httpbin.org voor de omleidings-URI. Voor CODE_CHALLENGE, voer de code in die je eerder hebt gekopieerd.

  1. Kies Allow.

Je wordt doorverwezen naar httpbin.org.

  1. Sla de code op om in de volgende stap te gebruiken.

  1. Gebruik een tool zoals krullen or Postbode om de volgende waarden naar te posten https://<your confluence URL>/rest/oauth2/latest/token:
    grant_type: authorization_code
    client_id: YOUR_CLIENT_ID
    client_secret: YOUR_CLIENT_SECRET
    code: YOUR_AUTHORIZATION_CODE
    code_verifier: CODE_VERIFIER
    redirect_uri: YOUR_REDIRECT_URL

Gebruik de klant-ID, het klantgeheim en de autorisatiecode die u eerder hebt opgeslagen. Voor CODE_VERIFIER, voer de waarde in vanaf het moment dat u de code-uitdaging heeft gegenereerd.

  1. Kopieer het toegangstoken en het vernieuwingstoken om later te gebruiken

kopieer toegangs- en vernieuwingstokens

Het toegangstoken en het vernieuwingstoken zijn slechts 1 uur geldig. Om het token te vernieuwen, plaatst u de volgende code op dezelfde URL om nieuwe waarden te krijgen:

grant_type: refresh_token
client_id: YOUR_CLIENT_ID
client_secret: YOUR_CLIENT_SECRET
refresh_token: REFRESH_TOKEN
redirect_uri: YOUR_REDIRECT_URL

De nieuwe tokens zijn 1 uur geldig.

nieuwe tokens

Bewaar Confluence-referenties in Secrets Manager

Voer de volgende stappen uit om uw Confluence-referenties op te slaan in Secrets Manager:

  1. Kies op de Secrets Manager-console Bewaar een nieuw geheim.
  2. kies Ander soort geheim.

ander type

  1. Voer de sleutel/waarden als volgt in, afhankelijk van het type geheim:
    • Voer voor Confluence Cloud-basisauthenticatie de volgende sleutel-waardeparen in (houd er rekening mee dat het wachtwoord niet het inlogwachtwoord is, maar het token dat u eerder hebt gemaakt):
      "username" : "<your login username>", "password" : "<your token value>"

    • Voer voor Confluence Cloud OAuth-authenticatie de volgende sleutel-waardeparen in:
      "confluenceAppKey" : “<your clientid>” "confluenceAppSecret" : “<your client Secret>” "confluenceAccessToken" : “<your access token>” "confluenceRefreshToken" : “<your refresh token>”

    • Voer voor de basisverificatie van Confluence Data Center de volgende sleutel-waardeparen in:
      "username" : "<login username>" "password" : "<login password>"

    • Voer voor Confluence Data Center persoonlijke toegangstokenverificatie de volgende sleutel-waardeparen in:
      "patToken" :"<your personal access token>"

    • Voer voor Confluence Data Center OAuth-authenticatie de volgende sleutel-waardeparen in:
      "confluenceAppKey" : "<your client id>" "confluenceAppSecret" : “<your Client Secret>” "confluenceAccessToken" : “<your Access Token>" "confluenceRefreshToken" : “<your refresh token>”

  1. Kies Volgende.

kies volgende

  1. Voor Geheime naam, voer een naam in (bijvoorbeeld AmazonKendra-my-confluence-secret).
  2. Voer een optionele beschrijving in.
  3. Kies Volgende.

configureren geheim

  1. In het Rotatie configureren sectie, bewaar alle instellingen op hun standaardwaarden en kies Volgende.

rotatie configureren

  1. Op de Beoordeling pagina, kies Shop.

Configureer de Amazon Kendra-connector voor Confluence

Voer de volgende stappen uit om de Amazon Kendra-connector te configureren:

  1. Kies op de Amazon Kendra-console Maak een index.

een index maken

  1. Voor Indexnaam, voer een naam in voor de index (bijvoorbeeld my-confluence-index).
  2. Voer een optionele beschrijving in.
  3. Voor Rol naam, voer een IAM-rolnaam in.
  4. Configureer optionele coderingsinstellingen en tags.
  5. Kies Volgende.

geef indexdetails op

  1. In het Gebruikerstoegangsbeheer configureren sectie, laat de instellingen op hun standaardwaarden en kies Volgende.

gebruikerstoegangsbeheer configureren

  1. In het Specificeer inrichting sectie, selecteer Developer-editie En kies Volgende.

bevoorrading specificeren

  1. Kies op de beoordelingspagina creëren.

Dit creëert en verspreidt de IAM-rol en creëert vervolgens de Amazon Kendra-index, wat tot 30 minuten kan duren.

index gemaakt

Maak een Confluence-gegevensbron

Voer de volgende stappen uit om uw gegevensbron te maken:

  1. Kies op de Amazon Kendra-console Data bronnen in het navigatievenster.
  2. Onder Confluence-connector V2.0, kiezen Connector toevoegen.

.

  1. Voor Naam gegevensbron, voer een naam in (bijvoorbeeld my-Confluence-data-source).
  2. Voer een optionele beschrijving in.
  3. Kies Volgende.

gegevensbrongegevens specificeren

  1. Kies een van beide Confluence-wolk or Confluence-server afhankelijk van uw gegevensbron.
  2. Voor authenticatie, kies uw authenticatie-optie.
  3. kies Identiteitscrawler is ingeschakeld.
  4. Voor IAM-rolKiezen Maak een nieuwe rol.
  5. Voor Rol naam, voer een naam in (bijvoorbeeld AmazonKendra-my-confluence-datasource-role).
  6. Kies Volgende.

definieert toegang en beveiliging

Voor Confluence Data Center- en Cloud-edities kunnen we aanvullende optionele informatie toevoegen (niet weergegeven), zoals de VPC. Alleen voor de Data Center-editie kunnen we aanvullende informatie voor de webproxy toevoegen. Er is ook een extra authenticatieoptie bij gebruik van een persoonlijk toegangstoken dat alleen geldig is voor Data Center en niet voor Cloud-editie.

  1. Voor Synchronisatiebereik, selecteert u alle inhoud die u wilt synchroniseren.
  2. Voor Synchronisatiemodusselecteer Volledige synchronisatie.
  3. Voor Frequentie, kiezen Rennen op aanvraag.
  4. Kies Volgende.

synchronisatie-instellingen configureren

  1. Optioneel kunt u toewijzingsvelden instellen.

Het toewijzen van velden is een nuttige oefening waarbij u veldnamen kunt vervangen door waarden die gebruiksvriendelijk zijn en passen in het vocabulaire van uw organisatie.

  1. Bewaar voor dit bericht alle standaardinstellingen en kies Volgende.

veldtoewijzingen instellen

  1. Bekijk de instellingen en kies Gegevensbron toevoegen.
  2. Kies om de gegevensbron te synchroniseren Synchroniseer nu.

gegevensbron synchroniseren

Er verschijnt een bannerbericht wanneer de synchronisatie is voltooid.

Test de oplossing

Nu je de inhoud van je Confluence-account hebt opgenomen in je Amazon Kendra-index, kun je enkele vragen testen. Voor onze test hebben we een Confluence-website gemaakt met twee teams: team1 met het lid Analyst1 en team2 met het lid Analyst2.

  1. Navigeer op de Amazon Kendra-console naar uw index en kies Doorzoek geïndexeerde inhoud.
  2. Voer een voorbeeldzoekopdracht in en bekijk uw zoekresultaten (uw resultaten variëren op basis van de inhoud van uw account).

eenvoudig zoeken

De Confluence-connector crawlt ook lokale identiteitsgegevens van Confluence. U kunt deze functie gebruiken om uw zoekopdracht per gebruiker te verfijnen. Confluence biedt uitgebreide zichtbaarheidsopties. Gebruikers kunnen ervoor kiezen hun inhoud te laten zien door andere gebruikers, op ruimteniveau of door groepen. Wanneer u uw zoekopdrachten filtert op gebruikers, retourneert de query alleen die documenten waartoe de gebruiker toegang heeft op het moment van opname.

  1. Vouw uit om deze functie te gebruiken Testquery met gebruikersnaam of groepen En kies Gebruikersnaam of groepen toepassen.
  2. Voer de gebruikersnaam van uw gebruiker in en kies Solliciteer.

Houd er rekening mee dat voor de Confluence Data Center-editie de gebruikersnaam de e-mail-ID is.

gebruikersnaam of groepen toepassen

Voer uw zoekopdracht opnieuw uit.

Dit levert u een gefilterde reeks resultaten op. Merk op dat we slechts 62 resultaten terugbrengen.

gefilterd resultaatw

We gaan nu terug en beperken Bob Straham om alleen toegang te krijgen tot zijn werkruimte en de zoekopdracht opnieuw uit te voeren.

Bob's resultaten

Merk op dat we slechts een subset van de resultaten krijgen omdat de zoekopdracht beperkt is tot alleen de inhoud van Bob.

Wanneer je Amazon Kendra confronteert met een applicatie zoals een applicatie die is gebouwd met behulp van Ervaringsbouwer, kunt u de gebruikersidentiteit (in de vorm van de e-mail-ID voor Cloud-editie of gebruikersnaam voor Data Center-editie) doorgeven aan Amazon Kendra om ervoor te zorgen dat elke gebruiker alleen inhoud ziet die specifiek is voor zijn gebruikers-ID. Als alternatief kunt u gebruiken AWS IAM Identiteitscentrum (opvolger van AWS Single Sign-On) om gebruikerscontext te controleren die wordt doorgegeven aan Amazon Kendra om zoekopdrachten per gebruiker te beperken.

Gefeliciteerd! Je hebt met succes Amazon Kendra gebruikt om antwoorden en inzichten naar boven te halen op basis van de inhoud die is geïndexeerd vanuit je Confluence-account.

Opruimen

Om toekomstige kosten te voorkomen, ruimt u de resources op die u als onderdeel van deze oplossing hebt gemaakt. Als u tijdens het testen van deze oplossing een nieuwe Amazon Kendra-index hebt gemaakt, verwijdert u deze. Als u alleen een nieuwe gegevensbron hebt toegevoegd met behulp van de Amazon Kendra-connector voor Confluence V2, verwijdert u die gegevensbron.

Conclusie

Met de nieuwe Confluence-connector V2 voor Amazon Kendra kunnen organisaties gebruikmaken van de opslagplaats van informatie die veilig in hun account is opgeslagen met behulp van intelligent zoeken mogelijk gemaakt door Amazon Kendra.

Raadpleeg voor meer informatie over deze mogelijkheden en meer de Amazon Kendra-ontwikkelaarsgids. Raadpleeg voor meer informatie over hoe je metadata en inhoud kunt maken, wijzigen of verwijderen bij het opnemen van je gegevens van Confluence Uw documenten verrijken tijdens inname en Verrijk uw inhoud en metadata om uw zoekervaring te verbeteren met aangepaste documentverrijking in Amazon Kendra.


Over de auteur

Ashish Lagwankar is Senior Enterprise Solutions Architect bij AWS. Zijn belangrijkste interesses zijn AI/ML, serverloze en containertechnologieën. Ashish is gevestigd in de omgeving van Boston, MA en houdt van lezen, buitenshuis en tijd doorbrengen met zijn gezin.

spot_img

Laatste intelligentie

spot_img

Chat met ons

Hallo daar! Hoe kan ik u helpen?