README.md

Hello App Runner

This is a example web service for AWS App Runner. You can use this repo to automatically build and deploy or use pre-built images at ECR Public.

You can read about AWS App Runner in the launch blog

Deploy to App Runner

If you want to deploy this container make sure you have the latest release of the awscli and run

SERVICE_NAME=hello-app-runner

cat > hello-app-runner.json <<EOF
{
    "ImageRepository": {
        "ImageIdentifier": "public.ecr.aws/aws-containers/hello-app-runner:latest",
        "ImageConfiguration": {
            "Port": "8000"
        },
        "ImageRepositoryType": "ECR_PUBLIC"
    },
    "AutoDeploymentsEnabled": false
}
EOF

aws apprunner create-service --service-name ${SERVICE_NAME} \
    --source-configuration file://hello-app-runner.json

If you want to deploy and manage this container using AWS CloudFormation just run

SERVICE_NAME=hello-app-runner

aws cloudformation create-stack --template-body file://cf.yaml --stack-name ${SERVICE_NAME} --parameters "ParameterKey=ServiceName,ParameterValue=${SERVICE_NAME}"

Features

The service exposes a basic splash page with links to relevant App Runner content. It has two unique features which benefit from running it in App Runner.

Upon first request it generates a unique avatar for each service which is saved in ./static/social.png. This image is used for social preview images when shared online and will be the same across different all of your container instances. It is an example of using a local disk for small assets in an application.

The service also provides a /metrics endpoint so you can see some of the long running metrics of requests coming into the service. This is an example of global state stored on a per container basis. It can be used for state management, in memory cache, or other application needs.

There also might be an easter egg or two if you read the code. ;)

Development

To run this application locally you can use pipenv

pipenv install
pipenv run python app.py

To run the application locally in a container you can use docker

docker build -t hello-app-runner .
docker run -it -p 8000:8000 hello-app-runner