Refactor docs

add composes and docker registry

.gitea/workflows/ci.yml

@@ -0,0 +1,89 @@
+name: Docker Build and Push  # Имя CI джобы
+
+on:  # Выполняется если производится push в ветку main
+  push:
+    branches: [ main ]
+
+env: # Переменные окружения
+  REGISTRY: gitea.trastinfo.ru
+  IMAGE_NAME: sailor/mkdocs
+  PLATFORMS: linux/amd64,linux/arm64
+
+jobs: # Список выполняемых джоб
+  need-build: # джоба проверки изменений в зависимостях. Если requirements.txt был изменен, то будет выполнена сборка и пуш образа
+    runs-on: ubuntu-latest
+    outputs:
+      src_changed: ${{ steps.need-build.outputs.src }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dorny/paths-filter@v2
+        id: need-build
+        with:
+          filters: |
+            src:
+              - 'requirements.txt'
+              - 'dockerfile'
+
+  need-deploy: # джоба проверки изменений в файлах. При изменении пулит новые файлы и перезапускает контейнер
+    runs-on: ubuntu-latest
+    outputs:
+      src_changed: ${{ steps.need-deploy.outputs.src }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: dorny/paths-filter@v2
+        id: need-deploy
+        with:
+          filters: |
+            src:
+              - 'docs/*'
+              - 'mkdocs.yml'
+
+
+  build: # джоба сборки и пуша образа. Выполняется если проверка изменений показала что requirements.txt был изменен
+    needs: need-build
+    if: needs.need-build.outputs.src_changed == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Login to Gitea Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ secrets.REGISTRY_USERNAME }}
+          password: ${{ secrets.REGISTRY_TOKEN }}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push multi-arch image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: |
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
+            ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.sha }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+          
+  deploy:        
+    runs-on: ubuntu-latest
+    needs: need-deploy
+    if: needs.need-deploy.outputs.src_changed == 'true'
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+
+    - name: Deploy over SSH
+      uses: appleboy/ssh-action@v0.1.6
+      with:
+        host: ${{ secrets.HOST }}
+        username: ${{ secrets.USER }}
+        key: ${{ secrets.KEY }}
+        script: |
+          sudo docker run -p 8000:8000 gitea.trastinfo.ru/sailor/mkdocs:latest

.github/workflows/ci.yml

@@ -1,29 +0,0 @@
-name: ci 
-on:
-  push:
-    branches:
-      - master 
-      - main
-permissions:
-  contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
-      - uses: actions/cache@v4
-        with:
-          key: mkdocs-material-${{ env.cache_id }}
-          path: .cache
-          restore-keys: |
-            mkdocs-material-
-      - run: pip install -r requirements.txt
-      - run: mkdocs gh-deploy --force

compose.yaml

@@ -0,0 +1,6 @@
+services:
+  mkdocks:
+    image: gitea.trastinfo.ru/sailor/mkdocs:latest
+    restart: always
+    ports:
+      - "8000:8000"

dockerfile

@@ -1,4 +1,4 @@
-FROM docker.io/library/python:alpine
+FROM gitea.trastinfo.ru/sailor/pyhton:0.1
 WORKDIR /home/ubadmin/mkdocks
 COPY ./requirements.txt .
 RUN apk add --update --no-cache --virtual .build-deps gcc musl-dev &&\
@@ -6,7 +6,9 @@ RUN apk add --update --no-cache --virtual .build-deps gcc musl-dev &&\
     pip install --no-cache-dir --requirement ./requirements.txt &&\
     apk del .build-deps &&\
     rm ./requirements.txt
