Skip to content

Latest commit

 

History

History
139 lines (102 loc) · 7.69 KB

README.md

File metadata and controls

139 lines (102 loc) · 7.69 KB

Lokalt oppsett

Standard NAV-oppsett og Oppsett for foreldrepenger trenger du bare gjøre en gang.

Standard NAV-oppsett

  1. Installer følgende:

    • Docker Desktop, Note: Docker Desktop har maksimum 2 GiB minne som standard. Gå inn i innstillinger og endre dette til minst 8 GiB (gitt at du har minst 16GB minne på maskinen).
    • JDK21,
    • Maven.

    Alternativ installasjon for Mac:

      brew install --cask docker temurin21
  brew install maven

  2. Sett opp SSH-nøkkel for Git.

  3. Sett opp GPG-nøkkel for Git.

  4. Sett opp "Personal access tokens" for din Github-bruker som skal brukes for Maven og Docker.

  5. Sett opp Mavens "settings.xml" for tilgang mot NAVs repositories.

  6. Sett opp tilgang til Google Cloud Artifact Repository(GCAR). Note: De fleste docker imagene til team foreldrepenger finnes her:

    1. Du må ha gcloud installert

    2. Logg inn i gcloud. Denne kommandoen må gjøres hver dag.

      gcloud auth login

    3. Legg inn repo i credentials helper

      gcloud auth configure-docker europe-north1-docker.pkg.dev

    4. Hent tokenet og logge inn i docker:

    gcloud auth print-access-token \
| docker login \
-u oauth2accesstoken \
--password-stdin https://europe-north1-docker.pkg.dev

  7. Sett opp tilgang til Github Container Registry(GHCR) med access tokenet du opprettet i steg 4. Note: Docker imagene som er lokalisert i GHCR finnes her.

    echo <personal access token> | docker login ghcr.io --username <ditt GitHub-brukernavn> --password-stdin

Oppsett for foreldrepenger

  1. Gå til katalogen der du vil ha kodeprosjektene dine og kjør git clone [email protected]:navikt/fp-autotest.git
  2. Kjør cd fp-autotest
  3. Kjør resources/keystore/make-dummy-keystore.sh
  4. Legg til følgende i hosts-filen (på Mac/Linux: /etc/hosts, på Windows: C:\Windows\System32\drivers\etc\hosts): 
    127.0.0.1  fptilbake fpoppdrag fpformidling fprisk fpabonennt fpfrontend fpsak fpabakus vtp oracle postgres

Kjøring av fp-autotest via Docker Compose

Docker Compose brukes til å sette opp verdikjeden for testing lokalt, i pipeline (GA), og utvikling lokalt.

  • Ønsker du å bruke Docker Compose for lokal utvikling se i avsnittet "Docker Compose for lokal utvikling". Dette passer for deg som ønsker å kjøre en eller flere av applikasjonene utenfor i en IDE for å kunne debugge. Ønsker du å se på eksempler på hvordan dette kan gjøres se: lokal utvikling eksempler.

  • Ønsker du å bruk docker compose til å kjøre gjennom tester se i avsnittet "Docker Compose for utvikling av tester". Dette passer for deg som vil utvikler ny tester eller teste funksjonelt NB. dette kjører opp hele verdikjeden og passer ikke for de som har en PC som er dårlig speccet (dvs. du trenger 12GB RAM eller mer på datamaskinen).

Docker Compose for lokal utvikling

I en del situasjoner ønsker man ikke å kjøre opp hele verdikjeden, men bare de applikasjonene som er nødvendige. For å bruke docker compose for lokal utvikling er det laget flere scripts – som ligger i mappen "lokal-utvikling/" – som skal gjøre dette lettere. Scriptene som finnes der, og kan brukes til lokal utvikling, er:

  1. lokal-utvikling-fpsak.sh: Brukes for lokal utvikling av FPSAK.
  2. lokal-utvikling-fpfrontend.sh: Brukes for lokal utvikling av FPFRONTEND.
  3. lokal-utvikling-ide.sh: Gir deg mulighet til å skrive inn hvilke applikasjoner du vil utvikle lokalt i IDE som argumenter.
  4. setup-lokal-utvikling.sh: Brukes for lokal utvikling hvis de over ikke skulle dekke ditt behov.

