🪴qql1's digital garden

CI_CD

2分钟阅读

高级

梗概

  • Continuous Integration (CI): Automating the integration of code changes from multiple developers into a single codebase.
    • 不破坏原来可用的已有版本
    • 自动构建新的版本
      • 按照指定条件触发自动化脚本
        • 通常是代码提交触发webhook
      • 脚本中对代码继续测试、构建等步骤
  • Continuous Deployment (CD): Automating the deployment of code changes to production environments.These practices help improve efficiency, quality, and delivery in software development
    • 脚本执行部署步骤
      • 具体部署流程由具体部署的平台决定

CI系统工作流程

CI 系统（如 Jenkins、GitHub Actions、GitLab CI 等）通常执行以下工作：

  1. 拉取代码 - 从版本控制系统获取最新代码
  2. 编译构建 - 将源代码编译成可执行文件
  3. 运行测试 - 执行自动化测试确保代码质量
  4. 打包镜像 - 通常是 Docker 镜像，包含应用和运行环境
  5. 上传镜像到镜像仓库 - 存储构建产物供后续部署使用
  6. （可选）触发 CD 流程部署到 Kubernetes 集群

所以，CI 的输出是一个可以部署的”应用构建产物”，比如一个容器镜像。这个构建产物（Artifact）是整个 CI/CD 流程的核心输出。

基本概念

具体实现方案

实例

child::

示例

好的，下面我们以一个简单的 Node.js 应用为例，详细展示如何实现一个完整的 CI/CD 流程。包括代码库的配置、CI/CD 工具的使用以及自动化构建、测试和部署。

1. 初始化项目

首先，创建一个简单的 Node.js 项目。

mkdir my-node-app
cd my-node-app
npm init -y
npm install express

创建一个简单的 server.js 文件：

const express = require('express');
const app = express();
const port = 3000;
app.get('/', (req, res) => {
  res.send('Hello World!');
});
app.listen(port, () => {
  console.log(`Example app listening at http://localhost:${port}`);
});

2. 配置测试

安装 Jest 作为测试框架：

npm install jest --save-dev

在 package.json 中添加测试脚本：

"scripts": {
  "test": "jest"
}

创建一个简单的测试文件 app.test.js：

const request = require('supertest');
const express = require('express');
const app = express();
app.get('/', (req, res) => {
  res.send('Hello World!');
});
describe('GET /', () => {
  it('responds with Hello World!', done => {
    request(app)
      .get('/')
      .expect('Hello World!', done);
  });
});

3. 配置 GitHub Actions

在项目根目录下创建 .github/workflows 目录，并在其中创建 ci.yml 文件：

name: CI
on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'
    - name: Install dependencies
      run: npm install
    - name: Run tests
      run: npm test

4. 配置 GitLab CI/CD

如果你使用的是 GitLab，可以创建一个 .gitlab-ci.yml 文件：

stages:
  - build
  - test
  - deploy
build:
  stage: build
  script:
    - npm install
    - npm run build
test:
  stage: test
  script:
    - npm test
deploy:
  stage: deploy
  script:
    - echo "Deploying to production server"
    - npm run deploy
  only:
    - main

5. 自动部署

在 GitHub Actions 或 GitLab CI/CD 中配置部署步骤。

GitHub Actions 自动部署

在 ci.yml 文件中添加部署步骤：

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Set up Node.js
      uses: actions/setup-node@v2
      with:
        node-version: '14'
    - name: Install dependencies
      run: npm install
    - name: Run tests
      run: npm test
    - name: Deploy
      run: |
        echo "Deploying to production server"
        npm run deploy
      env:
        DEPLOYMENT_KEY: ${{ secrets.DEPLOYMENT_KEY }}

6. 持续监控

部署后，可以使用监控工具来监控应用的运行状态。

Prometheus 和 Grafana 配置

  1. 安装 Prometheus：
docker run -d --name=prometheus -p 9090:9090 prom/prometheus
  1. 安装 Grafana：
docker run -d --name=grafana -p 3000:3000 grafana/grafana
  1. 配置 Prometheus： 在 prometheus.yml 文件中添加抓取目标（如你的应用）：
scrape_configs:
  - job_name: 'my-node-app'
    static_configs:
      - targets: ['localhost:3000']
  1. 配置 Grafana：
    • 打开 Grafana，添加 Prometheus 作为数据源。
    • 创建仪表板，添加你需要监控的指标。 通过以上步骤，你可以创建一个完整的 CI/CD 流程，包括代码提交、自动化测试、自动化部署以及持续监控，确保你的应用始终处于最佳状态。
指向原始笔记的链接

关系图谱

反向链接