Merge pull request #18 from optiop/feature/linter

Add yaml linter to the CI pipeline

Author: mehr74

.github/workflows/docker-build-images.yaml

@@ -1,13 +1,15 @@
+---
 name: Docker build images
 
-on:
+on:                           # yamllint disable-line rule:truthy
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 env:
   AWS_REGION: eu-central-1
+  AWS_ROLE: arn:aws:iam::615677714887:role/postgres-grafana-on-ecs-role
 
 permissions:
   id-token: write
@@ -18,28 +20,30 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        image: [ 'grafana', 'postgres' ]
+        image: ['grafana', 'postgres']
     steps:
-    - uses: actions/checkout@v4
- 
-    - name: Set AWS credentials
-      uses: aws-actions/configure-aws-credentials@v4
-      with:
-        role-to-assume: arn:aws:iam::615677714887:role/postgres-grafana-on-ecs-role
-        aws-region: ${{ env.AWS_REGION }}
-
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
-    
-    - name: Login to Amazon ECR
-      id: login-ecr
-      uses: aws-actions/amazon-ecr-login@v2
-    
-    - name: Build, tag, and push docker image to Amazon ECR
-      uses: docker/build-push-action@v5
-      with:
-        context: ./src/${{ matrix.image }}
-        push: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-        tags: 615677714887.dkr.ecr.eu-central-1.amazonaws.com/postgres-grafana-on-ecs-${{ matrix.image }}-repo
-        cache-from: type=gha
-        cache-to: type=gha,mode=max
+      - uses: actions/checkout@v4
+
+      - name: Set AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ env.AWS_ROLE }}
+          aws-region: ${{ env.AWS_REGION }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Amazon ECR
+        id: login-ecr
+        uses: aws-actions/amazon-ecr-login@v2
+
+      - name: Build, tag, and push docker image to Amazon ECR
+        uses: docker/build-push-action@v5
+        with:
+          context: ./src/${{ matrix.image }}
+          push: ${{ github.event_name == 'push' &&
+                    github.ref == 'refs/heads/main' }}
+          tags: "615677714887.dkr.ecr.eu-central-1.amazonaws.com/\
+                postgres-grafana-on-ecs-${{ matrix.image }}-repo"
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

.github/workflows/linter.yaml

@@ -1,6 +1,7 @@
+---
 name: Linters and formatters
 
-on:
+on:                           # yamllint disable-line rule:truthy
   push:
     branches:
       - '**'
@@ -12,15 +13,22 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    - name: Terraform linter
-      run: |
-        terraform version
-        results=$(find . -type f -name "*.tf" ! -path "*/.terraform/*" -exec terraform fmt -check {} \;)
-        if [ -n "$results" ]; then
-          echo "Terraform files must be formatted with 'terraform fmt'. Please run 'terraform fmt' and commit the changes."
-          echo "$results"
-          exit 1
-        fi
+      - name: Terraform linter
+        run: |
+          terraform version
+          terraform fmt -check -recursive
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.9'
+
+      - name: Install yamllint
+        run: pip install yamllint
+
+      - name: YAML linter
+        run: |
+          yamllint --strict .

ops/repository/terraform.tfvars

@@ -1,8 +1,10 @@
 name                     = "postgres-grafana-on-ecs"
 github_owner             = "optiop"
 github_repo              = "postgres-grafana-on-ecs"
-github_oidc_provider_arn = 
-region                   = 
+github_oidc_provider_arn = ""
+region                   = "eu-central-1"
 tags = {
   "project"   = "Visualize Postgres data on Grafana running on ECS"
+  "owner"     = "Optiop Consulting Group"
+  "directory" = "optiop/blog"
 }

src/docker-compose.yaml

@@ -1,17 +1,18 @@
+---
 version: "3.8"
 
 services:
   grafana:
     build: ./grafana
     ports:
-      - 3000:3000 
+      - 3000:3000
     environment:
       - POSTGRES_HOST=postgres
       - POSTGRES_PORT=5432
       - POSTGRES_USER=postgres
       - POSTGRES_PASSWORD=postgres
       - POSTGRES_DB=postgres
-  
+
   postgres:
     build: ./postgres
     environment:

src/grafana/provisioning/dashboards/dashboards.yaml

@@ -1,11 +1,12 @@
+---
 apiVersion: 1
 
 providers:
-- name: 'default'
-  orgId: 1
-  folder: ''
-  type: file
-  disableDeletion: false
-  updateIntervalSeconds: 10 
-  options:
-    path: /etc/grafana/provisioning/dashboards
+  - name: 'default'
+    orgId: 1
+    folder: ''
+    type: file
+    disableDeletion: false
+    updateIntervalSeconds: 10
+    options:
+      path: /etc/grafana/provisioning/dashboards

src/grafana/provisioning/datasources/postgres.yaml

@@ -1,3 +1,4 @@
+---
 apiVersion: 1
 
 datasources:
@@ -9,10 +10,10 @@ datasources:
       password: ${POSTGRES_PASSWORD}
     jsonData:
       database: ${POSTGRES_DB}
-      sslmode: 'disable' # disable/require/verify-ca/verify-full
-      maxOpenConns: 100 # Grafana v5.4+
-      maxIdleConns: 100 # Grafana v5.4+
-      maxIdleConnsAuto: true # Grafana v9.5.1+
-      connMaxLifetime: 14400 # Grafana v5.4+
-      postgresVersion: 903 # 903=9.3, 904=9.4, 905=9.5, 906=9.6, 1000=10
+      sslmode: 'disable'
+      maxOpenConns: 100
+      maxIdleConns: 100
+      maxIdleConnsAuto: true
+      connMaxLifetime: 14400
+      postgresVersion: 903
       timescaledb: false