Etter at du har kjørt enten script 1, 2, 3, 4 eller 5 er det mulig å kjøre ned applikasjonene i Docker Compose med å kalle scriptet igjen med argumentet "down" – på lignende måte som en gjør i docker-compose.

Skulle script 1-3 mot formodning ikke dekke ditt behov, så kan du bruke det fjerde scriptet setup-lokal-utvikling.sh til å sette opp hva enn du måtte ønske. Dette scriptet brukes til å sette opp miljøvariablene slik at de peker ut på applikasjonene som du kjører utenfor Docker Compose. Når du kjører dette scriptet spesifiserer du hvilke applikasjoner du ønsker å kjøre utenfor docker compose (og valgfritt, om du ønsker å kjøre opp mer av verdikjeden innenfor Docker Compose):

./setup-lokal-utvikling.sh [APPLIKASJON_UTENFOR_DOCKER_COMPOSE ...]

Etter at du har kjørt scriptet vil det lages en mappen: lokal-utvikling/docker-compose-lokal; gå inn i denne mappen. Denne mappen inneholder riktig konfigurasjonen for oppsettet i Docker Compose. Som standard så hentes den siste versjon av Docker imagene til samtlige applikasjoner. Ønsker du mot formodning en annen versjon kan du gjøre dette ved å kjøre følgende kommando:

./update-versions.sh <APPLIKASJONSNAVN> <VERSION>

Deretter henter du ned Docker imagene og kjører opp de spesifiserte tjenestene ved å bruke en av alternativene under.

Alternativ 1:

docker compose pull [SERVICE ...]
docker compose up --detach  [--scale APPLIKASJON_UTENFOR_DOCKER_COMPOSE=0] [SERVICE...]

Alternativ 2:

docker compose up --quiet-pull --detach [--scale APPLIKASJON_UTENFOR_DOCKER_COMPOSE=0] [SERVICE...]
  • --quiet-pull: Henter ned Docker images som er spesifisert i [SERVICE...] med versjon fra .env-filen.
  • --detach: Referer til "detatched mode" og kjører da alt opp i bakgrunnen slik at det ikke okkuperer terminalen din.
  • [--scale APPLIKASJON_UTENFOR_DOCKER_COMPOSE=0]: Her spesifiserer du at du ikke ønsker å kjøre opp en eller flere tjenester.
  • [SERVICE...]: Det siste ordet/ordene referer til hvilke tjeneste(r) som skal kjøres (med sine respektive avhengigheter).

Forskjellen mellom de to alternativene over er at i den første får du muligheten til å hoppe over "pull" steget hvis du ikke ønsker å hente ned "en ny siste versjon" (hvis det har vært endringer på master nylig). Den tar da utgangspunkt i et image som du har lastet ned tidligere (f.eks. for noen timer eller dager siden). For det andre alternativet henter du siste versjon for hver gang du skriver inn kommandoen.

NB: Her er det viktig å kjøre opp tjenestene i riktig rekkefølge. Gyldige applikasjonsnavn er: oracle, postgres, vtp, fpabakus, fpsak, fpfrontend, fpformidling, fpoppdrag og fptilbake.

Mer informasjon og eksempler på hvordan dette gjøres kan du finne her: lokal utvikling eksempler.

Docker Compose for utvikling av tester

I prosjektet finnes det en docker-compose fil som befinner seg under resources/pipeline/compose.yml. Denne blir brukt til å kjøre opp verdikjeden i Github Action. For å kjøre opp HELE verdikjeden kan du gå til katalogen hvor docker-compose.yml filen befinner seg (resources/pipeline/) og kjøre følgende:

  1. Sette hvilke versjoner som skal kjøres opp: ./update-versions.sh
    1. Kommandoen over brukes den siste versjon av alle applikasjonene (dvs. "latest"). Ønsker du en spesifikk versjon for en spesifikk applikasjon kan du kjøre kommandoen med følgende argumenter: ./update-versions.sh <APPLIKASJONSNAVN> <VERSION>
  2. Hente ned oppdaterte Docker-images:docker compose pull
  3. Starte alle Docker-containerene: docker compose up -d