Configure o Openflow Connector for Jira Cloud

Nota

O conector está sujeito aos termos do conector.

Este tópico descreve as etapas para configurar o Openflow Connector for Jira Cloud.

Pré-requisitos

  1. Certifique-se de ter revisado Sobre a Openflow Connector for Jira Cloud.

  2. Certifique-se de ter configurado um Openflow.

Obtenha as credenciais

Como administrador do Jira Cloud, execute as seguintes tarefas em sua conta Atlassian:

  1. Navegue até a página de tokens da API.

  2. Selecione Create API token with scopes.

  3. Na caixa de diálogo Create an API token, forneça um nome descritivo ao token de API e selecione uma data de expiração para o token de API. Isso pode variar de 1 a 365 dias.

  4. Selecione o aplicativo de token de API Jira.

  5. Selecione os escopos do Jira read:jira-work e read:jira-user.

  6. Selecione Create token.

  7. Na caixa de diálogo Copy your API token, selecione Copy para copiar o token de API gerado e, em seguida, cole o token nos parâmetros do conector ou salve-o com segurança.

  8. Selecione Close para fechar a caixa de diálogo.

Configure a conta Snowflake

Como administrador de conta Snowflake, execute as seguintes tarefas:

  1. Crie uma nova função ou use uma função existente.

  2. Crie um novo usuário de serviço Snowflake com o tipo SERVICE.

  3. Conceda ao usuário do serviço Snowflake a função que você criou nas etapas anteriores.

  4. Configure com a autenticação de pares de chaves para o usuário do Snowflake SERVICE da etapa 2.

  5. A Snowflake recomenda enfaticamente essa etapa. Configure um gerenciador de segredos compatível com o Openflow, por exemplo, AWS, Azure e Hashicorp, e armazene as chaves públicas e privadas no armazenamento de segredos.

    Nota

    Se, por algum motivo, você não quiser usar um gerenciador de segredos, será responsável por proteger os arquivos de chave pública e chave privada usados para autenticação de pares de chaves de acordo com as políticas de segurança de sua organização.

    1. Depois que o gerenciador de segredos estiver configurado, determine como você se autenticará nele. No AWS, é recomendável que você use a função de instância EC2 associada ao Openflow, pois dessa forma nenhum outro segredo precisa ser mantido.

    2. No Openflow, configure um provedor de parâmetros associado a esse gerenciador de segredos, no menu de três traços no canto superior direito. Navegue até Controller Settings » Parameter Provider e, em seguida, busque os valores dos parâmetros.

    3. Nesse momento, todas as credenciais podem ser referenciadas com os caminhos de parâmetros associados e nenhum valor sensível precisa ser mantido no Openflow.

  6. Se qualquer outro usuário Snowflake precisar de acesso aos documentos e tabelas brutos ingeridos pelo conector (por exemplo, para processamento personalizado no Snowflake), conceda a esses usuários a função criada na etapa 1.

  7. Crie um banco de dados e um esquema no Snowflake para que o conector armazene os dados ingeridos. Conceda os seguintes Privilégios de banco de dados à função criada na primeira etapa.

    CREATE DATABASE jira_destination_db;
    CREATE SCHEMA jira_destination_db.jira_destination_schema;
    GRANT USAGE ON DATABASE jira_destination_db TO ROLE <jira_connector_role>;
    GRANT USAGE ON SCHEMA jira_destination_db.jira_destination_schema TO ROLE <jira_connector_role>;
    GRANT CREATE TABLE ON SCHEMA jira_destination_db.jira_destination_schema TO ROLE <jira_connector_role>;
    
    Copy
  8. Crie um warehouse que será usado pelo conector ou use um já existente. Comece com o menor tamanho de warehouse e, em seguida, experimente o tamanho, dependendo do número de tabelas sendo replicadas e da quantidade de dados transferidos. Os números de tabelas grandes normalmente são mais bem dimensionados com warehouses multicluster, em vez de warehouses maiores.

  9. Certifique-se de que o usuário com a função usada pelo conector tenha os privilégios necessários para usar o warehouse. Se esse não for o caso, conceda os privilégios necessários à função.

    CREATE WAREHOUSE jira_connector_warehouse WITH WAREHOUSE_SIZE = 'X-Small';
    GRANT USAGE ON WAREHOUSE jira_connector_warehouse TO ROLE <jira_connector_role>;
    
    Copy

Configuração do conector

Como engenheiro de dados, execute as seguintes tarefas para instalar e configurar o conector:

Instalação do conector

  1. Navegue até a página Visão geral do Openflow. Na seção Featured connectors, selecione View more connectors.

  2. Na página de conectores do Openflow, localize o conector e selecione Add to runtime.

  3. Na caixa de diálogo Select runtime, selecione seu tempo de execução na lista suspensa Available runtimes.

  4. Selecione Add.

    Nota

    Antes de instalar o conector, verifique se você criou um banco de dados e um esquema no Snowflake para que o conector armazene os dados ingeridos.

  5. Autentique-se na implementação com as credenciais de sua conta Snowflake e selecione Allow quando solicitado para permitir que o aplicativo de tempo de execução acesse sua conta Snowflake. O processo de instalação do conector leva alguns minutos para ser concluído.

  6. Autentique-se no tempo de execução com as credenciais de sua conta Snowflake.

