📔Deploy a FastAPI App on Clouddley Triggr

Learn how to deploy a FastAPI app on Triggr.

In this article, we'll learn how to deploy a FastAPI application on Clouddley Triggr. Before that, What is Clouddley Triggr? Clouddley Triggr is a zero downtime application deployment tool that auto-detects your runtime and deploys your application to your server (virtual machines and bare metal). Let’s begin!

Prerequisites

• A GitHub or Bitbucket Account.

• A Clouddley account.

• A FastAPI application.

• A virtual machine on a Cloud platform or bare metal server.

Deploy your FastAPI Application

Optimize your codebase for deployment

To deploy a FastAPI application on Triggr, you need to create a Procfile in the root directory of your project. This specifies the command used to run the application.

Procfile

web: python main.py

Accessing Clouddley Triggr Apps

• Open your web browser, log in to your Clouddley account

• Navigate to Triggr Apps and click on Deploy App

Accessing Triggr Apps

Step 1: Configure Service

• Choose your Git hosting service; either GitHub or Bitbucket. For this tutorial, we will be using GitHub.

• Click on Continue with GitHub

Choose your Git hosting service

Step 2: Configure Git

• To connect your GitHub user or organization account, click the Select username/organization dropdown and Add GitHub account.

• Select your repository and the branch from the dropdown list or quickly search.

• Click on NEXT

Setup the FastAPI application repository on Triggr

Step 3: Configure your Virtual Machine

• To configure your VM, insert your VM hostname or IP address, VM user, and the VM port for SSH access.

• Use the Clouddley CLI (recommended) or connect via SSH to verify.

Clouddley CLI

The Clouddley CLI is a command-line tool that allows you to interact with the Clouddley Platform from your terminal.

• Open the command line of the remote VM you want to configure to Clouddley and install Clouddley CLI by running the command:

curl -L https://raw.githubusercontent.com/clouddley/cli/main/install.sh | sh

• To install Triggr, run the command:

clouddley triggr install

Using the CLI, you can deploy resources, manage configurations, and automate tasks efficiently.

SSH

• Download the public key to your local machine.

• Run the provided command in your local machine allowing Triggr to connect to your virtual machine.

ssh-copy-id -f -i ~/path/to/downloaded/Publickey username@ipaddress

Replace ~/path/to/downloaded/Publickey ,username and ipaddress with your actual values.

• Click on Verify. This verifies the connection

• Click on NEXT

Configuration of virtual machine on Triggr

Step 4: Configure app settings

Insert the name of the application and its port.

Configure the App name and port

The firewall of the virtual machine should allow access to the application port.

Step 5: Configure Environment Variables

• To add environment variables, click on ➕ Add Variable
• Choose an ENV mode: either a single variable or import variables. Learn more here.

Single Variable

Single variable ENV mode

Import Variables

Import variables ENV mode

• Add the key-value pairs and Click on Save

• Click on NEXT

Adding environment variables

Step 6: Setup Notifications (optional)

• To configure the notification settings of the application, click on ➕ Add Alert
• Select the Alert type. For this tutorial, we will set up Email alerts.

• Toggle on the buttons of the deployment event (failed, timed out, or success) you want to be notified of.

• Enter the Email address where you want to receive alerts. (You can add multiple email addresses)

• Click on Save

• Click on Deploy

Notifications set up and creation of FastAPI application on Triggr

Step 7: Test and Verify the app

• Click on Go to Dashboard. Your app will be visible on the Triggr apps dashboard.

• After the app deployment is complete, the app status changes from deploying to running

FastAPI application dashboard overview

• Click on 🌐 Website at the top right corner of the page, this opens the URL of the deployed application in your browser.
• You can test the application functionalities.

FastAPI application running from Triggr on a cloud virtual machine

You have successfully deployed a FastAPI application on Triggr. You can manage it directly from the app dashboard by clicking the three dots (...) at the top-right corner to access Edit, Instant Rollback, Scale, Pause, and Delete options.

Furthermore, you can switch to different tabs on the application dashboard to perform the following actions; view your deployment history, view or download logs, add a custom domain, and view the environment variables.

Conclusion

Congratulations🎉 on successfully deploying a FastAPI application on Clouddley Triggr. You can find the application source code here. You can also check out how different frameworks can be deployed on Clouddley Triggr in our how-to guides.