[Recognizer] Setup CD (#29)

Author: mickel8

.github/workflows/__CD__build-publish-image.yml

@@ -0,0 +1,46 @@
+on:
+  workflow_call:
+    inputs:
+      app-name:
+        required: true
+        type: string
+
+env:
+  REGISTRY: ghcr.io
+
+jobs:
+  build-publish-image:
+    name: "Build and publish image"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: ${{ inputs.app-name }}
+          
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        
+      - name: Login to Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository }}/${{ inputs.app-name }}
+          tags: type=match,pattern=${{ inputs.app-name }}-v(.*),group=1
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: ./${{ inputs.app-name }}
+          platforms: linux/amd64
+          push: true
+          tags: ${{  steps.meta.outputs.tags }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/__CD__deploy-image.yml

@@ -0,0 +1,38 @@
+on:
+  workflow_call:
+    inputs:
+      app-name:
+        required: true
+        type: string
+    secrets:
+      ssh-host:
+        required: true
+      ssh-username:
+        required: true
+      ssh-priv-key:
+        required: true
+      secret-key-base:
+        required: true
+      phx-host:
+        required: true
+      ice-port-range:
+        required: true
+
+jobs:
+  deploy-image:
+    name: Deploy image
+    runs-on: ubuntu-latest
+    steps:
+      - name: Run docker via remote SSH
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.ssh-host }}
+          username: ${{ secrets.ssh-username }}
+          key: ${{ secrets.ssh-priv-key }}
+          script: |
+            export TAG=${{ github.ref_name }}
+            export TAG=${TAG#*-v}
+            docker stop ${{ inputs.app-name }}
+            docker rm ${{ inputs.app-name }}
+            docker run -d --restart unless-stopped --name ${{ inputs.app-name }} -e SECRET_KEY_BASE=${{ secrets.secret-key-base }} -e PHX_HOST=${{ secrets.phx-host }} -e ICE_PORT_RANGE=${{ secrets.ice-port-range }} --network host ghcr.io/elixir-webrtc/apps/${{ inputs.app-name }}:${TAG}
+            docker image prune --all --force

.github/workflows/__CD__recognizer.yml

@@ -0,0 +1,30 @@
+name: Recognizer CD 
+
+on:
+  push:
+    tags:
+      - "recognizer-v*.*.*"
+
+permissions:
+  contents: read
+  packages: write
+
+jobs: 
+  build-publish-recognizer-image:
+    name: "Build and publish Recognizer image"
+    uses: ./.github/workflows/__CD__build-publish-image.yml
+    with:
+      app-name: recognizer
+  deploy-recognizer:
+    name: "Deploy Recognizer image"
+    needs: build-publish-recognizer-image
+    uses: ./.github/workflows/__CD__deploy-image.yml
+    with:
+      app-name: recognizer
+    secrets:
+      ssh-host: ${{ secrets.RECOGNIZER_SSH_HOST }}
+      ssh-username: ${{ secrets.RECOGNIZER_SSH_USERNAME }}
+      ssh-priv-key: ${{ secrets.RECOGNIZER_SSH_PRIV_KEY }}
+      secret-key-base: ${{ secrets.RECOGNIZER_SECRET_KEY_BASE }}
+      phx-host: ${{ secrets.RECOGNIZER_PHX_HOST }}
+      ice-port-range: ${{ secrets.RECOGNIZER_ICE_PORT_RANGE }}

.github/workflows/ci.yml renamed to .github/workflows/__CI__all.yml

@@ -8,19 +8,19 @@ permissions:
 jobs:
   build_check_recognizer:
     name: Recognizer CI
-    uses: ./.github/workflows/build-check-app.yml
+    uses: ./.github/workflows/__CI__build-check-app.yml
     with:
       workdir: recognizer
       with-ffmpeg: true
 
   build_check_broadcaster:
     name: Broadcaster CI
-    uses: ./.github/workflows/build-check-app.yml
+    uses: ./.github/workflows/__CI__build-check-app.yml
     with:
       workdir: broadcaster
 
   build_check_nexus:
     name: Nexus CI
-    uses: ./.github/workflows/build-check-app.yml
+    uses: ./.github/workflows/__CI__build-check-app.yml
     with:
       workdir: nexus

.github/workflows/build-check-app.yml renamed to .github/workflows/__CI__build-check-app.yml

@@ -39,6 +39,12 @@ jobs:
       with:
         node-version: 22
 
+    - name: Install libsrtp2
+      working-directory: .
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y libsrtp2-dev
+
     - name: Install FFmpeg development libraries
       if: ${{ inputs.with-ffmpeg }}
       working-directory: .

recognizer/Dockerfile

@@ -10,7 +10,6 @@
 #   - https://hub.docker.com/_/debian?tab=tags&page=1&name=bullseye-20231009-slim - for the release image
 #   - https://pkgs.org/ - resource for finding needed packages
 #   - Ex: hexpm/elixir:1.16.0-erlang-26.2.1-debian-bullseye-20231009-slim
-
 ARG ELIXIR_VERSION=1.17.2
 ARG OTP_VERSION=27.0.1
 ARG DEBIAN_VERSION=bookworm-20240701-slim

recognizer/README.md

@@ -13,7 +13,7 @@ Now you can visit [`localhost:5002`](http://localhost:5002) from your browser.
 
 You can also run Recognizer using Docker.
 
-Build an image:
+Build an image (or use `ghcr.io/elixir-webrtc/apps/recognizer:latest`):
 
 ```
 docker build -t recognizer .

recognizer/config/runtime.exs

@@ -16,10 +16,26 @@ import Config
 #
 # Alternatively, you can use `mix phx.gen.release` to generate a `bin/server`
 # script that automatically sets the env var above.
+
+read_ice_port_range! = fn ->
+  case System.get_env("ICE_PORT_RANGE") do
+    nil ->
+      [0]
+
+    raw_port_range ->
+      case String.split(raw_port_range, "-", parts: 2) do
+        [from, to] -> String.to_integer(from)..String.to_integer(to)
+        _other -> raise "ICE_PORT_RANGE has to be in form of FROM-TO, passed: #{raw_port_range}"
+      end
+  end
+end
+
 if System.get_env("PHX_SERVER") do
   config :recognizer, RecognizerWeb.Endpoint, server: true
 end
 
+config :recognizer, ice_port_range: read_ice_port_range!.()
+
 if config_env() == :prod do
   # The secret key base is used to sign/encrypt cookies and other secrets.
   # A default value is used in config/dev.exs and config/test.exs but you

recognizer/lib/recognizer/room.ex

@@ -59,7 +59,14 @@ defmodule Recognizer.Room do
   @impl true
   def handle_call({:connect, channel_pid}, _from, %{channel: nil} = state) do
     Process.monitor(channel_pid)
-    {:ok, pc} = PeerConnection.start_link(video_codecs: @video_codecs)
+
+    ice_port_range = Application.fetch_env!(:recognizer, :ice_port_range)
+
+    {:ok, pc} =
+      PeerConnection.start_link(
+        video_codecs: @video_codecs,
+        ice_port_range: ice_port_range
+      )
 
     state =
       state

recognizer/lib/recognizer_web/controllers/room_controller.ex

@@ -2,6 +2,6 @@ defmodule RecognizerWeb.RoomController do
   use RecognizerWeb, :controller
 
   def room(conn, _params) do
-    render(conn, :room)
+    render(conn, :room, page_title: "Room")
   end
 end