Feature/lab10

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+## Goal
+<!-- What does this PR accomplish? 1 sentence. -->
+
+Complete lab 3 DevOps
+
+## Changes
+* Added submissions/lab3.md
+* Create GitHub Action CI Workflows
+* Added Go environment ubuntu 24.04
+
+## Testing
+<!-- How did you verify it? -->
+* Start CI action on GitHub and green CI run
+* Verfied CI run pipeline
+
+## Checklist
+- ☑️ Title is a clear sentence (≤ 70 chars)
+- ☑️ Vet, Test, and Lint checks pass
+- ☑️ `submissions/lab3.md` updated

.github/workflows/ci.yml

@@ -0,0 +1,83 @@
+name: PR Gate
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'app/**'
+      - '.github/workflows/ci.yml'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'app/**'
+      - '.github/workflows/ci.yml'
+
+permissions:
+  contents: read   # минимальные права
+
+jobs:
+  # ---------- vet ----------
+  vet:
+    name: go vet
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        go-version: [ '1.23', '1.24' ]
+      fail-fast: false
+    defaults:
+      run:
+        working-directory: app
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+      - name: Setup Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32  # v5.3.0
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+      - name: Run go vet
+        run: go vet ./...
+
+  # ---------- test ----------
+  test:
+    name: go test -race
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        go-version: [ '1.23', '1.24' ]
+      fail-fast: false
+    defaults:
+      run:
+        working-directory: app
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+      - name: Setup Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32  # v5.3.0
+        with:
+          go-version: ${{ matrix.go-version }}
+          cache: true
+      - name: Run tests with race detector
+        run: go test -race -count=1 ./...
+
+  # ---------- lint ----------
+  lint:
+    name: golangci-lint
+    runs-on: ubuntu-24.04
+    defaults:
+      run:
+        working-directory: app
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683  # v4.2.2
+      - name: Setup Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32  # v5.3.0
+        with:
+          go-version: '1.24'      # достаточно одной версии для линтера
+          cache: true
+      - name: Install golangci-lint v2.5.0
+        run: |
+          curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | \
+            sh -s -- -b $(go env GOPATH)/bin v2.5.0
+      - name: Run golangci-lint
+        run: golangci-lint run ./...

.github/workflows/release.yml

@@ -0,0 +1,51 @@
+name: Release to GitHub Container Registry
+
+on:
+  push:
+    tags:
+      - 'v*'  # Triggers on tags like v0.1.0, v1.2.3, etc.
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}/quicknotes
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write  # Minimum required scope for pushing to ghcr.io
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3.7.1
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@369eb591f10d871d5d1e7e7e6a5d7a3bc63f3b4c # v5.6.1
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+            type=raw,value=latest,enable={{is_default_branch}}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@48aba3b46d1b1fec4febb7c5d0c644b249a11355 # v6.10.0
+        with:
+          context: ./app
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

ansible/inventory.ini

@@ -0,0 +1,2 @@
+[quicknotes_vm]
+quicknotes-vm ansible_host=127.0.0.1 ansible_port=2222 ansible_user=vagrant ansible_private_key_file=~/.vagrant.d/insecure_private_key ansible_ssh_extra_args="-o StrictHostKeyChecking=no"

ansible/playbook.yaml

@@ -0,0 +1,65 @@
+---
+- name: Deploy QuickNotes to Lab 5 VM
+  hosts: quicknotes_vm
+  become: true
+  gather_facts: true
+
+  vars:
+    app_user: quicknotes
+    app_data_dir: /var/lib/quicknotes
+    app_binary_path: /usr/local/bin/quicknotes
+    app_listen_addr: ":9090"
+    app_data_path: "{{ app_data_dir }}/data.db"
+    app_seed_path: "{{ app_data_dir }}/seed.json"
+
+  tasks:
+    - name: Create quicknotes system user
+      ansible.builtin.user:
+        name: "{{ app_user }}"
+        system: true
+        shell: /usr/sbin/nologin
+        home: "{{ app_data_dir }}"
+        create_home: false
+
+    - name: Ensure data directory exists
+      ansible.builtin.file:
+        path: "{{ app_data_dir }}"
+        state: directory
+        owner: "{{ app_user }}"
+        group: "{{ app_user }}"
+        mode: '0750'
+
+    - name: Copy QuickNotes binary
+      ansible.builtin.copy:
+        src: files/quicknotes
+        dest: "{{ app_binary_path }}"
+        mode: '0755'
+        owner: root
+        group: root
+      notify: restart quicknotes
+
+    - name: Render systemd unit file
+      ansible.builtin.template:
+        src: templates/quicknotes.service.j2
+        dest: /etc/systemd/system/quicknotes.service
+        owner: root
+        group: root
+        mode: '0644'
+      notify: restart quicknotes
+
+    - name: Reload systemd daemon
+      ansible.builtin.systemd:
+        daemon_reload: true
+
+    - name: Enable and start QuickNotes service
+      ansible.builtin.systemd:
+        name: quicknotes
+        enabled: true
+        state: started
+
+  handlers:
+    - name: restart quicknotes
+      ansible.builtin.systemd:
+        name: quicknotes
+        state: restarted
+        daemon_reload: true

