Confluence

Pode usar o conector do Confluence para realizar operações de inserção, eliminação, atualização e leitura no Confluence.

Antes de começar

Antes de usar o conector do Confluence, faça as seguintes tarefas:

• No seu projeto do Google Cloud:
  • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
  • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
  • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

  • Ative os seguintes serviços:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (API Connectors)

    Para saber como ativar serviços, consulte o artigo Ativar serviços.

  Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

   Aceda à página Ligações

2. Clique em + CRIAR NOVO para abrir a página Criar associação.
3. Na secção Localização, escolha a localização para a ligação.
   1. Região: selecione uma localização na lista pendente.

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

   2. Clique em SEGUINTE.
4. Na secção Detalhes da associação, conclua o seguinte:
   1. Conetor: selecione Confluence na lista pendente de conetores disponíveis.
   2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
   3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
   4. Opcionalmente, introduza uma Descrição para a instância de associação.
   5. Opcionalmente, ative o Cloud Logging e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Erro.
   6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
   7. Opcionalmente, selecione Incluir espaços arquivados para incluir conteúdo de espaços arquivados no resultado. A predefinição é False.
   8. Opcionalmente, introduza uma chave de espaço para que a pesquisa apresente conteúdo apenas deste espaço específico.
   9. Opcionalmente, configure as definições do nó de associação:
      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

   Nota: só pode personalizar os valores dos nós de associação se for cliente de pagamento conforme o uso.
   10. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
   11. Clique em SEGUINTE.
5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
   1. Tipo de destino: selecione um Tipo de destino.
      • Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
      • Para estabelecer uma ligação privada, selecione Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.
        Nota: para saber como criar uma associação de ponto final, consulte Associação de serviço do PSC e Associação de ponto final. Depois de criar a associação do ponto final, esta fica visível na lista Associação do ponto final.

      Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.

      Para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.

   2. Clique em SEGUINTE.
6. Na secção Autenticação, introduza os detalhes de autenticação.
   1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pelo conector do Confluence:

      • Básico
      • APIToken
      • OAuth2.0

   Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

   2. Clique em SEGUINTE.
7. Rever: reveja os detalhes da ligação e da autenticação.
8. Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

• Básico
  • Nome de utilizador: a conta de utilizador do Confluence usada para autenticação.
  • Palavra-passe: a palavra-passe associada à conta.
• APIToken
  • Nome de utilizador: o nome de utilizador do Confluence usado para criar o token de API.
  • Token de API: a palavra-passe para o nome de utilizador é um token de API. Selecione o segredo do Secret Manager que contém o token da API associado ao nome de utilizador do Confluence.
• OAuth 2.0 – Código de autorização
  • ID de cliente: ID de cliente conforme fornecido pela sua aplicação externa.
  • Âmbitos: âmbitos de autorização. O âmbito offline_access tem de ser usado com o conector do Confluence. Para mais informações sobre os âmbitos do Confluence, consulte o artigo Âmbitos do Confluence.
  • Segredo do cliente: selecione o segredo do Secret Manager. Deve ter criado o segredo do Secret Manager antes de configurar esta autorização.
  • Versão do Secret: versão do Secret do Secret Manager para o segredo do cliente.

  Para o tipo de autenticação Authorization code, depois de criar a associação, tem de efetuar alguns passos adicionais para configurar a autenticação. Para mais informações, consulte Passos adicionais após a criação da associação.

  Nota: se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação Confluence, tem de voltar a autorizar a ligação ao Confluence. Para saber como autorizar novamente, consulte o artigo Autorização novamente para o código de autorização.

Passos adicionais após a criação da associação

Se selecionou OAuth 2.0 - Authorization code para a autenticação, tem de realizar os seguintes passos adicionais após criar a associação:

1. Na página Ligações, encontre a ligação criada recentemente.

   Tenha em atenção que o Estado do novo conetor é Autorização necessária.

2. Clique em Autorização obrigatória.

   É apresentado o painel Editar autorização.

3. Copie o valor do URI de redirecionamento para a sua aplicação externa.
4. Valide os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Nova autorização para o código de autorização

Se estiver a usar o tipo de autenticação Authorization code e tiver feito alterações de configuração na sua aplicação Confluence, tem de voltar a autorizar a ligação ao Confluence. Para autorizar novamente uma associação, siga estes passos:

1. Clique na associação necessária na página Associações.

   É apresentada a página de detalhes da associação.

2. Clique em Editar para editar os detalhes da associação.
3. Valide os detalhes de OAuth 2.0 – Código de autorização na secção Autenticação.

   Se necessário, faça as alterações necessárias.

4. Clique em Guardar. Esta ação direciona para a página de detalhes da associação.
5. Clique em Editar autorização na secção Autenticação. É apresentado o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o estado da ligação é definido como Ativo na página Ligações.

Limitações do sistema

