tutorial on deploying fpm on heroku

[amitu]

Status: Done(From AbrarK)

Owner: @AbrarNitk @Arpita-Jaiswal
Started On: 7th Sept 2022

TODO

• /clear-cache/?everything=true
• incremental deletes
• Blog for Custom Domain Mapping with different domain providers with SSL support. Google domain, go daddy, mailchimp, etc...
• Blog for Deploy FPM on Heroku Using CLI

15th Sept 2022

• Deploy FPM on Heroku fpm.dev: tutorial on how to deploy your fpm package heroku

14th Sept 2022

• fpm.dev: tutorial on how to deploy your fpm package heroku
• Implement Button In README.md to deploy on heroku
• [Update fpm-heroku repo to add button in fpm-template](fastn-stack/fastn-heroku@8c18d41

13th Sept 2022

Deployment of FPM on Heroku is working.

• new repo containing Procfile etc (FifthTry/fpm-heroku): deploy and test manually (use abrark as test package)
  • AbrarK Repo
  • https://github.com/fifthtry/fpm-heroku
• Github Action (Deploy FPM on Heroku, Update Content On Heroku)

7th Sept 2022

---

The Tutorial: Deploy FPM Package On Heroku

Note: There is another way to deploy on Heroku using build-packs as well.

What we are trying to achieve is: package content hosted on Github, and served via Heroku. Currently we serve via Github Page/Vercel (most of our packages) or via fpm-controller (abrark.com).

Deploy FPM on Heroku

With #457 implemented now we can deploy fpm on Heroku. Lets deploy it there.

First manually deploy fpm on heroku. Once it works fine, we will implement the button. Use Docker. But preferably, since we have a binary itself, we can create a github repo, which contains a Profile and fpm binary.

Say the repo we are hosting is abrark.com, how to run fpm using cli?

fpm serve --download-base-url https://raw.githubusercontent.com/AbrarNitk/abrark/main/

Button

We need to create a deploy Heroku Button so anyone can deploy fpm on heroku in one click. The button should be on fpm's README.md.

We need to specify a configuration, the fpm package URL, so maybe we can not put it in README of fpm and it has to be in the readme of the package itself. For each package we have a github repo, and their README, so the button should be there.

We will have to pass the package name as a parameter, maybe we can use https://heroku.com/deploy?template=https://github.com/fifthtry/fpm-heroku&env[DOWNLOAD_BASE_URL]=https://raw.githubusercontent.com/AbrarNitk/abrark/main/ syntax.

Procfile will pass the env to cli:

web: ./fpm --download-base-url=$DOWNLOAD_BASE_URL

Github Hook To Invalidate

On every commit to Github package repo, in main branch, we want to invalidate the cache. So create an github action yml file that will run on every push, and will call https://<package-url>/-/clear-cache/?package=main&all-dependencies=true.

Incremental Deletes

If in the commit only two files were modified, we need not delete all files and dependencies. I think it is possible to fetch the list of files modified in the commit (or maybe we can ask FPM itself for the last commit it knows about, so say FPM will keep track of latest commit, so we will fetch last commit fpm knows about, then do a diff to find what all files were modified in Github action, and then tell fpm which files to delete and the latest commit hash).

We have to get fpm to keep track of commit has as in case two commits happen one after another, there may be some issue, or if the action failed to start the file will never be updated etc. I feel the only way to reliably get file list is by doing what I described.

Resources

• https://medium.com/ki-labs-engineering/deploying-a-native-go-binary-on-heroku-6d4c955819d8

[Heulitig]

Discussion with @AbrarNitk

• Had a talk whether the new repo should be on FifthTry or Personal to deploy and test fpm binary on heroku manually. For now, the repo will be personal which will be moved to FifthTry once its functional.
• @AbrarNitk shared about how he works on any new project by creating a mini project repo under that domain and documenting every new stuff he learns on the way. So I will possibly adopt some similar tactics to approach this task and get relevant things documented on the go.
• Talked about whether we should have a seperate repo for keeping latest fpm release binary which can be downloaded to heroku instead of keeping the binary in the repo itself which is getting deployed on heroku.
• Discussed about the heroku alternatives which can be used as a deployment platform. Once this heroku deployment is done we can proceed with fpm deployment on any of these alternatives. Refer here

[AbrarNitk]

We can also integrate Heroku APIs in FPM itself and let people only install fpm binary.

Heroku Commands

heroku login
heroku authorizations:create
git push heroku main
etc...

FPM Commands

fpm heroku login
fpm heroku authorizations:create
etc...

https://devcenter.heroku.com/articles/platform-api-reference

[amitu]

This will make fpm binary big. But if we can do some of these things using wasm and load it on demand then maybe.

[AbrarNitk]

How to handle if Heroku expires the token, which we are using in GitHub actions?

https://devcenter.heroku.com/articles/oauth

[amitu]

Think about the solution I told yesterday na. Token business is more work. How to solve it with Github only?