jessicafuung / terraform-app-runner

Infrastruktur som kode med Terraform og AWS App runner

Når du er ferdig med denne oppgaven vil du ha et repository som inneholder en Spring Boot applikasjon. Når du gjør en commit på main branch så vil GitHub actions lage et Docker Image, og gjøre en push til ECR.

I tillegg vil En annen GitHub actions job sørge for å lage AWS infrastruktur, IAM roller og en AWS App Runner Service.

• I denne oppgaven skal vi gjøre en en docker container tilgjengelig over internett ved hjelp av tjeneste AWS Apprunner
• Apprunner lager nødvendig infrastruktur for containeren, og du som utvikler kan fokusere på koden.

Vi skal også se nærmere på mer avansert GitHub Actions

• Mer avansert Github actions. For eksempel; Flere jobber og avhengigheter mellom jobber
• Eksempel; En workflow med to jobber - en jobb vil lage infrastruktur med terraform, den andre bygge Docker container image
• Mer avansert Github actions - Bruke funksjonen github.issues.createComment for å legge på kommentar på Pull requests
• Bruke terraform i Pipeline - GitHub actions skal kjøre Terraform.
• Lære mer om AWS IAM og Roller

Lag en fork

Du må start emd å lage en fork av dette repositoryet til din egen GitHub konto.

Logg i Cloud 9 miljøet ditt

• Logg på med din AWS bruker med URL, brukernavn og passord gitt i klassrommet
• Gå til tjenesten Cloud9 (Du nå søke på Cloud9 uten mellomrom i søket)
• Velg "Open IDE"
• Hvis du ikke ser ditt miljø, kan det hende du har valgt feil region. Hvilken region du skal bruke vil bli oppgitt i klasserommet.

Lag et Access Token for GitHub

• Når du skal autentisere deg mot din GitHub konto fra Cloud 9 trenger du et access token. Gå til https://github.com/settings/tokens og lag et nytt.
• NB. Ta vare på tokenet et sted, du trenger dette senere når du skal gjøre git push

Access token må ha "repo" tillatelser, og "workflow" tillatelser.

Lage en klone av din Fork (av dette repoet) inn i ditt Cloud 9 miljø

Fra Terminal i Cloud 9. Klone repositoriet ditt med HTTPS URL.

git clone https://github.com/≤github bruker>/terraform-app-runner.git

Får du denne feilmeldingen bash: /terraform-app-runner: Permission denied - så glemte du å bytte ut med ditt eget Github brukernavn :-)

OBS Når du gjør git push senere og du skal autentisere deg, skal du bruke GitHub Access token når du blir bedt om passord, så du trenger å ta vare på dette et sted.

For å slippe å autentisere seg hele tiden kan man få git til å cache nøkler i et valgfritt antall sekunder på denne måten;

git config --global credential.helper "cache --timeout=86400"

Konfigurer også brukernavnet og e-posten din for GitHub CLI. Da slipepr du advarsler i terminalen når du gjør commit senere.

git config --global user.name <github brukernavn>
git config --global user.email <email for github bruker>

Slå på GitHub actions for din fork

I din fork av dette repositoriet, velg "actions" for å slå på støtte for GitHub actions i din fork.

Sett Repository hemmeligheer

• Lag AWS IAM Access Keys for din bruker.
• Vi sette hemmeligheter på denne måten slik at terraform har tilgang til AWS nøkler, og har de rettighetene som er nødvendig.

    env:
      AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
      AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
      AWS_REGION: eu-west-1

Se over Pipeline.yaml

Det er par nye nyttige elementer i pipelinen.

Her ser vi et steg i en pipeline med en if - som bare skjer dersom det er en pull request som bygges, vi ser også at pipeline får lov til å fortsette dersom dette steget feiler.

      - name: Terraform Plan
        id: plan
        if: github.event_name == 'pull_request'
        run: terraform plan -no-color
        continue-on-error: true

Når noen gjør en Git push til main branch, kjører vi terraform apply med ett flag --auto-approve som gjør at terraform ikke spør om lov før den kjører.

      - name: Terraform Apply
        if: github.ref == 'refs/heads/main' && github.event_name == 'push'
        run: terraform apply -auto-approve

Terraform trenger docker container som lages i en egen jobb. Vi kan da bruke needs for å lage en avhengighet mellom en eller flere jobber;

  terraform:
    needs: build_docker_image

Endre provider.tf

Provider.tf filen inneholder konfigurasjon for terraform, blant annet informasjon om hvor Terraform kan finne en state fil Endre key, til ditt eget studentnavn

backend "s3" {
    bucket = "pgr301-2021-terraform-state"
    key    = "<key>/apprunner.state"
    region = "eu-north-1"
}

Finn ditt eget ECR repository

• Det er laget et ECR repositor til hver student som en del av labmiljøet
• Dette heter studentnavn-private
• Gå til tjenesten ECR og sjekk at dette finnes

Gjør nødvendig endringer i pipeline.yml

Som dere ser er "glenn" hardkodet ganske mange steder, bruk ditt eget ECR repository. NB. Pass på å både push en container med git revisjons id'en, men også en latest tag.

          docker build . -t hello
          docker tag hello 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:$rev
          docker tag hello 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:latest
          docker push 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:$rev
          docker push 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:latest

Endre terraform apply linjen

Finn denne linjen, du må endre prefix til å være ditt studentnavn, du må også legge inn studentnavn i image variabelen for å fortelle app runner hvilket container som skal deployes.

 run: terraform apply -var="prefix=<studentnavn>" -var="image=244530008913.dkr.ecr.eu-west-1.amazonaws.com/<studentnavn>-private:latest" -auto-approve

Test

• Kjør byggejobben manuelt førte gang gang. Det vil det lages en docker container som pushes til ECR repository. App runner vil lage en service
• Sjekk at det er dukket opp to container images i ECR. En med en tag som matcher git commit, og en som heter latest.