Update server github actions.

Layoric · Layoric · commit f05e58706524 · 2021-10-27T16:31:53.000+11:00
diff --git a/.github/workflows/README.md b/.github/workflows/README.md
@@ -1,172 +1,56 @@
 # ServiceStack mix GitHub Actions
-`release.yml` generated from `x mix release-ecr-aws`, this template in designed to help with automating CI deployments to AWS ECS and dedicated AWS ECS cluster.
-This is a cheap way to start without an AWS Application Load Balancer (ALB) and also be in a situation that will easier to add one once the web service needs additional scale or high availability.
+`release.yml` generated from `x mix release-ghr-vanilla`, this template in designed to help with CI deployment to a dedicated server with SSH access.
 
 ## Overview
-`release.yml` is designed to work with a ServiceStack app templates deploying directly to a single server in a dedicated ECS cluster via templated GitHub Actions.
+`release.yml` is designed to work with a ServiceStack app deploying directly to a single server via SSH. A docker image is built and stored on GitHub's `ghcr.io` docker registry when a GitHub Release is created.
 
-## Setup
-### Create unique ECS cluster
-For this setup, it is best to create a separate cluster as cluster will only have the single instance in it running.
-This pattern is to start from a good base with AWS ECS and automated CI deployment while avoiding the higher costs of needing to run an application load balancer (ALB).
+GitHub Actions specified in `release.yml` then copy files remotely via scp and use `docker-compose` to run the app remotely via SSH.
 
-If/when you can justify the cost of an ALB for easier scaling and zero downtime deployment, the GitHub Action `release.yml` can be slightly modified to be used with a re-created or different ECS Service that is configured to be used with an Application Load Balancer and Target Group.
+## Deployment server setup
+To get this working, a server needs to be setup with the following:
 
-### Elastic IP (optional)
-The reason you might want to register this first is because we are only running one EC2 instance and hosting our own `nginx-proxy` on the same instance as the applications.
-Since an `A` record will be pointing there, one advantage of not using an auto-assigned IP is that we can reassign the elastic IP if for what ever reason the instance goes down or is lost.
+- SSH access
+- docker
+- docker-compose
+- ports 443 and 80 for web access of your hosted application
 
