Servidor Couchbase

Como clonar clusters do Couchbase para ambientes efêmeros sob demanda de CI/CD

A integração contínua e a implantação contínua são agora práticas comuns de desenvolvimento de software. No mundo dos bancos de dados, isso se traduz na necessidade de ambientes sob demanda, com estado e efêmeros.  

O provisionamento de um ambiente sem estado não está vinculado a nenhuma fonte de dados específica. Tudo o que é necessário é executar o código que você deseja testar em seu ambiente de CI. Essa é a base da maioria das ferramentas de CI/CD e não será abordada neste artigo. 

A parte um pouco mais difícil vem das dependências que o aplicativo precisa para ser testado adequadamente, o que geralmente é chamado de serviços externos. O Couchbase é um deles. Há diferentes maneiras de obtê-los, por meio de contêineres do Docker, por exemplo, ou hospedados em sua infraestrutura de teste, ou em alguma solução externa como serviço. Isso não importa, desde que eles estejam disponíveis durante a execução do teste. As boas práticas seriam usar as variáveis de ambiente para se referir a essas instâncias. 

Supondo que esses serviços estejam em execução, como uma instância do Couchbase Free Tier ou um contêiner do Docker, a próxima etapa é verificar se eles estão configurados corretamente e semeados com os dados necessários para o teste.

Há algum tempo, postei sobre o uso do Shell do Couchbase em ações do GitHub. Isso lhe dirá o básico sobre o uso do Couchbase Shell com o GitHub Actions, mas também pode ser aplicado à maioria das soluções de CI/CD. Hoje, quero ir além e mostrar alguns scripts úteis para clonar um cluster ou elementos de um cluster para seus ambientes sob demanda.

Usando o Couchbase Shell para clonar ambientes

Ao usar o Couchbase Shell, a primeira coisa que vem à mente quando se quer fazer algo é: existe uma função para isso? Até o momento, não temos uma função para clonar algo. A maioria das funções disponíveis reflete os recursos de nossas APIs e, atualmente, não temos APIs de clonagem. No entanto, temos a capacidade de escrever scripts, o que significa que podemos criar nossos próprios scripts!

A primeira coisa que vem à mente ao gerenciar bancos de dados geralmente é recriar a estrutura e os esquemas. Como o Couchbase não tem esquema, isso consistirá apenas nos buckets, escopos, coleções e índices existentes no cluster de origem. A primeira etapa é exportar essa estrutura para que ela possa ser reimportada posteriormente. Essa função listará todos os buckets, depois os escopos internos e as coleções, e os adicionará a uma matriz. Em seguida, listará todos os índices e os adicionará ao JSON de saída. 

Isso funciona porque, nos bastidores, o Couchbase Shell está usando o Nushell, um novo tipo de shell que é portátil (o que significa que funciona da mesma forma no Linux, Windows ou OS X, o que é ótimo para scripts de CI/CD que precisam oferecer suporte a diferentes sistemas operacionais) e que considera qualquer estrutura de dados como um DataFrame, tornando a manipulação do JSON extremamente fácil.

Para experimentá-lo, execute cbshe, em seguida, o arquivo que contém a função. Para mim, é ci_scripts.nu. Eu tenho um cluster já configurado em minha configuração cbsh, chamado local

Agora, se você abrir o local-cluster-export.jsonvocê obterá a estrutura do seu cluster:

Excluí esse bucket para fins deste teste, para reimportá-lo mais tarde: baldes drop travel-sample.

A próxima etapa lógica é ter uma função que receba esse arquivo como entrada e recrie a estrutura completa em outro cluster:

Agora vamos executar essa função:

E aí está, funções que permitem exportar e importar a estrutura de dados de um cluster para outro. Embora esse seja um bom ponto de partida, ainda há dúvidas sobre como reimportar dados ou sobre a granularidade. Além disso, talvez você não queira exportar e importar um cluster completo.

Filtrar os compartimentos a serem importados é bastante fácil, pois o Nushell permite que você filtre os quadros de dados:

Isso recriará um objeto JSON contendo apenas um bucket chamado amostra de viagem e índices para esse bucket.

A partir daí, você deve estar pronto para gerenciar a estrutura básica do cluster. E quanto aos dados? Há várias maneiras de importar dados com o cbsh, pois ele abrange a maioria das operações de chave/valor, bem como qualquer consulta INSERT/UPSERT. E então temos o importação de documentos comando. Seu uso é bastante simples, tudo o que você precisa é de uma lista de linhas com um campo id identificado. Isso pode ser qualquer coisa que possa ser transformada em um dataframe para o Nushell (XML, CSV, TSV, Parquet e outros). E, é claro, pode ser um arquivo JSON de uma consulta SQL++ do Couchbase. Este é um exemplo que salvará o resultado de uma consulta em um arquivo e importará esse arquivo de volta para uma coleção: 


Esse é um exemplo específico, mas o objetivo principal do uso da linguagem de script é torná-la sua. Você encontrará um exemplo mais completo em este Gist do GitHub. Ele oferece suporte a variáveis de ambiente para origem e destino e você pode decidir clonar todos os buckets de um cluster, um bucket, escopo ou coleção específicos.

Não hesite em nos enviar um comentário aqui ou em Discórdia, Estamos sempre buscando sugestões para melhorar a experiência global do Couchbase.

Compartilhe este artigo
Receba atualizações do blog do Couchbase em sua caixa de entrada
Esse campo é obrigatório.

Author

Posted by Laurent Doguin

Laurent é um nerd metaleiro que mora em Paris. Em sua maior parte, ele escreve código em Java e texto estruturado em AsciiDoc, e frequentemente fala sobre dados, programação reativa e outras coisas que estão na moda. Ele também foi Developer Advocate do Clever Cloud e do Nuxeo, onde dedicou seu tempo e experiência para ajudar essas comunidades a crescerem e se fortalecerem. Atualmente, ele dirige as Relações com Desenvolvedores na Couchbase.

Deixe um comentário

Pronto para começar a usar o Couchbase Capella?

Iniciar a construção

Confira nosso portal do desenvolvedor para explorar o NoSQL, procurar recursos e começar a usar os tutoriais.

Use o Capella gratuitamente

Comece a trabalhar com o Couchbase em apenas alguns cliques. O Capella DBaaS é a maneira mais fácil e rápida de começar.

Entre em contato

Deseja saber mais sobre as ofertas do Couchbase? Deixe-nos ajudar.