DevOps平台 GitLab 介绍

一、GitLab 的主要特点及核心功能

GitLab 是一款功能强大的开源 DevOps 平台，旨在提供从项目规划、代码管理、CI/CD (持续集成/持续交付)、安全扫描到监控的一体化解决方案。

主要特点：

• 全面的 DevOps 生命周期管理: GitLab 覆盖了软件开发的整个生命周期，包括需求管理、问题跟踪、代码版本控制、代码审查、自动化构建、测试、部署、安全扫描和监控。
• 强大的版本控制 (Git): GitLab 基于 Git，提供安全、可扩展的代码托管，支持分支管理、合并请求、代码审查等协作功能。
• 持续集成/持续交付 (CI/CD): GitLab CI/CD 是一个内置的强大工具，允许您通过 .gitlab-ci.yml 文件定义自动化构建、测试和部署流水线。
• 容器注册表 (Container Registry): GitLab 提供私有的 Docker 镜像仓库，方便您存储和管理 Docker 镜像。
• 软件包管理 (Package Registry): GitLab 支持多种软件包格式的存储和管理，例如 Maven、npm、PyPI、Composer 等。
• 安全和合规: GitLab 集成了静态代码分析 (SAST)、动态应用安全测试 (DAST)、依赖项扫描、容器扫描等安全工具，帮助您在开发过程中发现和修复安全漏洞。
• 问题跟踪和项目管理: GitLab Issues 提供灵活的问题跟踪、任务管理、看板等功能，方便团队协作和项目管理。
• 代码审查 (Merge Requests): GitLab 的合并请求功能支持内联评论、代码对比、批准流程等，促进高质量的代码审查。
• Wiki 和文档: 每个 GitLab 项目都提供 Wiki 功能，方便团队共享文档和知识。
• 可扩展性和高可用性: GitLab 支持多种部署架构，可以根据需求进行扩展，并提供高可用性配置选项。
• 活跃的社区和丰富的生态系统: GitLab 拥有庞大的开源社区，提供了丰富的文档、插件和集成。

核心功能：

• Git 代码托管: 安全可靠地存储和管理代码仓库。
• CI/CD 流水线: 自动化构建、测试和部署流程。
• 容器和软件包注册表: 存储和管理 Docker 镜像和各种软件包。
• 安全扫描: 自动化检测代码和依赖项中的安全漏洞。
• 问题跟踪和项目管理: 组织和跟踪任务、缺陷和需求。
• 代码审查: 促进团队协作和代码质量。

二、GitLab 的基础使用流程

本部分描述在 GitLab 服务已经运行的前提下，用户进行基本操作的流程。

1. 创建用户并登录:

   • 通过浏览器访问 GitLab 服务器的地址。
   • 如果是首次使用，可能需要创建一个管理员账户。否则，使用已有的用户名和密码登录。

2. 创建项目 (Repository):

   • 登录后，点击页面右上角的 “+” 图标，选择 “New project/repository”。
   • 您可以选择创建一个空项目、从模板创建项目或导入现有项目。
   • 填写项目名称、描述、可见性级别（Private, Internal, Public）等信息，然后点击 “Create project”。

3. 上传或创建代码:

   • 对于新创建的空项目，GitLab 会提供 Git 命令，指导您将本地代码仓库推送到 GitLab。例如：

     git init
     git remote add origin <GitLab 项目 URL>
     git add .
     git commit -m "Initial commit"
     git push -u origin main
     

   • 您也可以直接在 GitLab 的 Web 界面上创建新的文件或文件夹。

4. 进行版本控制和协作:

   • 使用标准的 Git 命令进行代码的提交、分支创建、合并等操作。
   • 在 GitLab 上创建新的分支 (Branch) 进行并行开发。
   • 发起合并请求 (Merge Request) 将您的分支合并到主分支 (例如 main 或 master)。
   • 在合并请求中进行代码审查，添加评论和讨论。

5. 使用 GitLab Issues 进行问题跟踪:

   • 在您的项目页面，点击 “Issues”。
   • 点击 “New issue” 创建一个新的问题或任务。
   • 填写标题、描述、指派负责人、设置里程碑、添加标签等信息。
   • 您可以在 Issues 中进行讨论、更新状态和跟踪进度。

6. 配置 CI/CD 流水线:

   • 在您的项目根目录下创建一个名为 .gitlab-ci.yml 的文件。
   • 在该文件中定义您的 CI/CD 流水线，包括不同的阶段 (stages)，例如 build、test、deploy，以及每个阶段需要执行的脚本 (script)。
   • GitLab 会自动检测到 .gitlab-ci.yml 文件，并在代码提交、合并请求等事件发生时触发流水线。
   • 您可以在 GitLab 的 “CI/CD” -> “Pipelines” 页面查看流水线的执行状态和日志。

   一个简单的 .gitlab-ci.yml 示例：

   stages:
     - build
     - test
   
   build-job:
     stage: build
     script:
       - echo "Building the project..."
       - # 在这里执行您的构建命令，例如 make 或 mvn compile
   
   test-job:
     stage: test
     script:
       - echo "Running tests..."
       - # 在这里执行您的测试命令，例如 make test 或 mvn test
   

7. 查看容器和软件包注册表 (如果启用):

   • 如果您的项目启用了容器注册表或软件包注册表，您可以在项目页面的 “Deploy” -> “Container Registry” 或 “Package Registry” 中查看和管理您的镜像和软件包。

8. 使用 Wiki 进行文档编写:

   • 在您的项目页面，点击 “Wiki”。
   • 您可以创建新的 Wiki 页面，编写项目文档、协作指南等。

三、简单使用实例

假设我们有一个简单的 Python 项目，使用 pytest 进行单元测试，并且我们希望使用 GitLab CI/CD 自动化测试过程。

前提条件:

• 您已经在 GitLab 上创建了一个项目 (simple-python-project) 并将您的 Python 代码推送到了该项目。
• 您的 Python 项目包含一个 requirements.txt 文件列出依赖，以及使用 pytest 编写的测试文件。

步骤:

1. 在项目根目录下创建 .gitlab-ci.yml 文件:

   stages:
     - test
   
   test-job:
     stage: test
     image: python:3.9
     before_script:
       - pip install -r requirements.txt
       - pip install pytest
     script:
       - pytest
   

2. 提交并推送 .gitlab-ci.yml 文件到 GitLab:

   git add .gitlab-ci.yml
   git commit -m "Add GitLab CI configuration"
   git push origin main
   

3. 查看 CI/CD 流水线:

   • 在您的 GitLab 项目页面，导航到 “CI/CD” -> “Pipelines”。
   • 您应该会看到一个新的流水线正在运行或已经完成。
   • 点击该流水线可以查看详细的作业 (job)，在本例中是 test-job。
   • 点击 test-job 可以查看作业的日志输出，包括安装依赖和运行 pytest 的结果。

解释:

• 我们定义了一个名为 test 的阶段。
• 我们创建了一个名为 test-job 的作业，该作业属于 test 阶段。
• image: python:3.9 指定了运行该作业的 Docker 镜像为 Python 3.9。
• before_script 定义了在执行 script 之前需要运行的命令，这里是安装项目依赖和 pytest。
• script 定义了实际的测试命令，这里是运行 pytest。

每次您向 GitLab 仓库推送代码时，GitLab CI/CD 都会自动运行这个流水线，执行您的单元测试。您可以在 GitLab 的 Web 界面上方便地查看测试结果。您可以根据项目的复杂性添加更多的阶段和作业，例如构建、代码质量检查、部署等。