更新文档及k8s部署文件

rroy233 · rroy233 · commit ee2c461b4025 · 2025-05-08T18:24:56.000+08:00
diff --git a/.github/workflows/docker.yaml b/.github/workflows/docker.yaml
@@ -3,22 +3,23 @@ name: Docker Multi-Arch Release
 on:
   push:
     tags:
-      - '*'
+      - '*'  # 自动触发：任何 tag 推送都会触发
   workflow_dispatch:
     inputs:
       image_tag:
-        description: 'Docker image tag (e.g., v1.2.3)'
+        description: 'Image tag to use (e.g., v1.2.3)'
         required: true
         default: 'manual-latest'
-
-permissions:
-  contents: read
-  packages: write
+      push_latest:
+        description: 'Also tag and push as latest?'
+        required: false
+        default: 'true'
 
 jobs:
   docker:
-    name: Build and Push Docker Images
+    name: Build & Push Docker Images
     runs-on: ubuntu-latest
+
     steps:
       - name: Checkout source
         uses: actions/checkout@v3
@@ -29,7 +30,7 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
 
-      - name: Login to DockerHub
+      - name: Login to Docker Hub
         uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
@@ -49,25 +50,35 @@ jobs:
           username: ${{ secrets.ALI_USERNAME }}
           password: ${{ secrets.ALI_PASSWORD }}
 
-      - name: Normalize image tag
+      - name: Resolve tag
+        id: tag
         run: |
           if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
             echo "TAG=${{ github.event.inputs.image_tag }}" >> $GITHUB_ENV
+            echo "PUSH_LATEST=${{ github.event.inputs.push_latest }}" >> $GITHUB_ENV
           else
