Come utilizzare Rsync e SSH in una pipeline CI GitLab dockerizzata

rsync è una popolare utility di sincronizzazione dei file che utilizza un algoritmo efficiente per ridurre al minimo il consumo di larghezza di banda. Uno dei ruoli comuni di rsync è la distribuzione di una build di un sito Web su un server di produzione remoto. Ecco come combinare la versatilità di rsync con l'automazione fornita dalle pipeline GitLab CI.

Esecutori della pipeline

GitLab CI supporta diversi tipi di esecutori di pipeline. Questi definiscono l'ambiente in cui verrà eseguito il lavoro. L'esecutore shell è l'impostazione predefinita ed esegue bare metal sulla macchina host. Consente alle tue pipeline di utilizzare qualsiasi comando disponibile sull'host senza ulteriore configurazione. Poiché le distribuzioni Linux più popolari vengono fornite con rsync installato, questo approccio è facile da gestire.

Sfortunatamente, l'esecutore shell non fornisce un forte isolamento e può inquinare l'ambiente del tuo host nel tempo. Un'alternativa migliore è l'esecutore docker, che crea un nuovo contenitore Docker per ogni processo CI. Tutti i lavori vengono eseguiti in un ambiente pulito che non può influire sull'host.

Lo svantaggio qui è che le immagini di base di Docker generalmente non includono rsync o ssh. Anche le immagini ufficiali del sistema operativo come ubuntu:latest vengono fornite come build minime senza questi comandi. Ciò rende uno script della pipeline leggermente più complesso per aggiungere le dipendenze e rsync i tuoi file.

Ecco come aggiungere rsync alla tua pipeline. Assicurati di avere a disposizione un GitLab Runner basato su Docker prima di continuare. Supponiamo anche che tu abbia un progetto GitLab pronto per l'uso.

Prepararsi

Avrai bisogno di una coppia di chiavi SSH disponibile se utilizzerai rsync per connetterti a un host SSH remoto. Puoi generare chiavi pubbliche e private eseguendo ssh-keygen -t rsa. Copia la chiave pubblica sul server a cui ti connetterai.

Successivamente, copia la chiave privata generata negli appunti:

cat ~/.ssh/id_rsa | xclip -selection c

Vai al tuo progetto GitLab e fai clic su Impostazioni nella parte inferiore del menu di navigazione a sinistra. Fare clic sulla voce CI/CD nel sottomenu. Scorri verso il basso fino alla sezione Variabili nella pagina risultante.

Fare clic sul pulsante blu Aggiungi variabile. Assegna un nome alla nuova variabile nel campo Chiave. Stiamo usando SSH_PRIVATE_KEY. Incolla la tua chiave privata nel campo Valore, comprese le righe iniziali ----BEGIN e finali -----END.

L'aggiunta della chiave come variabile CI consente di farvi riferimento nella pipeline in un secondo momento. Verrà aggiunto all'agente SSH nei contenitori creati dalla pipeline.

Aggiunta del file della pipeline

GitLab CI esegue lavori basati sui contenuti di un file .gitlab-ci.yml nel tuo repository. GitLab troverà automaticamente questo file ed eseguirà la pipeline che definisce quando invii le modifiche ai tuoi rami.

class="co4">deploy:class="co3">
  stageclass="sy2">: deployclass="co3">
  imageclass="sy2">: alpine:latestclass="co4">
  scriptclass="sy2">:
    - rsync -atv --delete --progress ./ user@example.com:/var/www/html

class="co4">deploy:class="co3">
  stageclass="sy2">: deployclass="co3">
  imageclass="sy2">: alpine:latestclass="co4">
  before_scriptclass="sy2">:
    - apk update && apk add openssh-client rsync
    - eval $class="br0">(ssh-agent -sclass="br0">)
    - echo class="st0">"$SSH_PRIVATE_KEY" | ssh-add -class="co4">
  scriptclass="sy2">:
    - rsync -atv --delete --progress ./ user@example.com:/var/www/html

- echo class="st0">"Host *ntStrictHostKeyChecking no" >> ~/.ssh/config

- echo class="st0">"$SSH_HOST_KEY" > ~/.ssh/known_hosts