-WORKDIR /d
+WORKDIR /mkdocs
+COPY mkdocs.yml /mkdocs/mkdocs.yml
+COPY docs/* /mkdocs/docs/
 CMD ["mkdocs", "serve", "-a", "0.0.0.0:8000"]
 
 
@@ -16,4 +18,3 @@ CMD ["mkdocs", "serve", "-a", "0.0.0.0:8000"]
 
 
 
-

docs/Plans.md

@@ -1,10 +0,0 @@
-# Планы для Sailor.lab
-~~1) Развернуть vault~~
-2) Выбрать систему мониторинга
-3) Настроить бекапы
-4) Установить ubuntu на старый комп
-5) Подумать над переделкой шаблона as a service?
-6) Добавить диск и маунт диска для логов
-7) Настроить Vault
-8) Сделать дашборд для веб панелей
-9) Развернуть opensearch

docs/Welcome.md

@@ -1 +1,2 @@
 Стартовая страница
+1

docs/compose-files/mkdocs.yaml

@@ -0,0 +1,9 @@
+services:
+  mkdocks:
+    image: gitea.trastinfo.ru/sailor/mkdocs:latest
+    restart: always
+    volumes:
+      - ./mkdocs.yml:/mkdocs/mkdocs.yml
+      - ./docs:/mkdocs/docs
+    ports:
+      - "8000:8000"

docs/promts/opensearch.md

@@ -1,2 +0,0 @@
-Ты devops инженер. Твоя основная специальность это автоматизация и настройка серверов. 
-Ты занят настройкой opensearch.

docs/sailor-lab/scemas/scema-sailor-lab-components.puml

@@ -0,0 +1,12 @@
+@startuml
+top to bottom direction
+
+cloud "Интернет" as Internet
+
+rectangle "Proxy" as Proxy 
+rectangle "K8s" as K8s
+rectangle "Docker" as Docker
+Internet -- Proxy
+Proxy -- K8s
+Proxy -down- Docker
+@enduml

docs/sailor-lab/scemas/scema-vms.uml

@@ -0,0 +1,27 @@
+@startuml
+!theme bluegray
+
+title Схема доступа к VM через Proxy
+cloud "Интернет" as Internet
+node "Proxy" as proxy
+
+node "Master-1" as m1
+node "Master-2" as m2
+node "Master-3" as m3
+
+node "Worker-1" as w1
+node "Worker-2" as w2
+node "Worker-3" as w3
+
+node "Docker" as d1
+Internet -down- proxy
+proxy -down- m1
+proxy -down- m2
+proxy -down- m3
+
+proxy -down- w1
+proxy -down- w2
+proxy -down- w3
+
+proxy -down- d1
+@enduml

docs/sailor-lab/scemas/schema-kube.uml

@@ -0,0 +1,38 @@
+@startuml
+!theme bluegray
+
+title Схема Кластера Кубера
+
+node "Proxy" as proxy
+
+node "Мастер-ноды" {
+    [Master-1]
+    [Master-2]
+    [Master-3]
+}
+
+node "Воркер-ноды" {
+    [Worker-1]
+    [Worker-2]
+    [Worker-3]
+}
+
+
+
+proxy --> [Master-1]
+proxy --> [Master-2]
+proxy --> [Master-3]
+
+[Master-1] --> [Worker-1]
+[Master-1] --> [Worker-2]
+[Master-1] --> [Worker-3]
+[Master-2] --> [Worker-1]
+[Master-2] --> [Worker-2]
+[Master-2] --> [Worker-3]
+[Master-3] --> [Worker-1]
+[Master-3] --> [Worker-2]
+[Master-3] --> [Worker-3]
+
+
+
+@enduml

docs/sailor-lab/Архитектура.md

@@ -0,0 +1,21 @@
+# Архитектура моей лаборатории
+Моя лаборатория - это мой мини прокет по освоению новых для меня технологий.
+## На чем развернуто
+У меня есть 2 стенда:
+1) Домашний ПК
+2) Виртуалки в клауде
+Что дома, что в клауде используется Proxmox для виртуализации. Приложения разворачиваются в kubernetes. На отдельной ВМ крутятся БД. Стенды по содержанию идентичны
+Схема стенда ./docs/sailor-lab/scema-sailor-lab-components.puml
+Все виртуалки созданы Terraform через API Proxmox
+## Стек
+### Compute
+- K8s
+### Monitoring
+- Prometheus
+- Grafana
+### DevOps
+- Gitea
+### Backup
+- Restic
+### Docs
+- Mkdocs

docs/Заметки/gitea/registry.md

@@ -0,0 +1,24 @@
+# Registry and local push
+Gitea позволяет хранить свои образы контейнеров. Это позволяет не прибегать к dockerhub и не ставить еще и отдельную хранилку образов. Эта функция включена по умолчанию в новых версиях.
+Для того что бы запушить образ требуется авторизоваться в регистри. Для этого нам требуется сгенерить токен доступа для регистри.
+Что бы сгенерить токен переходим в настройки нашей Учетки (не репозитория) https://gitea.trastinfo.ru/user/settings/applications
+Далее нажимаем создать новый токен. Пишем имя токена и выбираем доступа для токена. Для пайплайна нам требуется доступ к чтению repository и чтение\запись к package (Это как раз и есть registry)
+Логинимся в gita
+```
+docker login gitea.trastinfo.ru --username sailor --password 5968ad45678afc6dc2f41b2ff389ca10fc982170
+```
+gitea.trastinfo.ru - Наша gitea
+--username sailor - Юзер под которым логинемся
+--password 5968ad45678afc6dc2f41b2ff389ca10fc982170 вместо пароля ставим токен, который мы сгенерили
+Собираем образ. Есть две особенности на которые надо обратить внимание:
+- Именование образов
+- слеш (/) при указании тега 
+Именование образов имеет формат {registry}/{owner}/{image}:{tag}
+
+```
+docker build -t gitea.trastinfo.ru/sailor/sailor-doc:0.01 -f dockerfile
+```
+После билда пушим образ 
+```
+docker push gitea.trastinfo.ru/sailor/sailor-doc:0.01
+```

docs/Заметки/proxy/NPM.md

@@ -0,0 +1,42 @@
+# NPM
+Краткая инструкция как поднять и настроить NPM
+Ссылки
+Гайд с оф сайта https://nginxproxymanager.com/guide/
+Гитхаб https://github.com/NginxProxyManager/nginx-proxy-manager
+Для начала заходим на сервак и ставим докер. 
+```
+curl https://get.docker.com | sh -
+```
+Далее создаем директорию под NPM. Директорию лучше не называть npm, что бы не путать с пакетным менджером
+```
+mkdir proxy && cd proxy
+```
+Создаем compose.yaml
+```
+nano compose.yaml
+```
+И записываем туда конфиг для композа
+```
+services:
+  app:
+    image: 'jc21/nginx-proxy-manager:2.15.1' #Можно посмотреть севужую версию на https://github.com/NginxProxyManager/nginx-proxy-manager
+    restart: unless-stopped
+    environment:
+      TZ: "Europe/Moscow"
+    ports:
+      - '80:80'
+      - '81:81' #Порт веб панели администратора, лучше поменять на свой
+      - '443:443'
+    volumes: #Директории для сертов и данных, создадутся в рабочем каталоге
+      - ./data:/data 
+      - ./letsencrypt:/etc/letsencrypt
+```
+Разрешаем трафик по этим портам
+```
+sudo iptables -A INPUT -p tcp -i eth0 --dport 80,443,81 -j ACCEPT
+```
+Поднимаем контейнер композом
+```
+docker compose up -d
+```
+Заходим в вебку админа по ip-server:81 и настраиваем учетку и тд.

k8s/mkdocs.yaml

@@ -0,0 +1,50 @@
+---
+apiVersion: v1
+kind: Namespace
+metadata:
+  name: mkdocs
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: sailor-mkdocs
+  labels:
+    app: sailor-mkdocs
+    service: sailor-mkdocs
+spec:
+  ports:
+  - name: http
+    port: 8080
+    targetPort: 8000
+  selector:
+    app: sailor-mkdocs
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: sailor-mkdocs
+  namespace: mkdocs
+spec:
+  replicas: 2
+  selector:
+    matchLabels:
+      app: sailor-mkdocs
+  template:
+    metadata:
+      labels:
+        app: sailor-mkdocs
+    spec:
+      nodeSelector:
+        kubernetes.io/hostname: worker-2
+      containers:
+      - name: mkdocs
+        image: gitea.trastinfo.ru/sailor/mkdocs:7c2e6b6ecc3e32e5e4f59e6628af0a87d3acb005
+        ports:
+        - containerPort: 8000
+        resources:
+          requests:
+            memory: "128Mi"
+            cpu: "100m"
+          limits:
+            memory: "256Mi"
+            cpu: "250m"

mkdocs.yml

@@ -18,12 +18,10 @@ theme:
   icon:
     repo: fontawesome/brands/github
   features:
-    - content.code.copy
+    - content.code.copy 
     - navigation.instant
     - navigation.instant.progress
     - navigation.sections
-#    - navigation.tabs
-#    - navigation.tabs.sticky
     - navigation.path
     - navigation.top
     - navigation.prune