Conector Confluence v2.0 - Amazon Kendra
Atributos compatíveisPré-requisitosInstruções de conexão

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Conector Confluence v2.0

O Confluence é uma ferramenta colaborativa de gerenciamento de trabalho projetada para compartilhar, armazenar e trabalhar no planejamento de projetos, no desenvolvimento de software e no gerenciamento de produtos. Você pode usar o Amazon Kendra para indexar espaços, páginas (incluindo páginas aninhadas), blogs e comentários e anexos em páginas e blogs indexados.

Para solucionar problemas do conector da fonte de dados do Amazon Kendra Confluence, consulte. Solucionar problemas de origens de dados

Atributos compatíveis

Amazon Kendra O conector de fonte de dados do Confluence oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Padrões de inclusão/exclusão

  • Sincronizações de conteúdo completas e incrementais

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Confluence, faça essas alterações no Confluence e nas contas. AWS

No Confluence, verifique se você tem:

  • Copiar o URL da sua instância do Confluence. Por exemplo: https://example.confluence.com, https://www.example.confluence.com/ ou https://atlassian.net/. O URL da instância do Confluence é necessário para se conectar ao Amazon Kendra.

    Se você estiver usando o Confluence Cloud, o URL do seu host deve terminar com atlassian.net/.

    nota

    Os seguintes formatos de URL não são compatíveis:

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

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

    • https://atlassian.net/xyz

    nota

    (Local/servidor) Amazon Kendra verifica se as informações do endpoint incluídas são as mesmas especificadas nos AWS Secrets Manager detalhes de configuração da fonte de dados. Isso ajuda a proteger contra o problema de assistência confusa, que é um problema de segurança em que um usuário não tem permissão para realizar uma ação, mas usa o Amazon Kendra como proxy para acessar a senha configurada e realizar a ação. Se você alterar posteriormente as informações do endpoint, crie uma nova senha para sincronizar essas informações.

  • Credenciais básicas de autenticação configuradas contendo um nome de usuário (ID de e-mail usado para fazer login no Confluence) e senha (token da API do Confluence como senha). Consulte Gerenciar tokens de API para sua conta Atlassian.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

  • Opcional: credenciais do OAuth 2.0 configuradas contendo uma chave do aplicativo Confluence, um segredo do aplicativo Confluence, um token de acesso do Confluence e um token de atualização do Confluence para permitir a conexão com sua instância do Confluence. Amazon Kendra Se o token de acesso expirar, você poderá usar o token de atualização para regenerar o token de acesso e o par de tokens de atualização. Ou você pode repetir o processo de autorização. Para obter mais informações sobre tokens de acesso, consulte Gerenciar tokens de acesso OAuth.

  • (Somente para servidor/data center do Confluence) Opcional: configurou um token de acesso pessoal (PAT) no Confluence. Consulte Uso de tokens de acesso pessoal.

No seu Conta da AWS, verifique se você tem:

  • Criou um Amazon Kendra índice e, se estiver usando a API, anotei o ID do índice.

  • Criou uma IAM função para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.

    nota

    Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.

  • Armazenou suas credenciais de autenticação do Confluence em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

    nota

    Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Confluence a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de dados do Confluence, você deve fornecer os detalhes necessários da sua fonte de dados do Confluence para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Confluence para o Amazon Kendra , consulte Pré-requisitos.

Console

