Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpalomaki/nim-app
Sample Nim application on AWS App Runner
https://github.com/jpalomaki/nim-app
aws cloudflare docker nim
Last synced: 5 days ago
JSON representation
Sample Nim application on AWS App Runner
- Host: GitHub
- URL: https://github.com/jpalomaki/nim-app
- Owner: jpalomaki
- License: mit
- Created: 2023-03-03T20:26:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-17T18:19:04.000Z (almost 2 years ago)
- Last Synced: 2024-11-28T18:29:14.797Z (2 months ago)
- Topics: aws, cloudflare, docker, nim
- Language: Nim
- Homepage:
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nim-app
Containerized sample [Nim](https://nim-lang.org/) application powered by [Prologue](https://github.com/planety/prologue).
We deploy the application to AWS App Runner and proxy traffic to it via Cloudflare.
## Build and run locally
```sh
docker build -t nim-app:v1 .
docker run --init -it -p 8080:8080 --rm nim-app:v1
```
## Host the app with AWS App Runner (public endpoint)
:warning: This guide is a work in progress, and may be incomplete
:information_source: This requires an [AWS account](https://aws.amazon.com/premiumsupport/knowledge-center/create-and-activate-aws-account/) and will incur some [App Runner](https://aws.amazon.com/apprunner/pricing/) and [ECR](https://aws.amazon.com/ecr/pricing/) costs.
1. Create AWS ECR repository to host the container images
:information_source: We configure ECR image tags as MUTABLE, to leverage the App Runner autodeployment feature
```sh
aws cloudformation deploy --template-file aws/ecr-repo.yml --stack-name nim-app-ecr --parameter-overrides Name=nim-app
ecr_repository="$(aws cloudformation describe-stacks --stack-name nim-app-ecr | jq -r '.Stacks[0].Outputs[] | select(.OutputKey == "Uri") | .OutputValue')"
ecr_registry="${ecr_repository%%/nim-app}"
```
2. Build, tag and push the docker image to the ECR repository
```sh
aws ecr get-login-password | docker login --username AWS --password-stdin $ecr_registry
docker build -t nim-app:v1 .
docker tag nim-app:v1 $ecr_repository:v1
docker push $ecr_repository:v1
```
3. Deploy the app as AWS App Runner service
:information_source: We create the autoscaling configuration using AWS CLI, because [CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_AppRunner.html) does not yet support this functionality
```sh
autoscaling_config_arn="$(aws apprunner create-auto-scaling-configuration --auto-scaling-configuration-name nim-app \
--max-concurrency 100 --min-size 1 --max-size 2 | jq -r '.AutoScalingConfiguration.AutoScalingConfigurationArn')"
aws cloudformation deploy --template-file aws/app-runner.yml --capabilities CAPABILITY_NAMED_IAM \
--stack-name nim-app-runner --parameter-overrides Image="$ecr_repository:v1" AutoScalingConfigArn=$autoscaling_config_arn
service_arn="$(aws cloudformation describe-stacks --stack-name nim-app-runner | jq -r '.Stacks[0].Outputs[] | select(.OutputKey == "Arn") | .OutputValue')"
echo "Service URL: https://$(aws cloudformation describe-stacks --stack-name nim-app-runner | jq -r '.Stacks[0].Outputs[] | select(.OutputKey == "Url") | .OutputValue')"
```
4. Try changing the `hello` handler code in [src/app.nim](src/app.nim), then build, tag and push the `v1` image again, and observe result
## Proxy traffic to the App Runner service through Cloudflare
This requires a [Cloudflare](https://dash.cloudflare.com/sign-up) account and website.
1. Associate custom DNS domain (e.g. `app.example.com`) to the App Runner service
:information_source: We use AWS CLI here, because [CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_AppRunner.html) does not yet support this functionality
```sh
aws apprunner associate-custom-domain --service-arn $service_arn --domain-name --no-enable-www-subdomain
aws apprunner describe-custom-domains --service-arn $service_arn | jq -r '.CustomDomains[0].CertificateValidationRecords[]'
```
2. Create DNS records in Cloudflare DNS and configure SSL/TLS
- Login to [Cloudflare dashboard](https://dash.cloudflare.com)
- Navigate to `` → DNS → Records
- Select `Add record` and create a `DNS Only` CNAME record for all the validation records from step 1
- Select `Add record` and create a `Proxied` (orange clouded) CNAME record for ``, pointing to the App Runner service URL
- Navigate to `` → SSL/TLS → Overview
- Ensure that encryption mode is `Full (strict)`
3. Test the app at `https://` → DNS → Records
- Delete the associated certificate validation and proxy CNAME records
2. Remove AWS resources
```sh
aws cloudformation delete-stack --stack-name nim-app-runner
aws cloudformation wait stack-delete-complete --stack-name nim-app-runner
aws apprunner delete-auto-scaling-configuration --auto-scaling-configuration-arn $autoscaling_config_arn
for digest in $(aws ecr list-images --repository-name nim-app | jq -r '.imageIds[].imageDigest'); do
aws ecr batch-delete-image --repository-name nim-app --image-ids imageDigest=$digest
done
aws cloudformation delete-stack --stack-name nim-app-ecr
aws cloudformation wait stack-delete-complete --stack-name nim-app-ecr
```
## TODOs
- Explore use of [AWS C++ SDK](https://aws.amazon.com/sdk-for-cpp/) from Nim (calling e.g. DynamoDB)
-