Criar um repositório

Este documento ajuda você a entender o conceito de repositórios no Dataform e como criar um novo repositório.

Sobre os repositórios do Dataform

Cada repositório do Dataform armazena uma coleção de arquivos SQLX e JavaScript que compõem seu fluxo de trabalho, além de arquivos e pacotes de configuração do Dataform. Você interage com o conteúdo do repositório em um espaço de trabalho de desenvolvimento.

O Dataform mostra seus repositórios na página do Dataform na ordem alfabética dos IDs dos repositórios. Você pode classificá-los e filtrá-los.

• Para conferir seus repositórios, acesse a página Dataform no console do Google Cloud.

  Acessar o Dataform

Cada repositório do Dataform está conectado a uma conta de serviço. É possível selecionar uma conta de serviço ao criar um repositório ou editar a conta de serviço mais tarde.

Por padrão, o Dataform usa uma conta de serviço derivada do número do projeto no seguinte formato:

[e-mail]

O Dataform usa o Git para registrar mudanças e gerenciar versões de arquivos. Cada repositório do Dataform corresponde a um repositório Git. Depois de criar um repositório do Dataform, você pode conectá-lo a um repositório remoto do GitHub, do GitLab ou do Bitbucket.

Em um repositório do Dataform, o Dataform armazena o código do repositório. Em um repositório conectado, o repositório de terceiros armazena o código do repositório. O Dataform interage com o repositório de terceiros para permitir que você edite e execute o conteúdo em um espaço de trabalho de desenvolvimento do Dataform.

Uma página de repositório do Dataform consiste nos seguintes componentes:

Guia "Espaços de trabalho de desenvolvimento"

Exibe os espaços de trabalho de desenvolvimento criados no repositório.

Guia "Configurações de lançamento"

Permite inspecionar, criar, editar e excluir versões.

Guia "Registros de execução do fluxo de trabalho"

Exibe os registros de execução do fluxo de trabalho do Dataform.

Guia "Configurações do fluxo de trabalho"

Permite inspecionar, criar, editar e excluir configurações de fluxo de trabalho.

Guia "Configurações"

Mostra o nome e o local do repositório. Para um repositório conectado a um repositório Git de terceiros, mostra a origem do repositório de terceiros, o nome da ramificação padrão e o token secreto. Mostra os botões para conectar o repositório a um repositório Git de terceiros e para editar a conexão do Git.

Botão "Criar espaço de trabalho de desenvolvimento"

Permite criar um espaço de trabalho de desenvolvimento.

Depois de criar e inicializar um espaço de trabalho de desenvolvimento, é possível editar o arquivo de configurações do fluxo de trabalho para definir as seguintes configurações do Dataform no repositório:

• O banco de dados padrão (ID do projetoGoogle Cloud ).
• O esquema padrão (ID do conjunto de dados do BigQuery).
• O local padrão do BigQuery.
• O esquema padrão (ID do conjunto de dados do BigQuery) para declarações.
• O depósito, que precisa ser definido como bigquery.
• Variáveis definidas pelo usuário que são disponibilizadas para o código do projeto durante a compilação.

Para mais informações sobre as configurações do repositório do Dataform, consulte IProjectConfig na referência do núcleo do Dataform.

Configurações do repositório

Ao criar um repositório do Dataform, você precisa definir as seguintes configurações:

ID do repositório

Um ID exclusivo do repositório. Os IDs podem incluir apenas números, letras, hifens e sublinhados.

Região

Região do Dataform para armazenar o repositório e o conteúdo dele.

Essa região de armazenamento pode ser diferente da região de processamento em que o Dataform processa seu código e armazena a saída das execuções. Por padrão, a região de processamento é definida como a região padrão do conjunto de dados do BigQuery. É possível editar a região de processamento no arquivo de configurações do fluxo de trabalho depois de criar o repositório. Para mais informações, consulte Configurar as configurações do Dataform.

Conta de serviço