-            REF=${GITHUB_REF##*/}
-            SAFE_TAG=$(echo "$REF" | sed 's#[^a-zA-Z0-9_.-]#-#g')
-            echo "TAG=$SAFE_TAG" >> $GITHUB_ENV
+            TAG_NAME="${GITHUB_REF##*/}"
+            echo "TAG=${TAG_NAME}" >> $GITHUB_ENV
+            echo "PUSH_LATEST=true" >> $GITHUB_ENV
           fi
 
-      - name: Build and push multi-platform image
+      - name: Show resolved tags
+        run: |
+          echo "Resolved image tag: $TAG"
+          echo "Push latest: $PUSH_LATEST"
+
+      - name: Build and push Docker images
         uses: docker/build-push-action@v5
         with:
           context: .
           push: true
           platforms: linux/amd64,linux/arm64
           tags: |
-            ${{ secrets.DOCKERHUB_USERNAME }}/stickerdownloader:${{ env.TAG }}
+            docker.io/${{ secrets.DOCKERHUB_USERNAME }}/stickerdownloader:${{ env.TAG }}
             ghcr.io/${{ github.repository_owner }}/stickerdownloader:${{ env.TAG }}
             ${{ secrets.ALI_REGISTRY }}/${{ secrets.ALI_USERNAME }}/stickerdownloader:${{ env.TAG }}
+            ${{ env.PUSH_LATEST == 'true' && format('docker.io/{0}/stickerdownloader:latest', secrets.DOCKERHUB_USERNAME) || '' }}
+            ${{ env.PUSH_LATEST == 'true' && format('ghcr.io/{0}/stickerdownloader:latest', github.repository_owner) || '' }}
+            ${{ env.PUSH_LATEST == 'true' && format('{0}/{1}/stickerdownloader:latest', secrets.ALI_REGISTRY, secrets.ALI_USERNAME) || '' }}
           cache-from: type=gha
-          cache-to: type=gha,mode=max
+          cache-to: type=gha,mode=max
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -1,18 +1,6 @@
 version: "3.9"
 
 services:
-  app:
-    build: .
-    container_name: sticker_app
-    ports:
-      - "8080:8080"
-    volumes:
-      - ./config.yaml:/app/config.yaml           # 配置文件挂载
-      - ./storage:/app/storage                           # 存储卷挂载
-      - ./log:/app/log                                   # 日志目录挂载
-    depends_on:
-      - redis
-
   redis:
     image: redis:7
     container_name: sticker_redis
@@ -21,5 +9,15 @@ services:
     volumes:
       - redis_data:/data
 
+  app:
+    image: rroy233/stickerdownloader:latest
+    container_name: sticker_app
+    depends_on:
+      - redis
+    volumes:
+      - ./config.yaml:/app/config.yaml
+      - ./log:/app/log
+      - ./storage:/app/storage
+
 volumes:
   redis_data:
diff --git a/docs/docker.md b/docs/docker.md
@@ -0,0 +1,103 @@
+# 🐳 StickerDownloader Docker 部署教程（两种方式）
+
+StickerDownloader 应用，支持以下两种场景：
+
+1. **方式一**：使用 `docker-compose` 一键部署 Redis 和 App
+2. **方式二**：使用外部 Redis，仅运行 App 容器（连接宿主机或云端 Redis）
+
+---
+
+## 🧰 准备前提
+
+* 安装好 [Docker](https://docs.docker.com/get-docker/)
+* 安装好 [Docker Compose](https://docs.docker.com/compose/)
+* 克隆或下载本项目源代码
+* 将 `config.example.yaml` 修改为实际配置并命名为 `config.yaml`
+
+**镜像源选择**
+
+| 镜像仓库                      | 镜像地址格式                                                     |
+| ------------------------- |------------------------------------------------------------|
+| Docker Hub                | `docker.io/rroy233/stickerdownloader`                      |
+| GitHub Container Registry | `ghcr.io/rroy233/stickerdownloader`                       |
+| 阿里云镜像仓库                   | `registry.cn-guangzhou.aliyuncs.com/rroy233/stickerdownloader` |
+
+(本教程默认使用Docker Hub作为镜像仓库)
+
+---
+
+# ✅ 方式一：使用 Docker Compose 一键启动（含 Redis）
+
+---
+
+### 📄 1. 配置 config.yaml（Redis 使用内部服务）
+
+```yaml
+redis:
+  server: "redis"          # 对应 docker-compose 的 redis 服务名
+  port: "6379"
+  password: ""
+  tls: false
+  db: 0
+```
+
+---
+
+### 🧩 2. 修改默认的docker-compose.yml
+
+```yaml
+  app:
+    image: rroy233/stickerdownloader:latest   # 可替换镜像
+```
+
+---
+
+### ▶️ 3. 一键启动
+
+```bash
+docker-compose up --build -d
+```
+
+---
+
+# ✅ 方式二：使用外部 Redis，仅运行 App 容器
+
+---
+
+## 📄 1. 配置 config.yaml（连接外部 Redis）
+
+例如连接宿主机、云端或远程 Redis：
+
+```yaml
+redis:
+  server: "host.docker.internal"  # 宿主机 Redis (推荐 macOS/Windows/Linux)
+  # server: "172.17.0.1"          # Linux bridge 模式下宿主机 IP
+  # server: "rds.aliyuncs.com"    # 也可为云 Redis 地址
+  port: "6379"
+  password: ""
+  tls: false
+  db: 0
+```
+
+---
+
+## 🐳 2. 运行 App 镜像
+
+### 启动容器
+
+```bash
+docker run -d \
+  --name sticker_app \
+  -v $(pwd)/config.yaml:/app/config.yaml \
+  -v $(pwd)/log:/app/log \
+  -v $(pwd)/storage:/app/storage \
+  rroy233/stickerdownloader:latest
+```
+
+
+# 🧼 清理
+
+```bash
+docker-compose down -v     # 方式一
+docker rm -f sticker_app   # 方式二
+```
diff --git a/docs/k8s.md b/docs/k8s.md
@@ -0,0 +1,86 @@
+# ☸️ StickerDownloader Kubernetes 部署教程
+
+本教程将引导你将 StickerDownloader 和 Redis 部署到 Kubernetes 集群中，支持配置注入、持久化、自动重启与更新。
+
+---
+
+## 📁 一、准备配置文件 config.yaml
+
+### 1. 从 `config.example.yaml` 创建：
+
+```bash
+cp config.example.yaml config.yaml
+```
+
+### 2. 修改 Redis 地址为 Kubernetes 内部服务名：
+
+```yaml
+redis:
+  server: "redis"       # Redis Service 名称，Cluster 内 DNS 可解析
+  port: "6379"
+  password: ""
+  tls: false
+  db: 0
+```
+
+### 3. 创建 Secret 以挂载配置（推荐包含敏感信息如 token）：
+
+```bash
+kubectl create secret generic app-config \
+  --from-file=config.yaml=./config.yaml
+```
+
+> 📌 也可写为 YAML 文件形式或搭配 GitOps 工具（如 Kustomize、ArgoCD）
+
+---
+
+## 🔄 二、部署与管理
+
+### 启动部署：
+
+```bash
+kubectl apply -f k8s/*
+```
+
+### 更新配置：
+
+修改 `config.yaml` 后：
+
+```bash
+kubectl delete secret app-config
+kubectl create secret generic app-config --from-file=config.yaml=./config.yaml
+kubectl rollout restart deployment sticker-app
+```
+
+或使用 `kubectl patch` 替换 `configMap`/`secret` 内容。
+
+---
+
+## 🔁 三、更新镜像
+
+### 1. 修改 image tag 并更新：
+
+```yaml
+image: ghcr.io/rroy233/stickerdownloader:v1.2.3
+```
+
+然后：
+
+```bash
+kubectl apply -f k8s/app-deployment.yaml
+```
+
+### 2. 或自动触发滚动更新：
+
+```bash
+kubectl rollout restart deployment sticker-app
+```
+
+---
+
+## ✅ 四、验证运行状态
+
+```bash
+kubectl get pods
+kubectl logs -f deploy/sticker-app
+```
diff --git a/k8s/app-config.yaml b/k8s/app-config.yaml
diff --git a/k8s/app-deployment.yaml b/k8s/app-deployment.yaml
@@ -1,21 +1,19 @@
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
-  name: app-storage-pvc
+  name: log-pvc
 spec:
-  accessModes:
-    - ReadWriteOnce
+  accessModes: [ReadWriteOnce]
   resources:
     requests:
-      storage: 1Gi # 可更改
+      storage: 1Gi
 ---
 apiVersion: v1
 kind: PersistentVolumeClaim
 metadata:
-  name: app-log-pvc
+  name: storage-pvc
 spec:
-  accessModes:
-    - ReadWriteOnce
+  accessModes: [ReadWriteOnce]
   resources:
     requests:
       storage: 1Gi
@@ -37,34 +35,21 @@ spec:
       containers:
         - name: app
           image: rroy233/stickerdownloader:latest
-          ports:
-            - containerPort: 8080
           volumeMounts:
-            - name: config-volume
+            - name: config
               mountPath: /app/config.yaml
               subPath: config.yaml
-            - name: log-volume
+            - name: logs
               mountPath: /app/log
-            - name: storage-volume
+            - name: storage
               mountPath: /app/storage
       volumes:
-        - name: config-volume
-          configMap:
-            name: app-config
-        - name: log-volume
+        - name: config
+          secret:
+            secretName: app-config
+        - name: logs
           persistentVolumeClaim:
-            claimName: app-log-pvc
-        - name: storage-volume
+            claimName: log-pvc
+        - name: storage
           persistentVolumeClaim:
-            claimName: app-storage-pvc
----
-apiVersion: v1
-kind: Service
-metadata:
-  name: sticker-app
-spec:
-  selector:
-    app: sticker-app
-  ports:
-    - port: 8080
-      targetPort: 8080
+            claimName: storage-pvc
diff --git a/k8s/redis-deployment.yaml b/k8s/redis-deployment.yaml
