Skip to content

Latest commit

 

History

History
118 lines (87 loc) · 4.58 KB

README.md

File metadata and controls

118 lines (87 loc) · 4.58 KB
Raw

Scale to Zero App Shell for Static Web Hosting in fly.io

What?

1. It is a Native Aot Scale to Zero Application Shell for Web Hosting of Static Content in fly.io

Why?

1. Pay for Hosting based on Actual Usage of Resources rather than for subscription of Resources
2. Protect Web Hosting from Over Usage

Scale to Zero Performance

1. Fly Log showing Scale to Performance on start of less than 50 Millisecond

Fly Code Start

Main Links

  1. Github Repository Link of the AotWeb Open Source MIT Licensed Repository
  2. Fly Hosted App Link of the Hosted Scale To Zero App Shell to show the Published Astro Blog Template copied to wwwroot

Related Links

  1. Github Repository Link of the StaticWeb Repository for Self Hosting with Additional Features
  2. Fly Hosted App Link of the Hosted Scale To Zero App Static Web with Additional Features

Important features which the App Shell provides for hosting Static Content

  1. Auto Shutdown MicroVM fly.io Machines
    Can auto shutdown after a idle time of configurable 10 seconds if have no requests

  2. View Server Instance Information
    Can view information about the web instance on querying using /Echo

  3. Access Other Region Instance (If Hosted in Multiple Regions)
    Can use ?region=sin querystring to replay to the instance in the specified region

  4. View Server Performance on Cold Start/Warm Start
    Can view the performance log metrics of the instance in fly.io logs

Getting Started

Prereqisite

Install flyctl from https://fly.io for your respective environment

Running Locally

Clone the repo and run the appropriate **Arshu.ScaleToZeroAotWeb** asp.net core project for the respective platform

Running from Docker

1. Run the Docker Image **arshucs/ScaleToZeroAotWeb** as below
2. docker run --publish 8080:8080 arshucs/ScaleToZeroAotWeb:latest

Deploying to fly.io Serverless Machines

Fly.io provides free/paid options which should be more than sufficient to host any web app at low cost since the machine will auto shutdown after a idle time configured using Environment Flag

Prerequisite is Install the Fly Command Line Program from fly site and login using the fly command line program using fly auth login

Replace [appname] and [orgname] with your own app name and org name eg. personal

Initial Step 1 : Create a Fly App for Machines [NOT A FLY APP]
flyctl apps create --machines --name [appname] --org [orgname]

Initial Step 2 : Allocation IPv4 and IPv6 for the App
flyctl ips allocate-v6 --app [appname]
flyctl ips allocate-v4 --shared --app [appname]
flyctl ips list --app [appname]

Initial Step 3 : Modify AppName in fly.toml
Modify the appname and checks.appname in fly.toml

Initila Step 4 : Upload the Docker Image to Fly Docker Registry
flyctl deploy --dockerfile Dockerfile --build-only --remote-only --push --image-label latest -a [appname]

Initial Step 5 : Deploy the Machine to Fly
flyctl machine run registry.fly.io/[appname]:latest --name [appname]-sin-1 --region sin --port 443:8080/tcp:tls --port 80:8080/tcp:http --env INITIAL_TIME_IN_SEC="10" --env IDLE_TIME_IN_SEC="10" --config fly.toml --app [appname]
Repeat Step 5 for each region you want to deploy the app

Update Step 6
After every change in the src deploy the docker image to Fly Docker Registry and Update the Machine
flyctl deploy --dockerfile Dockerfile --build-only --remote-only --push --image-label latest -a [appname]
Update the Machine
flyctl machine update [machineID] --image registry.fly.io/[appname]:latest --port 443:8080/tcp:tls --port 80:8080/tcp:http --env INITIAL_TIME_IN_SEC="15" --env IDLE_TIME_IN_SEC="15" --config fly.toml --app [appname]

Optional Steps
Show Log of the App
flyctl logs -a [appname] -r sin
Retrive the Machine ID
flyctl machine list --app [appname]
Stop the Machine
flyctl machine stop [machineID]
Destroy the Machine
flyctl machine destroy [machineID] --force
Delete the [appname] after testing
flyctl apps destroy [appname] --yes

Hosting your own Content

Replace the wwwfolder with your own static web content.

eg. For Compatible Astro Projects, copy the content of dist folder to wwwroot created using npm run build

Comment out the Readme Endpoint lines in program.cs to Stop showing this Readme