在K8s集群Jenkins多分支流水线中缓存~/.npm目录的方法

针对你在Kubernetes上运行Jenkins多分支流水线、使用自定义Node镜像的场景，下面提供两种可靠的~/.npm缓存配置方案：

方案一：使用Pipeline Cache Plugin（推荐，分支隔离性好） #

这个插件会自动管理缓存的创建、复用和清理，适合多分支场景，避免不同分支依赖互相干扰。

1. 前置准备：确保Jenkins已安装Pipeline Cache Plugin（在Jenkins插件市场搜索安装）。
2. Jenkinsfile配置示例：

pipeline {
  agent {
    kubernetes {
      image 'your-custom-node-image:tag' // 替换为你的自定义Node镜像
      resourceLimit cpu: '1', memory: '1Gi' // 根据需求调整资源限制
    }
  }
  stages {
    stage('Install Dependencies') {
      steps {
        // 缓存~/.npm目录，key基于package-lock.json的校验和
        cache(path: '~/.npm', key: "npm-{{ checksum 'package-lock.json' }}", restoreKeys: ['npm-']) {
          sh 'npm install'
        }
      }
    }
    // 后续的构建、测试、部署阶段...
  }
}

• 关键说明：
  • key用package-lock.json的校验和生成，只有当依赖锁文件变更时，才会重新生成缓存，保证缓存有效性。
  • restoreKeys设置为['npm-']，当当前key的缓存不存在时，会尝试复用最近的同前缀缓存，提升缓存命中率。
  • 如果你的镜像使用非root用户（比如node用户），需将path改为对应用户的npm目录，比如/home/node/.npm。

方案二：使用Kubernetes PVC持久化缓存（适合跨任务共享） #

如果需要在同项目的多分支间共享npm缓存（减少重复下载），可以用Kubernetes的Persistent Volume Claim做持久化挂载。

1. 创建PVC：在Jenkins所在的Kubernetes命名空间下创建PVC YAML：

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: jenkins-npm-cache-pvc
  namespace: jenkins # 替换为你的Jenkins命名空间
spec:
  accessModes:
    - ReadWriteMany # 支持多个Jenkins Agent Pod同时读写
  resources:
    requests:
      storage: 10Gi # 根据缓存需求调整容量
  storageClassName: your-storage-class # 替换为集群可用的存储类

执行kubectl apply -f npm-cache-pvc.yaml完成创建。

2. Jenkinsfile配置挂载：

pipeline {
  agent {
    kubernetes {
      image 'your-custom-node-image:tag'
      resourceLimit cpu: '1', memory: '1Gi'
      // 挂载PVC到npm目录
      volumeMounts {
        volumeMount(mountPath: '/root/.npm', name: 'npm-cache')
      }
      volumes {
        persistentVolumeClaim(claimName: 'jenkins-npm-cache-pvc', name: 'npm-cache')
      }
    }
  }
  stages {
    stage('Install Dependencies') {
      steps {
        sh 'npm install'
        // 可选：定期清理过期缓存，避免占用过多空间
        // sh 'npm cache clean --force'
      }
    }
    // 后续阶段...
  }
}

• 注意事项：
  • 若使用非root用户，需调整mountPath到对应用户的home目录，并确保PVC的文件权限对该用户开放。
  • 共享缓存可能导致不同分支的依赖冲突，建议仅在分支依赖差异较小时使用，或定期清理缓存。

内容的提问来源于stack exchange，提问作者Ravi Kyada