rsync é um utilitário popular de sincronização de arquivos que usa um algoritmo eficiente para minimizar o consumo de largura de banda. Uma das funções comuns do rsync é implantar um site construído em um servidor de produção remoto. Veja como combinar a versatilidade do rsync com a automação fornecida pelos pipelines GitLab CI.
Executores de pipeline
GitLab CI oferece suporte a vários tipos de executores de pipeline. Eles definem o ambiente em que seu trabalho será executado. shell executor é o padrão e executa bare metal na máquina host. Ele permite que seus pipelines usem qualquer comando disponível no host sem configuração adicional. Como a maioria das distribuições populares do Linux vem com o rsync instalado, essa abordagem é fácil de usar.
Infelizmente, o shell o executor não fornece isolamento forte e pode poluir o ambiente do seu host com o tempo. Uma alternativa melhor é o docker executor, que ativa um novo contêiner do Docker para cada trabalho de CI. Todos os trabalhos são executados em um ambiente limpo que não pode afetar o host.
A desvantagem aqui é que as imagens base do Docker geralmente não incluem rsync ou ssh. Mesmo imagens oficiais do sistema operacional, como ubuntu:latest são enviados como compilações mínimas sem esses comandos. Isso torna um script de pipeline um pouco mais envolvido para adicionar as dependências e rsync seus arquivos.
Veja como adicionar rsync ao seu pipeline. Certifique-se de ter um GitLab Runner baseado em Docker disponível antes de continuar. Também presumiremos que você tenha um projeto GitLab pronto para uso.
Preparando-se
Você precisará de um par de chaves SSH disponível se for usar rsync para se conectar a um host SSH remoto. Você pode gerar chaves públicas e privadas executando ssh-keygen -t rsa. Copie a chave pública para o servidor ao qual você se conectará.
Em seguida, copie a chave privada gerada para sua área de transferência:
cat ~/.ssh/id_rsa | xclip -selection c
Vá para o seu projeto GitLab e clique em “Configurações” na parte inferior do menu de navegação à esquerda. Clique no item “CI / CD” no submenu. Role para baixo até a seção "Variáveis" na página resultante.

Clique no botão azul “Adicionar variável”. Dê um nome à sua nova variável no campo “Chave”. Estamos usando SSH_PRIVATE_KEY. Cole sua chave privada no campo “Valor”, incluindo o principal ----BEGIN e arrastando -----END linhas.

Adicionar a chave como uma variável CI permite referenciá-la em seu pipeline posteriormente. Ele será adicionado ao agente SSH nos contêineres que seu pipeline cria.
Adicionando seu arquivo de pipeline
GitLab CI executa trabalhos com base no conteúdo de um .gitlab-ci.yml arquivo em seu repositório. O GitLab encontrará automaticamente esse arquivo e executará o pipeline que ele define quando você envia alterações para seus branches.
deploy: stage: deploy image: alpine:latest script: - rsync -atv --delete --progress ./ user@example.com:/var/www/html
este .gitlab-ci.yml contém um trabalho que usa rsync para sincronizar o conteúdo do diretório de trabalho para /var/www/html no example.com servidor. Usa o alpine:latest Imagem Docker como o ambiente de construção. O pipeline irá falhar atualmente porque rsync não está incluído na imagem Alpine.
Instalando SSH e rsync
Alpine é uma boa base para o trabalho porque é uma imagem leve com poucas dependências. Isso reduz o uso da rede enquanto o GitLab extrai a imagem no início do trabalho, acelerando o pipeline. Para fazer o rsync funcionar, adicione SSH e rsync à imagem e, em seguida, inicie o agente SSH e registre a chave privada que você gerou anteriormente.
deploy: stage: deploy image: alpine:latest before_script: - apk update && apk add openssh-client rsync - eval $(ssh-agent -s) - echo "$SSH_PRIVATE_KEY" | ssh-add - script: - rsync -atv --delete --progress ./ user@example.com:/var/www/html
OpenSSH e rsync são instalados usando o da Alpine apk gerenciador de pacotes. O agente de autenticação SSH é iniciado e sua chave privada é adicionada via ssh-add. GitLab injeta automaticamente o SSH_PRIVATE_KEY variável de ambiente com o valor que você definiu nas configurações do seu projeto. Se você usou uma chave diferente na tela de variáveis do GitLab, certifique-se de ajustar seu pipeline de acordo.
Gerenciando a verificação de host
O SSH solicita interativamente a confirmação na primeira vez que você se conecta a um novo host remoto. Isso é incompatível com o ambiente de CI, onde você não poderá ver ou responder a esses prompts.
Duas opções estão disponíveis para resolver isso: Desative verificações estritas de chave de host ou registre seu servidor como um host “conhecido” com antecedência.
Para a primeira opção, adicione a seguinte linha ao seu pipeline before_script:
- echo "Host *ntStrictHostKeyChecking no" >> ~/.ssh/configEmbora isso funcione, é um risco potencial de segurança. Você não teria nenhum aviso se um invasor obtivesse o controle do domínio ou IP do seu servidor. O uso da verificação de chave de host permite que você verifique se a identidade do controle remoto é o que você espera que seja.
Você pode adicionar o remoto como um host conhecido de forma não interativa, conectando-se a ele em sua própria máquina fora do pipeline. Inspecione seu ~/.ssh/known_hosts arquivo e encontre a linha que contém o IP ou nome de host do controle remoto. Copie esta linha e use o procedimento anterior para adicionar uma nova variável GitLab CI. Nomeie esta variável SSH_HOST_KEY.
Agora, atualize seu before_script seção com a seguinte linha:
- echo "$SSH_HOST_KEY" > ~/.ssh/known_hostsAgora, você poderá se conectar ao servidor sem receber nenhum prompt de confirmação. Envie seu código para o repositório GitLab e observe enquanto o pipeline é concluído.
Outras melhorias
Este pipeline é um exemplo simples de como começar a usar SSH e rsync em um ambiente Dockerizado. Existem oportunidades para melhorar ainda mais o sistema, envolvendo as etapas de preparação em um estágio de construção dedicado que constrói uma imagem Docker que você pode reutilizar entre os pipelines.
O .gitlab-ci.yml também se beneficiaria de um maior uso de variáveis. Abstraindo o nome do host do servidor remoto (example.com), diretório (/var/www/html) e usuário (user) em variáveis CI do GitLab ajudaria a manter o arquivo limpo, evitaria que navegadores casuais do repositório vissem detalhes ambientais e permitiria que você alterasse os valores de configuração sem editar seu arquivo de pipeline.
Resumo
Usar rsync em pipelines GitLab CI requer uma pequena configuração manual para formar um ambiente de construção que tenha as dependências de que você precisa. Você deve injetar manualmente uma chave privada SSH e registrar o servidor remoto como um host conhecido.
Embora as imagens do Docker da comunidade estejam disponíveis para rodar SSH e rsync sobre imagens de base populares, elas oferecem menos controle sobre sua construção. Você está estendendo a cadeia de suprimentos do seu pipeline com uma imagem na qual não pode necessariamente confiar. Começar com uma imagem de base do sistema operacional e adicionar o que você precisa ajuda a ter confiança em suas compilações.