Conta de serviço associada ao repositório. Você pode selecionar a conta de serviço padrão do Dataform, uma conta de serviço associada ao seu projeto do Google Cloud ou inserir manualmente uma conta de serviço diferente. Por padrão, o Dataform usa uma conta de serviço derivada do número do projeto no seguinte formato:

[e-mail]

O Dataform usa a conta de serviço padrão para todas as operações do repositório. É possível usar uma conta de serviço diferente para executar fluxos de trabalho no repositório, mas a conta de serviço padrão ainda é usada para todas as outras operações do repositório.

Criptografia

Método de criptografia do repositório. É possível usar a criptografia padrão, uma chave de criptografia do Cloud KMS gerenciada pelo cliente ou uma chave de CMEK padrão do Dataform. Para mais informações sobre o uso de chaves de criptografia gerenciadas pelo cliente (CMEK) no Dataform, consulte Usar chaves de criptografia gerenciadas pelo cliente.

Depois de criar um repositório, você pode conectar o repositório ao GitHub ou ao GitLab.

Importante: para criar um repositório do Dataform conectado a um repositório Git remoto que não está na lista de permissões da política dataform.restrictGitRemotes, adicione o repositório Git remoto à lista allowedValues na política e crie um novo repositório do Dataform para conectá-lo ao repositório remoto. Para mais informações, consulte Restringir repositórios remotos.

Antes de começar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the BigQuery and Dataform APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the BigQuery and Dataform APIs.

   Enable the APIs

8. Para usar a criptografia CMEK no repositório, ative a criptografia CMEK dos repositórios do Dataform.

Importante: antes de criar um repositório do Dataform que você quer conectar a um repositório Git remoto, verifique se a organização ou o projeto restringe repositórios Git remotos com a política da organização dataform.restrictGitRemotes. Se a política estiver em vigor, verifique se o repositório remoto está na lista de permissões antes de criar o repositório do Dataform e conectá-lo ao repositório remoto. Para mais informações, consulte Restringir repositórios remotos

.

Funções exigidas

Para receber as permissões necessárias para criar e excluir um repositório, peça ao administrador que conceda a você o Administrador do Dataform (roles/dataform.admin) no IAM dos repositórios. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.

Para usar uma conta de serviço que não seja a conta de serviço padrão do Dataform, conceda acesso à conta de serviço personalizada.

Observação: uma conta de serviço personalizada associada a um repositório do Dataform é usada apenas para executar os fluxos de trabalho desse repositório. Todas as outras operações do repositório ainda são realizadas pela conta de serviço padrão do Dataform.

Depois que você cria um repositório do Dataform, ele concede automaticamente a função de administrador do Dataform nesse repositório.

Criar um repositório

Para criar um repositório do Dataform, siga estas etapas:

1. No Console do Google Cloud, acesse a página Dataform.

   Acessar o Dataform

2. Clique em Criar repositório.

3. Na página Criar repositório, no campo ID do repositório, insira um ID exclusivo.

   Os IDs só podem incluir números, letras, hifens e sublinhados.

4. Na lista suspensa Região, selecione uma região do Dataform para armazenar o repositório e o conteúdo dele. Selecione a região do Dataform mais próxima de você.

   Para conferir uma lista de regiões disponíveis do Dataform, consulte Locais. A região do repositório não precisa corresponder ao local dos conjuntos de dados do BigQuery.

   No arquivo workflow_settings.yaml, é possível definir a região de processamento em que o Dataform processa seu código e armazena a saída das execuções. A região de processamento precisa corresponder ao local dos conjuntos de dados do BigQuery, mas não precisa corresponder à região do repositório. Para mais informações, consulte Configurar as configurações do Dataform.

