yj-deploy 1.0.0 → 1.0.2

package/README.md

@@ -11,6 +11,8 @@
 - ✔ 支持灵活配置dockerfile，upload.sh等脚本内容
 - ✔ 支持多种方式配置 `镜像仓库` `镜像环境`等参数
 - ✔ 支持懒上传，仅上传新增部分文件，提升上传效率
+- ✔ 支持失败自动重新上传，支持配置次数，防止网络不稳定可能导致上传失败
+- ✔ 镜像推送成功支持自动重启服务，减少部署流程
 > 全程不需要连接跳板机做任何操作即可完成镜像推送
 
 ## 运行情况
@@ -74,7 +76,12 @@ const deploy = new yjDeploy({
       'echo "- 镜像环境: $2"',
       'docker build -t harbor.yunjingtech.cn:30002/$1/$tag .',
       'docker push harbor.yunjingtech.cn:30002/$1/$tag',
+      'if [ $? -eq 0 ];then',
+      'echo - 推送成功',
       'echo - 镜像地址: harbor.yunjingtech.cn:30002/$1/$tag',
+      'else',
+      'echo - 镜像推送失败，请重试或联系运维人员，如需查看全部docker日志，请在命令后添加 --allLog查看更多信息',
+      'fi',
     ]
   },
 
