feat: add deployment solution to digital ocean app platform (#430)

.github/workflows/release-docker.yml

@@ -32,3 +32,15 @@ jobs:
           pass: ${{ secrets.DOCKER_PASSWORD }}
           slug: asyncapi/server-api
           description: Server API providing official AsyncAPI tools
+
+  deploy-app:
+    name: Deploy to DigitalOcean App
+    needs: publish-docker
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to DigitalOcean App
+        uses: digitalocean/[email protected]
+        with:
+          app_name: "server-api"
+          token: ${{ secrets.DIGITALOCEAN_ACCESS_TOKEN }}
+          images: '[{"name":"asyncapi-server-api","image":{"registry_type":"DOCKER_HUB","registry":"asyncapi","repository":"server-api","tag":"latest"}}]'

README.md

@@ -55,6 +55,24 @@ server is ready to use on [http://localhost:80](http://localhost:80).
 2. Write code and tests.
 3. Make sure all tests pass `npm test`
 
+## Deployment
+
+This project is deployed to [DigitalOcean App Platform](https://www.digitalocean.com/products/app-platform/) using [Terraform](https://www.terraform.io/) and [GitHub Actions](https://www.github.com/digitalocean/app_action/). To deploy it to your own account, follow these steps:
+
+1. Fork this repository.
+2. Create a [DigitalOcean Personal Access Token](https://cloud.digitalocean.com/account/api/tokens) with `read` and `write` permissions. For more information, see [DigitalOcean's documentation](https://docs.digitalocean.com/reference/api/create-personal-access-token/).
+3. Run `terraform init` to initialize the Terraform project as can be seen [here](./deployments/apps/main.tf). This should be run being located at ./deployments/apps directory preferably.
+4. Run `terraform apply` to create the necessary infrastructure. 
+
+> [!NOTE]
+> You need to export the following environment variables before running `terraform apply`:
+> - `DIGITALOCEAN_ACCESS_TOKEN`: Your DigitalOcean Personal Access Token.
+
+
+### How the GitHub workflow works
+
+The [GitHub workflow](./.github/workflows/release-docker.yml) is triggered when a new tag is pushed to the repository. It will build a new Docker image and push it to the [Docker Hub](https://hub.docker.com/r/asyncapi/server-api) repository. Then the [DigitalOcean App Platform GitHub Action](https://www.github.com/digitalocean/app_action/) updates the application with the new image.
+
 ## Contribution
 
 Read [CONTRIBUTING](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md) guide.

deployments/apps/.gitignore

@@ -0,0 +1,3 @@
+.terraform
+terraform.tfstate
+terraform.tfstate.backup

deployments/apps/main.tf

@@ -0,0 +1,82 @@
+terraform {
+  required_version = ">= 1.0.0"
+
+  required_providers {
+    digitalocean = {
+      source  = "digitalocean/digitalocean"
+      version = ">= 2.0.0"
+    }
+  }
+}
+
+provider "digitalocean" {}
+
+resource "digitalocean_app" "server-api" {
+  spec {
+    name = "server-api"
+    region = "sfo3"
+
+    domain {
+      name = "api.asyncapi.com"
+      type = "PRIMARY"
+    }
+
+    ingress {
+      rule {
+        component {
+          name = "asyncapi-server-api"
+        }
+        match {
+          path {
+            prefix = "/"
+          }
+        }
+        cors {
+          allow_origins {
+           exact = "*"
+          }
+          allow_methods = ["GET", "POST", "PUT", "DELETE", "OPTIONS"]
+          allow_headers = ["*"]
+        }
+      }
+    }
+
+    service {
+      name = "asyncapi-server-api"
+      http_port = 80
+      health_check {
+        http_path = "/v1/help/validate"
+        port = 80
+      }
+      env {
+        key = "PORT"
+        value = "80"
+      }
+
+      image {
+        registry_type = "DOCKER_HUB"
+        registry = "asyncapi"
+        repository = "server-api"
+        tag = "latest"
+      }
+
+      instance_count = 1
+      instance_size_slug = "basic-xs" // $10/month
+
+      alert {
+        rule = "CPU_UTILIZATION"
+        value = 80
+        operator = "GREATER_THAN"
+        window = "TEN_MINUTES"
+      }
+    }
+
+    alert {
+      rule = "DEPLOYMENT_FAILED"
+    }
+  }
+}
+
+output "live_url" {
+  value = digitalocean_app.server-api.default_ingress
+}