5. No menu suspenso Conta de serviço, selecione uma conta de serviço para o repositório.

   No menu suspenso, você pode selecionar a conta de serviço padrão do Dataform ou qualquer conta de serviço associada ao seu projeto do Google Cloud a que você tem acesso. As contas de serviço personalizadas são usadas apenas para a execução do fluxo de trabalho. Todas as outras operações do repositório ainda são realizadas pela conta de serviço padrão do Dataform.

   1. Opcional: para selecionar uma conta de serviço que não aparece no menu suspenso, clique em Entrar manualmente e insira um ID da conta de serviço.

6. Configure o mecanismo de criptografia selecionado para o repositório:

   Atenção: não é possível mudar o mecanismo de criptografia de um repositório do Dataform depois que ele é criado. Para mais informações, consulte Restrições de CMEK do Dataform
   .

   Chave CMEK padrão

   O Dataform mostra a caixa de seleção Use the default KMS key e a seleciona por padrão.

   • Para criptografar o repositório com a chave CMEK padrão do Dataform, selecione a caixa de seleção Usar a chave KMS padrão.

   Atenção: se você selecionar a caixa de seleção Usar a chave KMS padrão, mas nenhuma chave de CMEK do Dataform padrão for definida para seu projeto, o Dataform aplicará a criptografia em repouso ao repositório. Usar chaves de criptografia gerenciadas pelo cliente.

   Chave CMEK exclusiva

   Para criptografar o repositório com uma chave CMEK exclusiva, faça o seguinte:

   1. Se a caixa de seleção Usar a chave padrão do KMS estiver marcada por padrão, desmarque a caixa de seleção.
   2. Na seção Criptografia, selecione a opção Chaves de criptografia gerenciadas pelo cliente (CMEK).
   3. No menu suspenso Selecionar uma chave gerenciada pelo cliente, selecione uma chave CMEK exclusiva.

   Criptografia em repouso

   • Para usar a criptografia padrão, na seção Criptografia, selecione a opção Google-managed encryption key.

   Atenção: se uma chave de CMEK padrão do Dataform estiver definida para a região do repositório, será necessário usar a criptografia de CMEK. Não selecione a opção Google-managed encryption key. Para mais informações, consulte Restrições de CMEK do Dataform.

7. Clique em Criar e em Concluído.

Editar a conta de serviço

É possível associar uma conta de serviço personalizada a um repositório do Dataform para a execução do fluxo de trabalho. Todas as outras operações do repositório ainda são realizadas pela conta de serviço padrão do Dataform.

Para editar a conta de serviço de um repositório do Dataform, siga estas etapas:

1. No Console do Google Cloud, acesse a página Dataform.

   Acessar o Dataform

2. Selecione um repositório e clique em Configurações.

3. No campo Conta de serviço, clique em Editar conta de serviço.

4. No menu suspenso Conta de serviço, selecione uma conta de serviço para o repositório.

   No menu suspenso, você pode selecionar a conta de serviço padrão do Dataform ou qualquer conta de serviço associada ao seu projeto do Google Cloud a que você tem acesso.

   1. Opcional: para selecionar uma conta de serviço que não aparece no menu suspenso, clique em Entrar manualmente e insira um ID da conta de serviço.

5. Clique em Salvar.

Excluir um repositório.

Para excluir um repositório e todo o conteúdo dele, siga estas etapas:

1. No Console do Google Cloud, acesse a página Dataform.

   Acessar o Dataform

2. No repositório que você quer excluir, clique no menu Mais e selecione Excluir.

3. Na janela Excluir repositório, insira o nome do repositório para confirmar a exclusão.

4. Clique em Excluir.

A seguir

• Para saber como conectar um repositório do Dataform a um repositório Git de terceiros, consulte Conectar a um repositório Git de terceiros.
• Para saber mais sobre como o tamanho do repositório afeta o desenvolvimento no Dataform, consulte Visão geral do tamanho do repositório.
• Para saber mais sobre como dividir um repositório no Dataform, consulte Introdução à divisão de repositórios.
• Para saber como definir as configurações de processamento do Dataform, consulte Definir as configurações do Dataform.
• Para saber como criar e inicializar um espaço de trabalho, consulte Criar um espaço de trabalho.