@@ -89,9 +96,49 @@ const deploy = new yjDeploy({
 
   allLog: false, // 是否打印所有log信息，主要是包含推送镜像阶段的日志，如果报错可以打开此开关
 
-  lazyUpload: false // 是否开启懒上传，针对小程序图片等仅需要部署新增部分文件的项目有奇效
+  lazyUpload: false, // 是否开启懒上传，针对小程序图片等仅需要部署新增部分文件的项目有奇效
+
+  rePushNum: 3, // 重新推送次数，为0代表不重新推送
+
+  // 自动重启服务的rancher配置
+  rancherConfig: {
+    token: '', // Rancher API 访问令牌 （必填）
+    namespace: '', // 服务所在的命名空间 （必填）
+    workload: '', // 服务名称 （必填）
+
+    // 非必填
+    baseUrl: '', // Rancher API 基础地址
+    clusterId: '', // Rancher 集群 ID
+  }
+}
+```
+
+
+## rancher配置说明
+需要自动重启服务时，必须配置如下内容，然后在命令后加上`--restart`即可启用自动重启功能（因为仅开发环境支持，所以启用命令只能通过加在命令行里）
+```js
+rancherConfig: {
+  token: '', // Rancher API 访问令牌 （必填）
+  namespace: '', // 服务所在的命名空间 （必填）
+  workload: '', // 服务名称 （必填）
+
+  // 非必填
+  baseUrl: '', // Rancher API 基础地址
+  clusterId: '', // Rancher 集群 ID
 }
 ```
+### token
+需要在rancher主页 -> 个人中心 -> API & Keys 内创建永久key，也可以复制其他已有项目里的token使用
+
+### namespace
+服务所在的命名空间 （必填）
+
+### workload
+服务名称 （必填）
+![服务名称](./img2.png)
+
+### baseUrl clusterId
+非必填，已默认配置为开发环境地址，除非运维更换rancher地址与集群id，否则不用配置
 
 <br />
 
@@ -248,6 +295,19 @@ node uploader.js --tmpName=test
 如果小程序修改了相同路径和文件名的文件，会存在无法判断的情况（使用hash值能判断，但是成本过高），这种情况请关掉此选项，或使用 --reset 重置项目
 :::
 
+### --restart
+`--restart` ：是否需要自动重启服务，加上此命令，且配置了rancherConfig，将会自动重启服务
+```javascript
+"scripts": {
+  // 开发环境
+  "deploy": "vite build --mode development -- --deploy --tmpName=dev --restart"
+}
+```
+
+::: warning
+仅对开发环境生效，并且需要先在rancher创建服务后方能成功
+:::
+
 
 <br />
 
@@ -260,6 +320,12 @@ node uploader.js --tmpName=test
 
 ## 升级日志
 
+### v0.0.9
+  支持自动重启服务，上传完后，可以根据配置自动重启rancher服务
+
+### v0.0.8
+  支持判断是否推送成功，如果推送失败，则自动重试三次，可以手动配置重试次数
+
 ### v0.0.6
   支持懒上传文件，大幅提升上传速度
 

package/lib/main.js

@@ -2,6 +2,8 @@ import { stdout } from 'single-line-log'
 import fs from 'fs'
 import path from 'path'
 import { Client } from 'ssh2'
+import axios from 'axios'
+import https from 'https'
 
 
 export default class yjDeploy {
@@ -39,7 +41,12 @@ export default class yjDeploy {
         'echo "- 镜像环境: $2"',
         'docker build -t harbor.yunjingtech.cn:30002/$1/$tag .',
         'docker push harbor.yunjingtech.cn:30002/$1/$tag',
+        'if [ $? -eq 0 ];then',
+        'echo - 推送成功',
         'echo - 镜像地址: harbor.yunjingtech.cn:30002/$1/$tag',
+        'else',
+        'echo - 镜像推送失败，请重试或联系运维人员，如需查看全部docker日志，请在命令后添加 --allLog查看更多信息',
+        'fi',
       ]
     },
 
@@ -54,7 +61,16 @@ export default class yjDeploy {
 
     allLog: false, // 是否显示全部日志
 
-    lazyUpload: false // 是否开启懒上传
+    lazyUpload: false, // 是否开启懒上传
+
+    rePushNum: 3, // 重新推送次数，为0代表不重新推送
+
+    // 仅能通过命令启用
+    rancherConfig: {
+      token: '', // Rancher API 访问令牌
+      namespace: '', // 服务所在的命名空间
+      workload: '', // 工作负载名称
+    }
   }
 
   ssh2Conn = null   
@@ -280,6 +296,10 @@ export default class yjDeploy {
    * @param {*} dir 
    */
   upLoadProject(sftp, dir) {
+    let rePushNum = 0 // 如果推送失败，是否开启重新推送，如果大于0 ，代表重新推送次数
+    if(typeof this.config.rePushNum === 'number' && this.config.rePushNum > 0) {
+      rePushNum = this.config.rePushNum
+    }
     sftp.readdir(dir, async (err) => {
       if (err) {
         // 不存在目录
@@ -438,14 +458,42 @@ export default class yjDeploy {
       const tmpName = this.getArgv('--tmpName') || this.config.tmpName
       shell += ` ${tmpName}`
 
-      const imagePath = await this.onShell(shell) // 推送镜像
-      console.log(imagePath) // 推送镜像脚本返回输出
-      console.log('- 镜像推送完成')
+      // 判断如果失败，是否需要多次重试
+      const pushShellList =  Array.from(new Array(rePushNum + 1)).map(() => this.onShell(shell))
+      await this.pushMirrorImage(pushShellList, pushShellList.length) // 开始推送镜像
 
       this.breakConnect()
     })
   }
 
+  // 推送镜像
+  async pushMirrorImage(shellList, totalNum) { 
+    if (shellList.length === 0) {
+      console.log('- 镜像推送失败，请添加 --allLog 查看全部日志')
+      return null
+    }
+
+    const result = await shellList[0]
+
+    if(!result.includes('- 镜像推送失败')) {
+      // 推送成功
+      console.log(result) // 推送镜像脚本返回输出
+      console.log('- 镜像推送结束')
+
+      if(this.getArgv('--restart') !== undefined) {
+        await restartService(result, this.config.rancherConfig)
+      }
+
+      return result
+    }
+    
+    console.log(result) // 失败日志
+    if(shellList.length >  1) {
+      console.log(`- 正在尝试第 ${(totalNum - shellList.length) + 1} 次推送...`)
+    }
+    return this.pushMirrorImage(shellList.slice(1), totalNum)
+  }
+
   /**
    * 获取脚本内容是不是自动创建的脚本
    * 兼容用户手动根据运维文档创建的推送脚本，因参数不同可能报错的问题
@@ -459,6 +507,11 @@ export default class yjDeploy {
         }
         
         const fileText = data.toString()
+
+        // 判断脚本是不是最新的支持异常提示脚本，自动重试的脚本
+        if(!fileText.includes('- 镜像推送失败')) {
+          console.log('\n- warning 检测到当前脚本可能不是最新版本，推送失败可能不会提示，且没有失败自动重试功能，请在命令后添加 --reset 重新生成脚本')
+        }
         resolve(fileText.includes('$2'))
       })
     })
@@ -558,3 +611,92 @@ export default class yjDeploy {
     return result
   }
 }
+
+const httpsAgent = new https.Agent({
+  rejectUnauthorized: false
+})
+
+const axiosInstance = axios.create({
+  proxy: false
+})
+
+async function restartService(imageData, config) {
+  try {
+    const localConfig = {
+      baseUrl: 'https://paas-test.ymygz.com:10443/v3',
+      clusterId: 'local:p-r7j28'
+    }
+
+    const rancherConfig = {
+      ...localConfig,
+      ...config
+    }
+
+    if (!rancherConfig.baseUrl) {
+      return console.error('- Rancher API 基础地址未配置，请检查 rancherConfig.baseUrl 是否正确')
+    }
+    if (!rancherConfig.token) {
+      return console.error('- Rancher API 访问令牌未配置，请检查 rancherConfig.token 是否正确')
+    }
+    if (!rancherConfig.clusterId) {
+      return console.error('- Rancher 集群 ID 未配置，请检查 rancherConfig.clusterId 是否正确')
+    }
+    if (!rancherConfig.namespace) {
+      return console.error('- 服务所在的命名空间未配置，请检查 rancherConfig.namespace 是否正确')
+    }
+    if (!rancherConfig.workload) {
+      return console.error('- 工作负载名称未配置，请检查 rancherConfig.workload 是否正确')
+    }
+    if (!imageData) {
+      return console.error('- 内部错误')
+    }
+
+    const match = imageData.match(/- 镜像地址:\s*(.+)/)
+    let imageAddress = ''
+    if (match && match[1]) {
+      imageAddress = match[1].trim()
+    } else {
+      return console.error('- 未提取到镜像地址')
+    }
+
+    console.log('- 开始调用 Rancher API 更新服务镜像地址')
+    const workloadUrl = `${rancherConfig.baseUrl}/projects/${rancherConfig.clusterId}/workloads/deployment:${rancherConfig.namespace}:${rancherConfig.workload}`
+    console.log('- 请求的工作负载 URL:', workloadUrl)
+
+    const response = await axiosInstance.get(workloadUrl, {
+      headers: { Authorization: `Bearer ${rancherConfig.token}` },
+      httpsAgent
+    })
+
+    if (!response.data || !response.data.containers || response.data.containers.length === 0) {
+      return console.error('- 未找到工作负载的容器信息，请检查 namespace 和 workload 是否正确')
+    }
+
+    const workload = response.data
+    workload.containers[0].image = imageAddress
+
+    await axiosInstance.put(workloadUrl, workload, {
+      headers: { Authorization: `Bearer ${rancherConfig.token}` },
+      httpsAgent
+    })
+
+    console.log('- 镜像地址更新成功，正在重启服务...')
+    await axiosInstance.post(
+      `${workloadUrl}?action=redeploy`,
+      {},
+      {
+        headers: { Authorization: `Bearer ${rancherConfig.token}` },
+        httpsAgent
+      }
+    )
+
+    console.log('- 服务重启成功')
+  } catch (error) {
+    console.error('- 调用 Rancher API 失败，请检查以下信息：')
+    console.error('  - 错误代码:', error.code)
+    console.error('  - 错误信息:', error.message)
+    console.error('  - 请求 URL:', error.config?.url)
+    console.error('  - 响应状态:', error.response?.status)
+    console.error('  - 响应数据:', error.response?.data)
+  }
+}

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "yj-deploy",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "ssh sftp",
   "type": "module",
   "scripts": {
-    "build": "vite build"
+    "build": "vite build",
+    "deploy": "node test.js --restart"
   },
   "files": [
     "lib",
@@ -16,6 +17,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "axios": "^1.13.5",
     "single-line-log": "^1.1.2",
     "ssh2": "^1.15.0"
   },