Golang Deployment Process
We’re going to deploy a sample Golang server written in Gin - but that doesn’t mean you’re restricted to Gin. You’re free to use any Golang web framework. This app’s a very basic app with one endpoint - ‘/’ to demonstrate how you can push out a public-facing app on Porter Cloud with a public-facing domain and TLS. The idea here is to show you how a sample application can be quickly deployed on Porter Cloud, allowing you to then use the best practices for deploying your code. You can find the repository for this sample app here: https://github.com/porter-dev/golang-getting-started. Feel free to fork/clone it, or bring your own.Deploying Applications
Deploying web apps from a GitHub repository on Porter involves - broadly - the following steps:- Creating a new app on Porter where you specify the repository, the branch, any build settings, as well as what you’d like to run.
- Building your app and deploying it (automatically handled by Porter so you don’t have to worry about Continuous Integration and Continuous Deployment or your deployment pipeline in general).
Creating an App and Connecting Your GitHub Repository
On the Porter Cloud dashboard, select ‘Create a new application’, which opens the following screen:
This is where you select a name for your Golang web app and connect a GitHub repository containing your code. Once you’ve selected the appropriate repository, select the branch you’d like to deploy to Porter Cloud.
If you signed up for Porter Cloud using an email address instead of a Github account, you can easily connect your Github account to Porter by clicking on the profile icon on the top right corner of the dashboard, selecting ‘Account settings’, and adding your Github account.
Configuring Build Settings
Porter has the ability to automatically detect what language your app is written in and select an appropriate buildpack that can be used to package your Golang application for eventual deployment automatically. Porter can also use an existing Dockerfile for your build - that’s what we’ll use here. Once you’ve selected the branch you wish to use, Porter will display the following screen:
You can select a Dockerfile as well as define the build context/path the Dockerfile will be executed in.
Configure Services
At this point, taking a quick look at applications and services is a good idea. An application on Porter is a group of services where each service shares the same build and the same environment variables. If your app consists of a single repository with separate modules for, say, an API a frontend, and a background worker, then you’d deploy a single application on Porter with three separate services. Porter supports three kinds of services: ‘web’, ‘worker’, and ‘job’ services. Let’s add a single ‘web’ service for our app:
Configure Your Service
Now that we’ve defined a single web service, it’s time to tell Porter how it runs. That means specifying what command to run for this service, what CPU/RAM levels to allocate, and how it will be accessed publicly.
You can define what command you’d like Porter to use to run your web application in the ‘Main’ tab. This is required if your app’s being built using a buildpack; this may be optional if you opt to use a Dockerfile (since Porter will assume you have an ‘ENTRYPOINT’ in your Dockerfile and use that if it exists).
The ‘Resources’ tab allows you to define how much CPU and RAM your app’s allowed to access. Porter Cloud imposes a limit on the resources that can be used by a single app; if your app needs more it might make sense to look at Porter Standard instead. Porter Standard allows you to bring your own infrastructure and have more flexibility regarding resource limits. You can also use cloud provider credits to cover the cost of AWS Elastic Compute Cloud (EC2) instances or Azure virtual machines when using Porter Standard, or if you want to employ deployment strategies like blue/green and spin up a persistent data store.
In this section, you can also define the number of replicas you’d like to run for this app and any autoscaling rules—these allow you to instruct Porter to add more replicas if resource utilization crosses a certain threshold.
The ‘Networking’ tab is where you specify what port your app listens on. When you deploy a web app on Porter, we automatically generate a public URL for you to use - but you can also opt to bring your own domain by adding an A record to your DNS records, pointing your domain at Porter Cloud’s public load balancer, and adding the custom domain in this section. This can be done at any point - either while you’re creating the app or later once you’ve deployed it.
If your app listens on ‘localhost’ or ‘127.0.0.1’, Porter won’t be able to forward incoming connections and requests to your app. To that end, please ensure your app is configured to listen on ‘0.0.0.0’ instead.
Review and Merge Porter’s PR
Hitting ‘Deploy’ will show you the contents of a GitHub Action workflow that Porter would use to build and deploy your app:
This Github Action is configured to run every time you push a commit to the branch you specified earlier - when it runs, Porter applies the selected buildpack to your code, builds a final image, and pushes that image to Porter. Selecting ‘Deploy app’ will allow Porter to open a PR in your repo, adding this workflow file:
All you need to do is merge this PR, and your build will commence.
You can also use the ‘Activity’ tab on the Porter dashboard to see a timeline of your build and deployment pipeline going through. Once the build succeeds, you’ll also be able to see the deployment in action:
Accessing Your App
Your app’s now live on Porter Cloud. The Porter-generated unique URL is now visible on the dashboard under your app’s name. Let’s test it:
You can also check logs and resource consumption metrics on the Porter dashboard to see how your app is faring:
We’ve seen how you can go about deploying your Golang server on Porter. Here are a few pointers to help you dive further into configuring/tuning your app (we also have other guides to help you deploy apps written in another programming language):
- Adding your own domain.
- Adding environment variables and groups (environment groups are only available on Porter Standard).
- Scaling your app.
- Ensuring your app’s never offline.