GitLab CI är en kraftfull plattform för kontinuerlig integration och kontinuerlig leverans (CI/CD) som hjälper utvecklare att automatisera bygg-, test- och distributionsprocesser för sina applikationer. En viktig funktion i GitLab CI är dess användning av cache för att lagra beroenden och andra filer mellan pipeline-körningar, vilket kan avsevärt förbättra prestanda och minska byggtiderna. Ibland kan det dock vara nödvändigt att rensa denna cache, särskilt om den innehåller föråldrad data eller orsakar problem. Denna guide förklarar hur cache fungerar i GitLab CI, varför och när du bör rensa den, samt hur du går tillväga för att rensa cache i dina pipelines.
Vad är cache i GitLab CI?
Cache i GitLab CI är en funktion som lagrar filer och beroenden mellan olika pipeline-körningar för att snabba upp processen. Genom att använda cache kan du undvika att ladda ner samma filer eller generera samma artefakter om och om igen, vilket sparar tid och resurser.
Exempel på vad som kan cachelagras inkluderar:
- Beroenden: Paket eller bibliotek som behövs för att bygga och testa din applikation.
- Byggartefakter: Kompilerade binärfiler eller andra byggresultat som kan återanvändas i senare steg i pipelinen.
- Mellanresultat: Delresultat från tidigare byggsteg som kan användas senare i pipelinen.
Genom att använda cache effektivt kan du minska pipelines körtider och förbättra prestanda. Men om cachen innehåller föråldrad eller felaktig information kan det leda till problem, och det kan bli nödvändigt att rensa den.
Varför rensa cache i GitLab CI?
Det finns flera anledningar till varför du kan behöva rensa cache i GitLab CI:
- Föråldrad eller korrupt data: Om cachen innehåller föråldrad eller korrupt information kan det orsaka problem i dina pipelines, som misslyckade byggningar eller felaktiga testresultat. Rensning av cachen kan lösa dessa problem.
- Konfigurationsändringar: När du uppdaterar din CI/CD-konfiguration eller ändrar beroenden i ditt projekt kan det vara nödvändigt att rensa cachen för att säkerställa att de nya ändringarna tillämpas korrekt.
- Prestandaproblem: Ibland kan cachen växa sig för stor eller bli ineffektiv, vilket kan leda till långsammare pipeline-körningar. Genom att rensa cachen kan du förbättra prestanda och återställa optimal körtid.
- Felsökning: Om du stöter på oväntade problem eller fel i dina pipelines, kan rensning av cachen vara ett viktigt steg i felsökningsprocessen för att eliminera eventuella problem som orsakas av cachelagrade data.
Hur man rensar cache i GitLab CI
Rensning av cache i GitLab CI kan göras på olika sätt beroende på vad du vill uppnå. Här är några vanliga metoder för att rensa cache i dina pipelines.
1. Rensa cache med cache:key och cache:policy
GitLab CI låter dig kontrollera cachen med hjälp av inställningar i .gitlab-ci.yml-filen, såsom cache:key och cache:policy.
Rensa cache genom att ändra cache:key:
- Uppdatera cache:key i .gitlab-ci.yml: Genom att ändra värdet för cache:key kan du effektivt rensa cachen, eftersom GitLab kommer att behandla den nya nyckeln som en separat cache och skapa en ny cache från början.
Exempel:
cache:
key: "new-key-${CI_COMMIT_REF_SLUG}"
paths:
- node_modules/
- .m2/repository/
Använda dynamiska nycklar: Du kan också använda dynamiska nycklar baserat på exempelvis commit-hash eller gren, vilket gör att cachen uppdateras automatiskt när en ny commit pushas.
Exempel:
cache:
key: "${CI_COMMIT_REF_SLUG}-${CI_COMMIT_SHA}"
paths:
- node_modules/
- Spara och kör pipelinen: Efter att ha uppdaterat .gitlab-ci.yml, spara filen och kör en ny pipeline. GitLab skapar nu en ny cache med den nya nyckeln, vilket effektivt rensar den gamla cachen.
Använd cache:policy för att styra cacheanvändningen:
- Ange cache:policy i .gitlab-ci.yml: Med cache:policy kan du styra när cachen ska användas eller rensas.
Exempel:
cache: key: "cache-key" policy: push paths: - node_modules/
- Välj rätt policy:
- pull: Använd befintlig cache om den finns.
- push: Uppdatera cachen med nya data.
- pull-push: Använd cachen om den finns och uppdatera den med nya data.
- Rensa cache via GitLabs webbgränssnitt
GitLab ger dig också möjlighet att rensa cachen manuellt via webbgränssnittet.
2. Steg för att rensa cache via GitLab GUI:
- Gå till ditt projekt: Logga in på GitLab och navigera till ditt projekt.
- Öppna inställningarna för pipelinen: Gå till ”Settings” -> ”CI / CD”.
- Rensa cachen: Scrolla ner till sektionen ”Pipeline triggers” eller liknande där du hittar en knapp för att rensa cachen. Klicka på ”Clear runner caches” för att rensa cachen för detta projekt.
- Bekräfta och rensa: Bekräfta att du vill rensa cachen. GitLab kommer nu att rensa cachelagrade data, och framtida pipeline-körningar kommer att skapa en ny cache.
3. Rensa cache automatiskt med before_script
Om du vill rensa cachen automatiskt i vissa pipelines kan du använda before_script i .gitlab-ci.yml.
Steg för att rensa cache automatiskt:
- Lägg till ett before_script i .gitlab-ci.yml: Du kan använda ett before_script för att ta bort cachefiler eller kataloger innan resten av pipelinen körs.
Exempel:
before_script: - rm -rf node_modules/ - rm -rf .m2/repository/
Kombinera med pipeline-logik: Du kan använda villkor i dina pipelines för att bestämma när cachen ska rensas.
Exempel:
build: script: - echo "Building..." before_script: - if [ "$CLEAR_CACHE" == "true" ]; then rm -rf node_modules/; fi
- Kör pipelinen: När pipelinen körs, kommer cachen att rensas enligt det script du angett.
4. Rensa cache med specifika GitLab Runner
I vissa fall kan det vara nödvändigt att rensa cache specifikt för en GitLab Runner, särskilt om den lokala cachen har blivit korrupt.
Steg för att rensa cache på en GitLab Runner:
- Logga in på servern där GitLab Runner körs: Anslut till den server där GitLab Runner är installerad.
- Radera cachemappen för Runner: Leta upp och radera cachemappen som används av Runnern. Detta finns vanligtvis i /home/gitlab-runner/cache/ eller en liknande katalog beroende på din installation.
Exempel:
sudo rm -rf /home/gitlab-runner/cache/*
Starta om GitLab Runner: Starta om GitLab Runner för att säkerställa att den tar i bruk en ny och ren cache.
Exempel:
sudo systemctl restart gitlab-runner
Slutsats
Att rensa cache i GitLab CI är en viktig åtgärd som kan hjälpa till att lösa problem, förbättra prestanda och säkerställa att dina pipelines fungerar korrekt. Genom att använda de metoder som beskrivs i denna guide, som att uppdatera cache-nyckeln i .gitlab-ci.yml, använda GitLabs webbgränssnitt, eller rensa cache specifikt för GitLab Runners, kan du hantera cachelagringen effektivt och hålla dina CI/CD-processer smidiga och pålitliga. Oavsett om du rensar cache manuellt eller automatiskt, är det viktigt att förstå när och hur du ska göra det för att maximera effektiviteten i dina pipelines.