A tela do Openflow é exibida com o grupo de processos do conector adicionado a ela.

Configuração do conector

  1. Clique com o botão direito do mouse no grupo de processos importado e selecione Parameters.

  2. Preencha os valores dos parâmetros necessários conforme descrito em Parâmetros de fluxo.

Parâmetros de fluxo

Esta seção descreve os parâmetros de fluxo que podem ser configurados com base nos contextos de parâmetros a seguir:

Parâmetros de origem do Jira Cloud

Parâmetro

Descrição

Método de autorização

Método de autorização para a Jira Cloud API. Valor padrão: BASIC.

E-mail do Jira

Endereço de e-mail da conta Atlassian. Visível somente quando o método de autorização for BASIC.

Token da Jira API

Token de acesso da API para sua conta Atlassian Jira. Visível somente quando o método de autorização for BASIC.

URL do ambiente

URL para o ambiente do Atlassian Jira

Parâmetros de destino do Jira Cloud

Parâmetro

Descrição

Banco de dados de destino

O banco de dados onde os dados serão mantidos. Ele já deve existir no Snowflake.

Esquema de destino

O esquema em que os dados serão mantidos. Ele já deve existir no Snowflake.

Identificador de conta Snowflake

Nome da conta Snowflake formatado como [organization-name]-[account-name] onde os dados serão mantidos

Estratégia de autenticação Snowflake

Estratégia de autenticação para o Snowflake. Valores possíveis: SNOWFLAKE_SESSION_TOKEN quando você estiver executando o fluxo em SPCS, e KEY_PAIR quando quiser definir o acesso usando uma chave privada.

Chave privada Snowflake

A chave privada RSA utilizada para autenticação. A chave RSA deve ser formatada de acordo com os padrões PKCS8 e ter cabeçalhos e rodapés no padrão PEM. Observe que o arquivo de chave privada Snowflake ou a chave privada Snowflake devem ser definidos.

Arquivo de chave privada Snowflake

O arquivo que contém a chave privada RSA usada para autenticação no Snowflake, formatado de acordo com os padrões PKCS8 e com cabeçalhos e rodapés no padrão PEM. A linha do cabeçalho começa com -----BEGIN PRIVATE. Marque a caixa de seleção Reference asset para carregar o arquivo de chave privada.

Senha de chave privada Snowflake

A senha associada ao arquivo de chave privada Snowflake

Função Snowflake

Função Snowflake usada durante a execução da consulta

Nome de usuário do Snowflake

Nome de usuário usado para se conectar à instância Snowflake

Warehouse Snowflake

Warehouse Snowflake usado para executar consultas

Parâmetros de ingestão do Jira Cloud

Parâmetro

Descrição

Tipo de pesquisa

Tipo de pesquisa a ser realizada. Ele tem um desses valores possíveis SIMPLE e JQL. Valor padrão: SIMPLE.

Consulta JQL

Uma consulta em JQL. Ele deve ser usada somente quando o tipo de busca for JQL.

Nome do projeto

Você pode pesquisar problemas pertencentes a um projeto específico por nome de projeto, chave de projeto ou ID de projeto. Ele deve ser usado somente quando o tipo de busca for SIMPLE.

Categoria de status

Filtro de categoria de status para busca simples. Ele deve ser usado somente quando o tipo de busca for SIMPLE. Os valores de exemplo são: Done, In Progress e To Do.

Atualizado após

Filtre problemas atualizados após uma data e hora especificadas. Ele deve ser usado somente quando o tipo de busca for SIMPLE. Deve estar no formato yyyy-MM-dd, como 2023-10-01.

Criado após

Filtre problemas criados após uma data e hora especificadas. Ele deve ser usado somente quando o tipo de busca for SIMPLE. Deve estar no formato yyyy-MM-dd, como 2023-10-01.

Campos de problemas

Uma lista de campos a serem retornados para cada problema, que é usada para recuperar um subconjunto de campos. Esse parâmetro aceita uma lista de itens separados por vírgulas. Valor padrão: all.

Tamanho máximo da página

O número máximo de itens a serem retornados por página. Valor padrão: 200.

Execute o fluxo

  1. Clique com o botão direito do mouse no plano e selecione Enable all Controller Services.

  2. Clique com o botão direito do mouse no grupo de processos importado e selecione Start. O conector inicia a ingestão de dados.

Se você precisar alterar os critérios de consulta de emissão ou quiser reiniciar a ingestão do zero, execute as seguintes etapas para garantir que os dados na tabela de destino sejam consistentes:

  1. Clique com o botão direito do mouse no processador FetchJiraIssues e pare-o.

  2. Clique com o botão direito do mouse no processador FetchJiraIssues e selecione View State.

  3. Na caixa de diálogo State, selecione Clear State. Essa ação limpa o estado do processador e permite que ele busque todos os problemas novamente.

  4. Opcional: se quiser alterar os critérios de consulta de problemas, clique com o botão direito do mouse no grupo de processos importado e selecione Parameters. Atualize os parâmetros conforme necessário.

  5. Opcional: se quiser alterar o nome da tabela de destino, clique com o botão direito do mouse no grupo de processos importado e selecione Parameters. Atualize o parâmetro Tabela de destino.

  6. Clique com o botão direito do mouse no processador FetchJiraIssues e selecione Start. O conector inicia a ingestão de dados.