Para se conectar Amazon Kendra ao Confluence

  1. Faça login no AWS Management Console e abra o Amazon Kendra console.

  2. No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

    nota

    Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha Conector do Confluence e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Confluence com a tag “V2.0".

  5. Na página Especar detalhes da fonte de dados, insira as seguintes informações:

    1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.

    2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.

    3. Em Idioma padrão — Escolha um idioma para filtrar seus documentos para o índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.

    4. Em Tags, em Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. Em Source, escolha Confluence Cloud ou Confluence Server/Data Center.

    2. URL do Confluence insira o URL do host do Confluence. Por exemplo, https://example.confluence.com.

    3. (Somente para o Confluence Server/Data Center) Local do certificado SSL - opcional — Insira o Amazon S3 caminho para seu arquivo de certificado SSL para o Confluence Server.

    4. (Somente para o Confluence Server/Data Center) Proxy Web - opcional — Insira o nome do host do proxy web (sem o https:// protocolo http:// or) e o número da porta (porta usada pelo protocolo de transporte de URL do host). O número da porta deve ser um valor numérico entre 0 e 65535.

    5. Autorização — Ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

    6. Autenticação — escolha entre autenticação básica, autenticação Oauth 2.0 ou (somente para servidor/data center do Confluence) autenticação de token de acesso pessoal.

    7. Senha do AWS Secrets Manager : escolha uma senha existente ou crie uma nova senha do Secrets Manager para armazenar as credenciais do Confluence. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta. Insira as seguintes informações na janela:

      1. Senha: um nome para sua senha. O prefixo 'AmazonKendra-Confluence-' é adicionado automaticamente ao seu nome secreto.

      2. Se estiver usando a autenticação básica, insira o nome secreto, o nome de usuário e a senha (token da API do Confluence como senha) que você configurou no Confluence.

        Se estiver usando a autenticação OAuth2.0 — insira o nome secreto, a chave do aplicativo, o segredo do aplicativo, o token de acesso e o token de atualização que você configurou no Confluence.

        (Somente Servidor/Data Center do Confluence) Se estiver usando a autenticação do Personal Access Token, insira o nome secreto e o token do Confluence que você configurou no seu Confluence.

      3. Salve e adicione seu segredo.

    8. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    9. Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

    10. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.

    11. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. Em Escopo de sincronização, para Sincronizar conteúdo — Escolha sincronizar entre os seguintes tipos de conteúdo: páginas, comentários de páginas, anexos de páginas, blogs, comentários de blog, anexos de blog, espaços pessoais e espaços arquivados.

      nota

      Comentários e anexos de página só podem ser selecionados se você optar por sincronizar páginas. Comentários e anexos do blog só podem ser selecionados se você optar por sincronizar blogs.

      Importante

      Se você não especificar um padrão de regex de chave de espaço na Configuração adicional, todas as páginas e blogs serão rastreados por padrão.

    2. Em Configuração adicional, em Tamanho máximo do arquivo — Especifique o limite de tamanho do arquivo em MBs que Amazon Kendra será rastreado. Amazon Kendra rastreará somente os arquivos dentro do limite de tamanho que você definir. O tamanho padrão do arquivo é 50 MB. O tamanho máximo do arquivo deve ser maior que 0 MB e menor ou igual a 50 MB.

      Para padrões regex de espaços — especifique se deseja incluir ou excluir espaços específicos em seu índice usando:

      • Tecla de espaço (por exemplo, my-space-123)

        nota

        Se você não especificar um padrão de regex de chave de espaço, todas as páginas e blogs serão rastreados por padrão.

      • URL (por exemplo,. *//MySiteMyDocuments/)

      • Tipo de arquivo (por exemplo, .*\ .pdf, .*\ .txt)

      Para padrões de regex de títulos de entidades — especifique padrões de expressão regular para incluir ou excluir determinados blogs, páginas, comentários e anexos por títulos.

      nota

      Se quiser incluir ou excluir o rastreamento de uma página ou subpágina específica, você pode usar padrões de regex do título da página.

    3. Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização.

      • Sincronização completa: indexe todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados for sincronizada com seu índice.

      • Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

    4. Em Cronograma de execução de sincronização, em Frequência — Escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar seu índice.

    5. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Selecione entre os campos da fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice. Para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.

    2. Escolha Próximo.

  9. Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para se conectar Amazon Kendra ao Confluence

Você deve especificar um JSON do esquema da fonte de dados usando a TemplateConfigurationAPI. Você deve fornecer as seguintes informações:

  • Fonte de dados — especifique o tipo de fonte de dados como CONFLUENCEV2 quando você usa o esquema TemplateConfigurationJSON. Também especifique a fonte de dados como TEMPLATE quando você chama a CreateDataSourceAPI.

  • URL do host — especifique a instância do URL do host do Confluence. Por exemplo, https://example.confluence.com.

  • Modo de sincronização — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização. Escolha uma das seguintes opções:

    • FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.

    • FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.

  • Tipo de autenticação — especifique o tipo de autenticação, se, BasicOAuth2, (somente no Confluence Server). Personal-token

  • (Opcional: somente para o Confluence Server) Local do certificado SSL: especifique o S3bucketName e s3certificateName usados para armazenar o certificado SSL.

  • Nome de recurso secreto da Amazon (ARN) — Forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação que você configurou no Confluence. Se você usar uma autenticação básica, a senha deverá conter uma estrutura JSON com as seguintes chaves: 

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

    Para usar a autenticação OAuth 2.0, a senha é armazenada em uma estrutura JSON com as seguintes chaves:

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

    Somente para Servidor Confluence) Se você usar uma autenticação básica, a senha deverá ser armazenada em uma estrutura JSON com as seguintes chaves:

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

    Somente para Servidor Confluence) Se você usar a autenticação de token de acesso pessoal, a senha será armazenada em uma estrutura JSON com as seguintes chaves:

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

  • IAM role — Especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar as APIs públicas necessárias para o conector do Confluence e. Amazon Kendra Para obter mais informações, consulte Funções do IAM para as fontes de dados do Confluence.

Você também pode adicionar os seguintes recursos opcionais:

  • Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para ter mais informações, consulte Configurando Amazon Kendra para usar um Amazon VPC.

  • Tamanho do arquivo — Especifique o tamanho máximo do arquivo a ser rastreado.

  • Tipos de documento/conteúdo — especifique se deseja rastrear páginas, comentários de páginas, anexos de páginas, blogs, comentários do blog, anexos do blog, espaços e espaços arquivados.

  • Filtros de inclusão e exclusão — especifique se deseja incluir ou excluir determinados espaços, páginas, blogs e seus comentários e anexos.

    nota

    A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.

  • Proxy da Web — Especifique as informações do proxy da Web se quiser se conectar à sua instância de URL do Confluence por meio de um proxy da Web. Você pode usar essa opção para o Confluence Server.

  • Lista de controle de acesso (ACL) — Especifique se deseja rastrear as informações da ACL para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.

  • Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do Confluence para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapear campos de fonte de dados.

    nota

    O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo do corpo do documento na fonte de dados para o nome do campo de índice_document_body. Todos os demais campos são opcionais.

Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte Esquema do modelo do Confluence.

Observações

  • O token de acesso pessoal (PAT) não está disponível para o Confluence Cloud.