Added deployment pipeline and documentation

Author: Abdullahxz

.github/workflows/cicd.yaml

@@ -0,0 +1,69 @@
+name: CI/CD
+
+on:
+  push:
+    branches:
+      - 'develop'
+
+jobs:
+  CI:
+    name: Build and Push Docker image
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Include unit tests here
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          push: true
+          tags: abdullahxy/goapp:latest
+
+  CD:
+    name: Deploy API
+    needs:
+      - CI
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Deploy EC2
+        run: |
+          echo "SSH into server or bastion client... "
+          echo "docker stop goapp"
+          echo "docker rm goapp"
+          echo "docker pull abdullahxy/goapp:latest"
+          echo "docker run -d --name goapp -p 3000:80 abdullahxy/goapp:latest"
+          echo "docker image rm abdullahxy/goapp:latest"
+
+      - name: Deploy Kubernetes
+        run: |
+          echo "helm repo add go-application <link to helm chart>"
+          echo "helm repo update"
+          echo "Set up kube config... "
+          echo "helm upgrade --install --atomic --cleanup-on-fail --wait --timeout 600s
+                <k8s deployment name>  \
+                --namespace=<k8s namespace name> \
+                --set image=abdullahxy/goapp:latest \
+                go-application\go-app"
+
+  Health-Check:
+    name: Deploy API
+    needs:
+      - CD
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Ping API
+        run: |
+          echo "Make an HTTP request to health check path using curl or any other utility... "
+          echo "If response in 2xx range do nothing else return non zero exit code"
+          echo "As non zero exit code will fail this job hence pipeline fails"

Dockerfile

@@ -0,0 +1,13 @@
+FROM golang:1.20
+
+WORKDIR /app
+
+COPY go.mod go.sum ./
+
+RUN go mod download
+
+COPY * ./
+
+RUN CGO_ENABLED=0 GOOS=linux go build -o /web-server
+
+CMD ["/web-server"]

README.md

@@ -11,6 +11,29 @@ Direct Dependencies:
 - Bcrypy
 - Golang-jwt
 
+## CI/CD architecture
+
+Platform: Github Actions
+
+The pipeline is triggered by a push commit in `develop` branch. This includes the PRs merged into the branch. `develop` branch is a protected branch also known as the integration branch. All feature branches should be checked out and merged back from `develop` branch after being tested and approved by the relevent code owners. Currently CI/CD setup performs the following steps:
+
+### CI
+- Checkout repository
+- Perform unit testing and linting (no unit tests in project as of this moment)
+- Login to Docker Hub
+- Builds Docker image using approved code
+- Pushes Docker image to docker hub
+
+### CD
+- Deploy to EC2 (Explained all the steps, Does not actually deploy)
+- Deploy to Kubernetes (Explained all the steps, Does not actually deploy)
+
+### Health check
+- Make an HTTP request to health check url using curl or any other utility
+- If response is in 2xx range then returns 0 else return non zero exit code
+- As non zero exit code will fail this job hence pipeline fails
+
+
 ## Routes
 
 ### 1. /ping

docker-compose.yaml

@@ -0,0 +1,17 @@
+version: '3.7'
+
+services:
+  api:
+    build:
+      context: .
+    env_file: .env
+    depends_on:
+      - postgresql
+    ports:
+      - "3000:3000"
+
+  postgresql:
+    image: postgres:12.4-alpine
+    env_file: .env
+    expose:
+      - "5432"