O conector do Confluence pode processar 28 transações por segundo, por nó, e limita quaisquer transações que excedam este limite. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Nota: o número de nós de conectores de integração é dimensionado automaticamente de forma dinâmica com base na sua utilização. No entanto, se quiser reservar capacidade para grandes volumes sem esperar pela escalabilidade automática, pode ajustar o valor mínimo de nós para uma ligação. São necessários mais nós para processar mais transações para uma associação. Por outro lado, são necessários menos nós se uma associação processar menos transações. Para configurar os valores dos nós, faça o seguinte:

• Se for cliente de pagamento conforme o uso, configure o valor mínimo e máximo do nó na página de edição da associação.
• Se for cliente com base numa subscrição, contacte o apoio técnico.

O número máximo de transações que um nó pode processar depende de vários fatores. Assim, antes de ajustar os nós mínimos para um melhor débito, é recomendável verificar se os seus sistemas de back-end estão configurados de forma ideal para processar o tráfego necessário.

Use a associação do Confluence numa integração

Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

• Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
• Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

Nota: pode ver as entidades, as operações e as ações de um conector na tarefa Conectores.

• Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não suporte ou não tenha entidades, caso em que a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:
  • Lista
  • Obter
  • Criar
  • Atualizar
  • Eliminar

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

• Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Nota: todas as entidades e ações têm um esquema associado. Por exemplo, um esquema de ação tem os detalhes dos parâmetros, como os nomes dos parâmetros e o respetivo tipo de dados. O esquema (metadados) para entidades e ações é obtido pela ligação em tempo de execução a partir do seu back-end. Se existirem atualizações ao esquema, estas não são refletidas automaticamente nas suas associações existentes. Tem de atualizar o esquema manualmente. Para atualizar o esquema de uma associação, abra a página Detalhes da associação da associação e, de seguida, clique em Atualizar esquema da associação.

Ações

O conetor do Confluence oferece ações como DownloadAttachment e UploadAttachment. Para compreender como configurar as ações, consulte os exemplos de ações.

Exemplos de ações

Esta secção descreve como realizar algumas das ações neste conector.

Exemplo: transferir anexo

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DownloadAttachment e, de seguida, clique em Concluído.
3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no campo Default Value:

     {
       "AttachmentId": "xyz"
     }

Exemplos de operações de entidades

Exemplo: listar todos os pedidos

Este exemplo apresenta todas as solicitações na entidade Requests.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Pedidos na lista Entity.
3. Selecione a operação LIST e, de seguida, clique em Concluído.

Exemplo: obter utilizador a partir de um ID da conta específico

Este exemplo obtém o utilizador com o AccountId 6035864ce2020c0070b5285b da entidade Users.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Users na lista Entity.
3. Selecione a operação LIST e, de seguida, clique em Concluído.
4. Na secção Task Input da tarefa Connectors, clique em filterClause e introduza AccountId=6035864ce2020c0070b5285b no campo Default Value.

   Aqui, AccountId é o valor-chave principal da entidade Users.

Exemplo: páginas de listas

Este exemplo apresenta as páginas da entidade Pages.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Pages na lista Entity.
3. Selecione a operação LIST e, de seguida, clique em Concluído.

Exemplo: obter páginas

Este exemplo obtém um registo de página da entidade Pages.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Pages na lista Entity.
3. Selecione a operação GET e, de seguida, clique em Concluído.
4. Na secção Entrada de tarefas da tarefa Conectores, clique em entityId e, de seguida, introduza 123 no campo Valor predefinido.

   Aqui, 123 é um identificador exclusivo da entidade de recurso Pages.

Exemplo: criar páginas

Este exemplo cria um registo de página na entidade Pages.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Pages na lista Entity.
3. Selecione a operação CREATE e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e, de seguida, introduza um valor semelhante ao seguinte no 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. Na secção Entrada de tarefas da tarefa Conectores, clique em entityId e, de seguida, introduza 12345 no campo Valor predefinido.

Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem a resposta da operação de atualização.

{
    "Id": 1234
    }

Exemplo: elimine uma página

Este exemplo elimina uma página da entidade Pages.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Pages na lista Entity.
3. Selecione a operação DELETE e, de seguida, clique em Concluído.
4. Na secção Entrada da tarefa da tarefa Conectores, clique em entityId e, em seguida, introduza 123 no campo Valor predefinido.

   Em alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, pode definir o filterClause. Por exemplo, Id='123'.

Crie ligações com o Terraform

Pode usar o recurso do Terraform para criar uma nova associação.

Para saber como aplicar ou remover uma configuração do Terraform, consulte os comandos básicos do Terraform.

Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatória	Descrição
proxy_enabled	BOOLEAN	Falso	Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma palavra-passe a usar para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

Obtenha ajuda da comunidade do Google Cloud

Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

O que se segue?

• Compreenda como suspender e retomar uma associação.
• Compreenda como monitorizar a utilização do conector.
• Compreenda como ver os registos do conetor.