Når du er ferdig med denne oppgaven, vil du ha et repository som inneholder en Spring Boot-applikasjon. Hver gang du gjør en commit til main branch, vil GitHub Actions utføre følgende:
- Bygge et Docker-image og pushe det til ECR, både med en "latest"-tag og en spesifikk tag som matcher git commit.
- Bruke Terraform til å opprette AWS-infrastruktur, inkludert IAM-roller og en AWS App Runner-tjeneste.
I denne oppgaven skal vi gjøre en Docker-container tilgjengelig på internett ved hjelp av AWS App Runner. App Runner oppretter den nødvendige infrastrukturen for containeren, slik at du som utvikler kan fokusere på koden.
Vi skal også se nærmere på mer avanserte GitHub Actions. Eksempler på dette inkluderer:
- To jobber med avhengigheter mellom dem.
- Én jobb vil opprette infrastruktur med Terraform, mens den andre vil bygge Docker-container-imaget.
- Bruke Terraform i pipeline, der GitHub Actions kjører Terraform for oss.
Før du starter må du lage en fork av dette repoet i din GitHub konto
- 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.
- 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.
Fra Terminal i Cloud 9. Klone repositoriet ditt med HTTPS URL.
git clone https://github.com/≤github bruker>/terraform-app-runner.git
PS. 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 brukernavn, og access token som passord,
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>
I din fork av dette repositoriet, velg "actions" for å slå på støtte for GitHub actions i din fork.
- Lag AWS IAM Access Keys for din bruker.
- Se på .github/workflows/pipeline.yaml - Vi gjør AWS hemmeligheter tilgjengelig for GitHub ved å legge til følgende kodeblokk i github actions workflow fila vår slik at terraform kan autentisere seg med vår identitet, og våre rettigheter.
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AWS_REGION: eu-west-1
Kopier følgende fil inn i katalogen .github/workflows/ - velg selv et passende navn
name: "Terraform"
on:
push:
branches:
- main
pull_request:
jobs:
# Builds a new container image, and pushes it on every commit to the repository
# Also pushes a tag called "latest" to track the lates commit
build_docker_image:
name: Push Docker image to ECR
runs-on: ubuntu-latest
steps:
- name: Check out the repo
uses: actions/checkout@v3
- name: Build and push Docker image
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
run: |
aws ecr get-login-password --region eu-west-1 | docker login --username AWS --password-stdin 244530008913.dkr.ecr.eu-west-1.amazonaws.com
rev=$(git rev-parse --short HEAD)
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
terraform:
name: "Terraform"
needs: build_docker_image
runs-on: ubuntu-latest
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
AWS_REGION: eu-west-1
IMAGE: 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:latest
PREFIX: glennbech3
# TF_LOG: trace
steps:
- uses: actions/checkout@v3
- name: Setup Terraform
uses: hashicorp/setup-terraform@v2
- name: Terraform Init
id: init
run: terraform init
- name: Terraform Plan
id: plan
run: terraform plan -var="prefix=$PREFIX" -var="image=$IMAGE" -no-color
continue-on-error: true
- name: Terraform Plan Status
if: steps.plan.outcome == 'failure'
run: exit 1
- name: Terraform Apply
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
run: terraform apply -var="prefix=$PREFIX" -var="image=$IMAGE" -auto-approve
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 GitHub Actions jobb. Vi kan da bruke needs
for å lage en avhengighet mellom en eller flere jobber;
terraform:
needs: build_docker_image
- Det er laget et ECR repository til hver student som en del av labmiljøet
- Dette heter studentnavn-private
- Gå til tjenesten ECR og sjekk at dette finnes
Som dere ser er "glenn" hardkodet ganske mange steder, bruk ditt eget ECR repository.
- Oppgave: Endre kodeblokken under slik at den også pusher en "latest" tag.
docker build . -t hello
docker tag hello 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:$rev
docker push 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:$rev
docker push 244530008913.dkr.ecr.eu-west-1.amazonaws.com/glenn:latest
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
- 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".
- Lag en Pull request og se at det bare
plan
kjøres.