-## Launch to EC2 Instance
-When launching the EC2 instance, you'll need to select an 'ECS optimized' AMI as the image used for your instance.
-### Choose AMI
-The easiest way to find the latest Amazon Linux 2 image for this is to go to the [AWS documentation for ECS-optimized AMIs and look up your region here](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#ecs-optimized-ami-linux).
+This can be your own server or any cloud hosted server like Digital Ocean, AWS, Azure etc. 
 
-Using the AMI ID (starts with `ami-`) at the bottom, search in the 'Community AMIs' tab on the first step of the `Launch EC2 Instance` wizard.
+When setting up your server, you'll want to use a dedicated SSH key for access to be used by GitHub Actions. GitHub Actions will need the *private* SSH key within a GitHub Secret to authenticate. This can be done via ssh-keygen and copying the public key to the authorized clients on the server.
 
-### Choose Instance Type
-A t2.micro or larger will work fine, this pattern can be used to host multiple applications on the 1 server so if the number of applications gets larger, you might need a larger instance type.
-> Note this pattern is suitable for testing prototypes or low traffic applications as it is cost effective and makes it easy to bundle multiple apps onto 1 EC2 instance.
-
-### Configure Instance
-Under `IAM role`, use the `ecsInstanceRole`, if this is not available, see [AWS documentation for the process of checking if it exists and creating it if needed](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/instance_IAM_role.html).
-
-If you are *not* using your own generated Elastic IP, select `Enabled` for `Auto-assign Public IP`.
-
-You will also want to add the following Userdata script (in the `Configure` step of the launch wizard) with your own `ECS_CLUSTER` value. This tells the ecs-agent running on the instance which ECS cluster the instance should join.
-
-```bash
-#!/bin/bash
-cat <<EOS >/etc/ecs/ecs.config
-ECS_CLUSTER=my-cluster
-ECS_AVAILABLE_LOGGING_DRIVERS=["awslogs", "syslog"]
-ECS_ENABLE_CONTAINER_METADATA=true
-EOS
-```
-
-Note down your cluster name as it will need to be used to create the cluster in ECS before it is visible.
-See [`ECS Container Agent Configuration`](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) for more information.
-
-### Add Storage
-The default of 30gb is fine but take into account how large/how many applications you'll have running.
-
-### Configure Security Groups
-You'll want to expose at least ports 80 and 443.
-
-### Setup Docker-compose and nginx-proxy
 To let your server handle multiple ServiceStack applications and automate the generation and management of TLS certificates, an additional docker-compose file is provided via the `x mix` template, `nginx-proxy-compose.yml`. This docker-compose file is ready to run and can be copied to the deployment server.
-> This is done via docker-compose rather than via ECS itself for simplicity.
-
-First you'll need to install `docker-compose`.
-
-```bash
-sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
-sudo chmod +x /usr/local/bin/docker-compose
-```
-Run `docker-compose --version` to confirm.
-
-To copy you can use scp or just creating a new file via server text editor to copy the short YML file over. For this example, we are going to copy it straight to the ~/ (home) directory.
-
-```bash
-scp -i <path to private ssh key> ./nginx-proxy-compose.yml ec2-user@<server_floating_ip>:~/nginx-proxy.compose.yml
-```
 
 For example, once copied to remote `~/nginx-proxy-compose.yml`, the following command can be run on the remote server.
 
 ```
 docker-compose -f ~/nginx-proxy-compose.yml up -d
 ```
 
-This will run an nginx reverse proxy along with a companion container that will watch for additional containers in the same docker network and attempt to initialize them with valid TLS certificates. This includes containers created and managed by the ECS agent.
-> If the container doesn't have the environment variable `VIRTUAL_HOST` set, it will be ignored.
+This will run an nginx reverse proxy along with a companion container that will watch for additional containers in the same docker network and attempt to initialize them with valid TLS certificates.
 
 ## GitHub Repository setup
 The `release.yml` assumes 6 secrets have been setup.
 
-- AWS_ACCESS_KEY_ID - AWS access key for programmatic access to AWS APIs.
-- AWS_SECRET_ACCESS_KEY - AWS access secrets for programmatic access to AWS APIs.
-- AWS_REGION - default region for AWS API calls.
-- AWS_ECS_CLUSTER - Cluster name in ECS, this should match the value in your Userdata.
-- HOST_DOMAIN - Domain/sub-domain of your application, eg `vitepress-docs.example.com` .
+- CR_PAT - GitHub Personal Token with read/write access to packages.
+- DEPLOY_HOST - hostname used to SSH to, this can either be an IP address or subdomain with A record pointing to the server.
+- DEPLOY_PORT - SSH port, usually `22`.
+- DEPLOY_USERNAME - the username being logged into via SSH. Eg, `ubuntu`, `ec2-user`, `root` etc.
+- DEPLOY_KEY - SSH private key used to remotely access deploy server/app host.
 - LETSENCRYPT_EMAIL - Email address, required for Let's Encrypt automated TLS certificates.
 
 These secrets can use the [GitHub CLI](https://cli.github.com/manual/gh_secret_set) for ease of creation. Eg, using the GitHub CLI the following can be set.
 
 ```bash
-gh secret set AWS_ACCESS_KEY_ID -b"<AWS_ACCESS_KEY_ID>"
-gh secret set AWS_SECRET_ACCESS_KEY -b"<AWS_SECRET_ACCESS_KEY>"
-gh secret set AWS_REGION -b"<AWS_REGION, eg us-east-1>"
-gh secret set AWS_ECS_CLUSTER -b"<AWS_ECS_CLUSTER, eg vitepress-docss>"
-gh secret set HOST_DOMAIN -b"<HOST_DOMAIN, eg vitepress-docs.example.com>"
-gh secret set LETSENCRYPT_EMAIL -b"<LETSENCRYPT_EMAIL, eg me@example.com>"
+gh secret set CR_PAT -b"<CR_PAT, Container Registry Personal Access Token>"
+gh secret set DEPLOY_HOST -b"<DEPLOY_HOST, domain or subdomain for your application and server host.>"
+gh secret set DEPLOY_PORT -b"<DEPLOY_PORT, eg SSH port, usually 22>"
+gh secret set DEPLOY_USERNAME -b"<DEPLOY_USERNAME, the username being logged into via SSH. Eg, `ubuntu`, `ec2-user`, `root` etc.>"
+gh secret set DEPLOY_KEY -b"<DEPLOY_KEY, SSH private key used to remotely access deploy server/app host.>"
+gh secret set LETSENCRYPT_EMAIL -b"<LETSENCRYPT_EMAIL, Email address for your TLS certificate generation, eg me@example.com>"
 ```
 
 These secrets are used to populate variables within GitHub Actions and other configuration files.
 
-For the AWS access, a separate user specifically for deploying via GitHub Actions should be used.
-
-The policies required for the complete initial setup will be:
-- `AmazonEC2ContainerRegistryFullAccess`
-- `AmazonECS_FullAccess`
-
-Once the application is successfully deployed the first time, reduced access for both ECR and ECS can be used instead. For application updates, the GitHub Action can use the following policy.
-
-```json
-{
-  "Version": "2012-10-17",
-  "Statement": [
-    {
-      "Sid": "VisualEditor0",
-      "Effect": "Allow",
-      "Action": [
-        "ecr:GetRegistryPolicy",
-        "ecr:PutImageTagMutability",
-        "ecr:GetDownloadUrlForLayer",
-        "ecr:DescribeRegistry",
-        "ecr:GetAuthorizationToken",
-        "ecr:ListTagsForResource",
-        "ecr:UploadLayerPart",
-        "ecr:ListImages",
-        "ecr:PutImage",
-        "ecr:UntagResource",
-        "ecr:BatchGetImage",
-        "ecr:CompleteLayerUpload",
-        "ecr:DescribeImages",
-        "ecr:TagResource",
-        "ecr:DescribeRepositories",
-        "ecr:InitiateLayerUpload",
-        "ecr:BatchCheckLayerAvailability",
-        "ecr:ReplicateImage",
-        "ecr:GetRepositoryPolicy",
-        "ecs:SubmitTaskStateChange",
-        "ecs:UpdateContainerInstancesState",
-        "ecs:RegisterContainerInstance",
-        "ecs:DescribeTaskDefinition",
-        "ecs:DescribeClusters",
-        "ecs:ListServices",
-        "ecs:UpdateService",
-        "ecs:ListTasks",
-        "ecs:ListTaskDefinitionFamilies",
-        "ecs:RegisterTaskDefinition",
-        "ecs:SubmitContainerStateChange",
-        "ecs:StopTask",
-        "ecs:DescribeServices",
-        "ecs:ListContainerInstances",
-        "ecs:DescribeContainerInstances",
-        "ecs:DeregisterContainerInstance",
-        "ecs:TagResource",
-        "ecs:DescribeTasks",
-        "ecs:UntagResource",
-        "ecs:ListTaskDefinitions",
-        "ecs:ListClusters"
-      ],
-      "Resource": "*"
-    }
-  ]
-}
-```
-> Further permission reduction can be done by reducing what resources can be accessed.
-> Application permissions can be controlled via `taskRoleArn`, see [AWS docs for details](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html).
-
-## What's the process of the `release.yml`?
+## What's the process of `release.yml`?
 
-![](https://raw.githubusercontent.com/ServiceStack/docs/master/docs/images/mix/release-ecr-aws-diagram.png)
+![](https://raw.githubusercontent.com/ServiceStack/docs/master/docs/images/mix/release-ghr-vanilla-diagram.png)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -1,94 +1,82 @@
-name: Release Server
+name: Release
 on:
   release:
     types: [published]
 jobs:
-  push_to_ecr:
+  push_to_registry:
     runs-on: ubuntu-20.04
     steps:
-      - name: Checkout
+      - name: checkout
         uses: actions/checkout@v2
-
+          
       - name: repository name fix
         run: echo "image_repository_name=$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
-
-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v1
+      
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v1
         with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ${{ secrets.AWS_REGION }}
-
-      - name: Login to Amazon ECR
-        id: login_ecr
-        uses: aws-actions/amazon-ecr-login@v1
-
-      - name: Create ECR repo if not exists.
-        env:
-          ECR_REPOSITORY: ${{ env.image_repository_name }}
-        run: aws ecr describe-repositories --repository-names ${ECR_REPOSITORY} || aws ecr create-repository --repository-name ${ECR_REPOSITORY}
-
-      - name: Build and push to ECR
-        id: push_image_to_ecr
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.CR_PAT }}
+      
+      - name: Build and push Docker images
         uses: docker/build-push-action@v2.2.2
         with:
           file: Dockerfile
           context: .
           push: true
-          tags: ${{ steps.login_ecr.outputs.registry }}/${{ env.image_repository_name }}:${{ github.event.release.tag_name }}
-
-  deploy_ecs:
-    needs: push_to_ecr
+          tags: ghcr.io/${{ env.image_repository_name }}:${{ github.event.release.tag_name }}
+  
+  deploy_via_ssh:
+    needs: push_to_registry
     runs-on: ubuntu-20.04
     steps:
       - name: checkout
         uses: actions/checkout@v2
 
-      - name: Configure AWS credentials
-        uses: aws-actions/configure-aws-credentials@v1
-        with:
-          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          aws-region: ${{ secrets.AWS_REGION }}
-
-      - name: Login to Amazon ECR
-        id: login_ecr
-        uses: aws-actions/amazon-ecr-login@v1
-
-      - name: Repository name fix and env values setup
+      - name: repository name fix and env
         run: |
           echo "image_repository_name=$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
-          echo "domain=${{ secrets.HOST_DOMAIN }}" >> $GITHUB_ENV
+          echo "domain=${{ secrets.DEPLOY_HOST }}" >> $GITHUB_ENV
           echo "letsencrypt_email=${{ secrets.LETSENCRYPT_EMAIL }}" >> $GITHUB_ENV
-          echo "app_name=$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]' | tr -d . | cut -d'/' -f2)" >> $GITHUB_ENV
-          echo "cluster_name=${{ secrets.AWS_ECS_CLUSTER }}" >> $GITHUB_ENV
-          echo "image_url=${{ steps.login_ecr.outputs.registry }}/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]'):${{ github.event.release.tag_name }}" >> $GITHUB_ENV
-          echo "aws_region=${{ secrets.AWS_REGION }}" >> $GITHUB_ENV
 
-      - name: Populate task definition template
+      - name: docker-compose file prep
         uses: danielr1996/envsubst-action@1.0.0
         env:
           RELEASE_VERSION: ${{ github.event.release.tag_name }}
-          APP_NAME: ${{ env.app_name }}
-          IMAGE_URL: ${{ env.image_url }}
+          IMAGE_REPO: ${{ env.image_repository_name }}
           HOST_DOMAIN: ${{ env.domain }}
           LETSENCRYPT_EMAIL: ${{ env.letsencrypt_email }}
-          AWS_REGION: ${{ env.aws_region }}
-          CLUSTER_NAME: ${{ env.cluster_name }}
         with:
-          input: deploy/task-definition-template.json
-          output: deploy/task-definition.json
+          input: deploy/docker-compose-template.yml
+          output: deploy/NextJsTemplateApi-docker-compose.yml
 
-      - name: Create task definition if doesn't exist
-        run: aws ecs describe-task-definition --task-definition ${{ env.app_name }} || aws ecs register-task-definition --cli-input-json file://deploy/task-definition.json
+      - name: copy compose file via scp
+        uses: appleboy/scp-action@v0.1.1
+        with:
+          host: ${{ secrets.DEPLOY_HOST }}
+          username: ${{ secrets.DEPLOY_USERNAME }}
+          port: ${{ secrets.DEPLOY_PORT }}
+          key: ${{ secrets.DEPLOY_KEY }}
+          source: "deploy/NextJsTemplateApi-docker-compose.yml"
+          target: "~/"
 
-      - name: Create ECS Service if not exists.
-        run: aws ecs describe-services --cluster ${{ env.cluster_name }} --services ${{ env.app_name }} | jq '.services[0]' -e || aws ecs create-service --cluster ${{ env.cluster_name }} --service-name ${{ env.app_name }} --task-definition ${{ env.app_name }} --desired-count 1
+      - name: Set the value
+        run: |
+          echo "GH_TOKEN=${{ secrets.CR_PAT }}" >> $GITHUB_ENV
+          echo "USERNAME=${{ secrets.DEPLOY_USERNAME }}" >> $GITHUB_ENV
 
-      - name: Deploy new revision of the task definition
-        uses: aws-actions/amazon-ecs-deploy-task-definition@v1
+      - name: remote docker-compose up via ssh
+        uses: appleboy/ssh-action@v0.1.4
+        env:
+          APPTOKEN: ${{ env.GH_TOKEN }}
+          USERNAME: ${{ env.USERNAME }}
         with:
-          task-definition: deploy/task-definition.json
-          service: ${{ env.app_name }}
-          cluster: ${{ env.cluster_name }}
-          force-new-deployment: true
+          host: ${{ secrets.DEPLOY_HOST }}
+          username: ${{ secrets.DEPLOY_USERNAME }}
+          key: ${{ secrets.DEPLOY_KEY }}
+          port: ${{ secrets.DEPLOY_PORT }}
+          envs: APPTOKEN,USERNAME
+          script: |
+            echo $APPTOKEN | docker login ghcr.io -u $USERNAME --password-stdin
+            docker-compose -f ~/deploy/NextJsTemplateApi-docker-compose.yml up -d
diff --git a/deploy/docker-compose-template.yml b/deploy/docker-compose-template.yml
@@ -0,0 +1,12 @@
+version: "3.9"
+services:
+  NextJsTemplateApi:
+    image: ghcr.io/${IMAGE_REPO}:${RELEASE_VERSION}
+    restart: always
+    network_mode: bridge
+    ports:
+      - "80"
+    environment:
+      VIRTUAL_HOST: ${HOST_DOMAIN}
+      LETSENCRYPT_HOST: ${HOST_DOMAIN}
+      LETSENCRYPT_EMAIL: ${LETSENCRYPT_EMAIL}
diff --git a/deploy/nginx-proxy-compose.yml b/deploy/nginx-proxy-compose.yml
@@ -0,0 +1,40 @@
+version: '2'
+
+services:
+  nginx-proxy:
+    image: jwilder/nginx-proxy
+    container_name: nginx-proxy
+    restart: always
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - conf:/etc/nginx/conf.d
+      - vhost:/etc/nginx/vhost.d
+      - html:/usr/share/nginx/html
+      - dhparam:/etc/nginx/dhparam
+      - certs:/etc/nginx/certs:ro
+      - /var/run/docker.sock:/tmp/docker.sock:ro
+    network_mode: bridge
+
+  letsencrypt:
+    image: jrcs/letsencrypt-nginx-proxy-companion:2.0
+    container_name: nginx-proxy-le
+    restart: always
+    environment:
+      - DEFAULT_EMAIL=you@example.com
+    volumes_from:
+      - nginx-proxy
+    volumes:
+      - certs:/etc/nginx/certs:rw
+      - acme:/etc/acme.sh
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    network_mode: bridge
+
+volumes:
+  conf:
+  vhost:
+  html:
+  dhparam:
+  certs:
+  acme:
