Jira Cloud

Com o conector do Jira Cloud, você realiza operações de inserção, exclusão, atualização e leitura nos dados do Jira, que são modelados como um banco de dados.

Versões compatíveis

O conector do Jira Cloud usa as versões 2 e 3 da API REST JIRA Cloud. Elas são gerenciadas internamente e você não precisa fazer configurações extras.

Antes de começar

Antes de usar o conector do Jira Cloud, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • Conceder o papel do IAM roles/connectors.admin ao usuário e configurar o conector.
  • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

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

    Para entender como ativar os serviços, consulte Como ativar serviços.

  Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

   Acessar a página "Conexões"

2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
3. Na seção Local, escolha o local da conexão.
   1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

   2. Clique em PRÓXIMA.
4. Na seção Detalhes da conexão, faça o seguinte:
   1. Conector: selecione Jira Cloud na lista suspensa de conectores disponíveis.
   2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
   3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
   4. Como opção, insira uma Descrição para a instância de conexão.
   5. Se quiser, ative o Cloud Logging. e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
   6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
   7. Para usar a conexão para inscrições de eventos, selecione Ativar inscrição de eventos. Selecionando isso exibe as seguintes opções:
      • Ativar a assinatura de eventos com entidades e ações: selecione essa opção para usar a conexão para operações de assinatura de eventos e de conector (entidades e ações).
      • Ativar somente inscrição de eventos: selecione esta opção para usar a conexão. apenas para inscrição em eventos. Se você selecionar essa opção, clique em Próxima e configurar a inscrição em eventos.
   8. Opcionalmente, defina as Configurações do nó de conexão:
      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   9. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
   • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Básico: autenticação HTTP básica.
     • Resumo: autenticação HTTP de resumo.
   • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
   • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
   • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
     • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
     • Sempre: a conexão será sempre com SSL ativado.
     • Nunca: a conexão não está com SSL ativado.
     • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
   • Na seção Servidor proxy, insira os detalhes do servidor proxy.
     1. Clique em + Adicionar destino.
     2. Selecione um Tipo de destino.
        • Endereço do host: especifique o nome do host ou o endereço IP do destino.

          Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

          • Crie um anexo do serviço PSC.
          • Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
   10. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
   11. Clique em PRÓXIMA.
5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
   1. Tipo de destino: selecione um Tipo de destino.
      • Endereço do host: especifique o nome do host ou o endereço IP do destino.
        Observação:para especificar um nome do host, especifique o URL e o protocolo (HTTP ou HTTPS).

        Se você quiser estabelecer uma conexão particular com seu back-end, faça o seguinte:

        • Crie um anexo do serviço PSC.
        • Crie um anexo de endpoint e Depois insira os detalhes do anexo de endpoint no campo Endereço do host.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

   2. Clique em PRÓXIMA.
6. Na seção Autenticação, insira os detalhes da autenticação.
   1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do Jira Cloud:

      • Nome de usuário e senha

   Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

   2. Clique em PRÓXIMA.
7. Se você tiver ativado a inscrição de eventos, a seção Detalhes da assinatura do evento vai aparecer na página de criação de conexão. Para entender como configurar os detalhes da assinatura de eventos, consulte Configurar a assinatura de eventos.
8. Revisão: revise os detalhes de conexão e autenticação.
9. Clique em Criar.

Configurar inscrição no evento

Se você tiver ativado a assinatura de eventos, insira os seguintes valores na seção Detalhes da assinatura de eventos:

1. Selecione um Tipo de destino.
   • Endereço do host: insira o URL de registro do seu sistema de back-end no campo host.
2. Insira os detalhes de autenticação.
   1. Nome de usuário: digite o nome de usuário.
   2. Token da API: selecione o secret do Secret Manager que contém o token da API.
   3. Versão do secret: selecione a versão do secret.
3. Selecione Ativar conectividade particular para ter uma conexão segura entre o aplicativo de back-end e a conexão. Se você selecionar essa opção, será necessário realizar outras etapas de configuração depois de criar a conexão. Para mais informações, consulte Conectividade particular para assinaturas de eventos.
4. Insira a configuração de mensagens inativas. Se você configurar mensagens inativas, a conexão gravará os eventos não processados para o tópico do Pub/Sub especificado. Digite os seguintes detalhes:
   1. ID do projeto de mensagens inativas: o ID do projeto do Google Cloud em que você configurou o tópico de mensagens inativas do Pub/Sub.
   2. Tópico de mensagens inativas: o tópico do Pub/Sub em que você quer gravar os detalhes do evento não processado.
