Skip to content

Latest commit

 

History

History
76 lines (60 loc) · 3.49 KB

README.md

File metadata and controls

76 lines (60 loc) · 3.49 KB

Quotes Service CRaC Build & Deploy to Cloud Run

This repo leverages checkpoint/restore scripts originally provided Seb Deleuze (sdeleuze/spring-boot-crac-demo) It is intended to demonstrate Spring Boot 3.2+ CRaC support by creating a ready to restore container image.

Please note that, while you can build the checkpointed image on both Intel and Apple M* series, in order to deploy to Cloud Run you have to build in a similar architecture as the one you would be running on. See the Cloud Run Container Runtime Contract

Warning: for real projects make sure to not leak sensitive data in CRaC files since they contain a snapshot of the memory of the running JVM instance.

Step 1: Checkpoint

From within the quotes-crac folder, you have the choice to run either on demand checkpoint/restore of a running application with:

./checkpoint.sh

Or to run an automatic checkpoint/restore at startup with:

./checkpointOnRefresh.sh

Step 2: Restore

Restore the application with:

./restore.sh

Deploy CRaC Image

Let's build the checkpointed CRaC image and deploy it to Cloud Run.

# first, build the image if you have not done so before
./checkpoint.sh

# tag the image
export PROJECT_ID=$(gcloud config list --format 'value(core.project)')
echo   $PROJECT_ID
docker tag quotes-crac:checkpoint  ${REGION}-docker.pkg.dev/${PROJECT_ID}/crac/quotes-crac:checkpoint
docker push ${REGION}-docker.pkg.dev/${PROJECT_ID}/crac/quotes-crac:checkpoint

Deploy the image to Cloud Run and test it

# get the PROJECT_ID
export PROJECT_ID=$(gcloud config list --format 'value(core.project)')
echo   $PROJECT_ID

gcloud run deploy quotes-crac      \
  --image=us-central1-docker.pkg.dev/${PROJECT_ID}/crac/quotes-crac:checkpoint      \
  --execution-environment=gen1      \
  --allow-unauthenticated     \
  --region=us-central1     \
  --memory 2Gi --cpu 2 --args="--cap-add CHECKPOINT_RESTORE --cap-add SETPCAP "
     
# observe the deploy output
...
  ✓ Deploying... Done.                                                                                                                                
  ✓ Creating Revision...                                                                                                                            
  ✓ Routing traffic...                                                                                                                              
  ✓ Setting IAM Policy...                                                                                                                           
Done.                                                                                                                                               
Service [quotes-crac] revision [spring-crac-00003-his] has been deployed and is serving 100 percent of traffic.
Service URL: https://quotes-crac-....XYZ

Run a test request:

# use your deployment URL
curl https://quotes-crac-....XYZ/quotes

# observe
List of quotes from famous books

# Note: if you run your service as authenticated, use 
curl -i  -H "Authorization: Bearer $(gcloud auth print-identity-token)" https://quotes-crac-....XYZ/quotes