ansible/templates/quicknotes.service.j2

@@ -0,0 +1,18 @@
+[Unit]
+Description=QuickNotes Service
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+User={{ app_user }}
+Group={{ app_user }}
+WorkingDirectory={{ app_data_dir }}
+ExecStart={{ app_binary_path }}
+Restart=on-failure
+RestartSec=5
+Environment="ADDR={{ app_listen_addr }}"
+Environment="DATA_PATH={{ app_data_path }}"
+Environment="SEED_PATH={{ app_seed_path }}"
+
+[Install]
+WantedBy=multi-user.target

app/Dockerfile

@@ -0,0 +1,40 @@
+#---------- Builder stage ----------
+
+FROM golang:1.24-alpine AS builder
+
+# WorkDir
+
+WORKDIR /build
+
+# copy go.mod and run
+
+COPY go.mod ./
+RUN go mod download
+
+COPY . .
+
+
+# CGO_ENABLED=0 — disable CGO 
+# -ldflags='-s -w' — delete table symbol
+
+RUN CGO_ENABLED=0 GOOS=linux go build \
+    -ldflags='-s -w' \
+    -trimpath \
+    -o quicknotes .
+
+# -------------------- Runtime stage --------------------
+FROM gcr.io/distroless/static:nonroot
+
+# copy bin from builder-stage
+
+COPY --from=builder /build/quicknotes /quicknotes
+
+# UID 65532 in distroless/static:nonroot
+
+USER 65532:65532
+
+# port
+EXPOSE 8080
+
+# exec-form
+ENTRYPOINT ["/quicknotes"]

app/newfile.txt

@@ -0,0 +1 @@
+dsd

compose.yaml

@@ -0,0 +1,61 @@
+services:
+  quicknotes:
+    build:
+      context: ./app
+      dockerfile: Dockerfile
+    image: quicknotes:lab6
+    container_name: quicknotes
+    ports:
+      - "8080:8080"
+    volumes:
+      - quicknotes-data:/data
+    environment:
+      - ADDR=:8080
+      - DATA_PATH=/data/notes.json
+      - SEED_PATH=/data/seed.json
+    healthcheck:
+      test: ["CMD", "/quicknotes", "-healthcheck"]   # or ["CMD-SHELL", "wget -qO- http://localhost:8080/health"]
+      interval: 10s
+      timeout: 5s
+      retries: 3
+      start_period: 5s
+    restart: unless-stopped
+
+  prometheus:
+    image: prom/prometheus:v3.0.1
+    container_name: prometheus
+    volumes:
+      - ./monitoring/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml:ro
+    ports:
+      - "9090:9090"
+    depends_on:
+      quicknotes:
+        condition: service_healthy
+    networks:
+      - quicknotes-net
+
+  grafana:
+    image: grafana/grafana:13.0.0
+    container_name: grafana
+    volumes:
+      - ./monitoring/grafana/provisioning:/etc/grafana/provisioning:ro
+      - ./monitoring/grafana/provisioning/dashboards/golden-signals.json:/var/lib/grafana/dashboards/golden-signals.json:ro
+    ports:
+      - "3000:3000"
+    environment:
+      - GF_SECURITY_ADMIN_USER=admin
+      - GF_SECURITY_ADMIN_PASSWORD=securepassword123
+      - GF_INSTALL_PLUGINS=
+    depends_on:
+      - prometheus
+    networks:
+      - quicknotes-net
+
+networks:
+  quicknotes-net:
+    driver: bridge
+
+
+volumes:
+  quicknotes-data:
+    name: quicknotes-data