5. Se você quiser usar um proxy para se conectar ao back-end (para assinatura de eventos), digite os seguintes detalhes:
1. Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Selecionar qualquer um dos seguintes tipos de autenticação:
   • Sempre: a conexão está sempre ativada por SSL para a assinatura de eventos.
   • Nunca: a conexão não está ativada para SSL para a assinatura de eventos.
2. Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há suporte para os seguintes tipos de autenticação:
   • Básico: autenticação HTTP básica.
3. Usuário do proxy: digite o nome de usuário que será usado para a autenticação no servidor proxy.
4. Senha do proxy: selecione o secret do Secret Manager da senha do usuário.
5. Versão do secret: selecione a versão do secret.
6. Na seção Servidor proxy, insira os detalhes do servidor proxy.
   1. Clique em + Adicionar destino e selecione o Tipo de destino. como Endereço do host.
   2. Digite o nome do host ou o endereço IP do servidor proxy e o número da porta do servidor proxy.

Dica:para entender como você pode usar a assinatura de eventos na sua integrações, consulte Gatilho do Jira do Cloud.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

• Nome de usuário e senha
  • Nome de usuário: o nome de usuário do Jira Cloud a ser usado para a conexão.
  • Token da API: a senha do nome de usuário será um token da API. Selecione o Secret do Secret Manager que contém o token da API associado ao nome de usuário do Jira Cloud.
• Código de autorização OAuth 2.0
• ID do cliente: ID do cliente conforme fornecido pelo aplicativo externo.
• Escopos: escopos de permissão. O escopo offline_access precisa ser usado com o conector do Jira Cloud. Para entender como os escopos funcionam e conferir todos os disponíveis para o Jira Cloud, consulte Escopos.
• Chave secreta do cliente: selecione a chave Gerenciador de secrets. É necessário criar a chave secreta do Secret Manager antes de configurar esta autorização.
• Versão do secret: a versão do secret do cliente no Secret Manager.

Para o tipo de autenticação Authorization code, depois de criar a conexão, execute mais algumas etapas para configurar a autenticação. Para mais informações, consulte Etapas adicionais após a criação da conexão.

Observação:se você estiver usando a autenticação Authorization code tipo e tiver feito alterações de configuração no aplicativo Jira Cloud, você deverá autorizar novamente o Conexão do Jira Cloud. Para entender como fazer isso, consulte Reautorização do código de autorização.

Etapas adicionais após a criação da conexão

Se você selecionou OAuth 2.0 - Authorization code para siga estas etapas extras depois de criar a conexão:

1. Na página "Conexões", localize a conexão recém-criada.

   O Status do novo conector será Autorização necessária.

2. Clique em Autorização necessária.

   O painel Editar autorização será exibido.

3. Copie o valor de Redirect URI no seu aplicativo externo.
4. Verifique os detalhes da autorização.
5. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Reautorização do código de autorização

Se você estiver usando o tipo de autenticação Authorization code e tiver feito mudanças de configuração no aplicativo Jira Cloud, faça o seguinte: Autorize novamente sua conexão do Jira Cloud. Para autorizar uma conexão novamente, siga estas etapas:

1. Clique na conexão necessária na página "Conexões".

   A página de detalhes da conexão será aberta.

2. Clique em Editar para editar os detalhes da conexão.
3. Verifique os detalhes de OAuth 2.0 - Código de autorização na seção Autenticação.

   Se necessário, faça as mudanças necessárias.

4. Clique em Salvar. Isso leva você à página de detalhes da conexão.
5. Clique em Editar autorização na seção Autenticação. Isso mostra o painel Autorizar.
6. Clique em Autorizar.

   Se a autorização for bem-sucedida, o status da conexão será definido como Ativo na página "Conexões".

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

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

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Observação : todas as entidades e ações têm um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro como: o parâmetro e o tipo de dados correspondente. O esquema (metadados) de entidades e ações é buscado pela conexão em do seu back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. atualize manualmente o esquema. Atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar o esquema de conexão.

Limitações do sistema

O conector do Jira Cloud pode processar no máximo 10 transações por segundo, por nó, e limita as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes aguardando o escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar o nó , faça o seguinte:

• Se você é um cliente de pagamento por uso, configure os valores mínimo e máximo do nó na página "Editar conexão".
• Se você tiver uma assinatura entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para um melhor throughput, recomendamos verificar se os sistemas de back-end estão configurados de maneira ideal para processar o tráfego necessário.

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

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

Para conferir um exemplo de modelo do Terraform para a criação de conexões, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
proxy_enabled	BOOLEAN	Falso	Marque esta caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticar o proxy do ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

Usar a conexão do Jira Cloud em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.

• Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
• Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.