GitLab Docs
- Overview
- Popular topics
- The entire DevOps Lifecycle
- New to Git and GitLab?
- Coming to GitLab from another platform
- Build an integration with GitLab
- Contributing to GitLab
访问docs.gitlab.com,以获得优化的导航,可发现性和可读性.
GitLab Docs
欢迎使用GitLab文档.
在这里,您可以访问 GitLab 的完整文档,这是整个 DevOps 生命周期的单个应用程序.
Overview
无论您如何使用 GitLab,我们都会为您提供文档.
基本文件 | Essential documentation |
---|---|
用户文件 |
探索适用于 GitLab 用户的功能和概念. | 管理员文件 GitLab 自我管理管理员需要知道的一切. | | 为 GitLab 做贡献 在 GitLab,每个人都可以贡献力量! | 是 Git 和 GitLab 的新手吗? 我们有资源可以帮助您入门. | | 与 GitLab 建立整合? 请查阅我们的自动化和集成文档. | 从另一个平台进入 GitLab? 请查阅我们的便捷指南. | | 安装 GitLab 不同平台的安装选项. | 顾客 给新老客户的信息. | | 更新 GitLab 将您的 GitLab 自我管理实例更新到最新版本. | 参考架构 GitLab 的参考架构 | | GitLab 发布 GitLab 的新功能. | |
Popular topics
看看我们一些最受欢迎的主题:
热门话题 | Description |
---|---|
Two-factor authentication | 提高您的 GitLab 帐户的安全性. |
GitLab groups | 一起管理项目. |
GitLab CI/CD pipeline configuration reference | .gitlab-ci.yml 文件的可用配置选项. |
Activate GitLab EE with a license | 使用许可证激活 GitLab 企业版功能. |
Back up and restore GitLab | 用于备份和还原 GitLab 自管理实例的耙任务. |
GitLab release and maintenance policy | 版本命名和节奏策略以及升级建议. |
Elasticsearch integration | 将 Elasticsearch 与 GitLab 集成以启用高级搜索. |
Omnibus GitLab database settings | Omnibus GitLab 自我管理实例的数据库设置. |
Omnibus GitLab NGINX settings | Omnibus GitLab 自我管理实例的 NGINX 设置. |
Omnibus GitLab SSL configuration | Omnibus GitLab 自我管理实例的 SSL 设置. |
GitLab.com settings | 用于 GitLab.com 的设置. |
The entire DevOps Lifecycle
GitLab 是第一个用于软件开发,安全性和操作的单一应用程序,可启用并发 DevOps ,从而使软件生命周期更快并从根本上提高了业务速度.
GitLab 为DevOps 生命周期的每个阶段提供解决方案:
GitLab 就像制作软件的顶级厨房. 作为行政总厨,您可以决定要提供的软件. 使用您的食谱,GitLab 可以处理所有准备工作,烹饪和交付,因此您可以比以往更快地处理订单.
以下各节提供了每个 DevOps 阶段的文档链接:
DevOps 阶段 | 有关的文件 |
---|---|
Manage | 统计和分析功能. |
Plan | 项目计划和管理功能. |
Create | 源代码,数据创建和管理功能. |
Verify | 测试,代码质量和持续集成功能. |
Package | Docker 容器注册表. |
Release | 应用程序发布和交付功能. |
Configure | 应用程序和基础结构配置工具. |
Monitor | 应用程序监视和指标功能. |
Secure | 安全功能功能. |
Manage
GitLab 提供统计数据并深入了解您如何在组织中最大化 GitLab 的价值.
以下文档与 DevOps Manage阶段有关:
管理主题 | Description |
---|---|
[Authentication and |
Authorization](administration/auth/README.html) | 支持的身份验证和授权提供者. | | GitLab Value Stream Analytics | 测量您拥有的每个项目从构思到生产所需的时间. | | Instance Statistics | 查找有关您使用的 GitLab 功能数量和用户活动的统计信息. |
Plan
无论您使用 Waterfall,敏捷还是会话开发,GitLab 均可简化您的协作工作流程.
使用 GitLab 灵活的项目管理工具可视化,确定优先级,协调和跟踪进度.
以下文档与 DevOps 计划阶段有关:
计划主题 | Description |
---|---|
Burndown Charts | 在特定的里程碑中观察项目的进度. |
Discussions | 问题,提交和合并请求中的线程,注释和可解决线程. |
Due Dates | 跟踪发行期限. |
Epics | 跟踪共享主题的问题组. |
问题 ,包括机密问题 , |
发布和合并请求模板 , 和移动的问题 | 项目问题并限制对问题的访问,并创建用于提交新问题和合并请求的模板. 此外,在项目之间转移问题. | | Labels | 分类问题或使用描述性标签合并请求. | | Milestones | 设置发布问题和合并请求的里程碑,并带有可选的截止日期. | | Project Issue Board | 在 Scrum 或看板上显示问题. | | Quick Actions | 针对问题或合并请求的常见操作的快捷方式,而无需单击按钮或在 GitLab 的 UI 中使用下拉菜单. | | Related Issues | 在问题之间建立关系. | | Requirements Management | Check your products against a set of criteria. | | Roadmap | 可视化史诗般的时间表. | | Service Desk | 一种允许人们在不需要自己的用户帐户的情况下在您的 GitLab 实例中创建问题的简单方法. | | Time Tracking | 跟踪花费在问题和合并请求上的时间. | | Todos | 通过在简单仪表板上显示的时间顺序列表,跟踪需要注意的工作. |
Create
将源代码整合到一个易于管理和控制的分布式版本控制系统中 ,而不会中断您的工作流程.
GitLab 存储库随附分支工具和访问控制,可为项目和代码的协作提供可扩展的单一事实来源.
以下文档与 DevOps Create阶段有关:
Projects and Groups
创建主题-项目和组 | Description |
---|---|
Advanced global search | 利用 Elasticsearch 在整个 GitLab 实例上进行更快,更高级的代码搜索. |
Advanced syntax search | 使用高级查询获得更具针对性的搜索结果. |
Contribution analytics | 请参阅小组贡献者的详细统计信息. |
创建并派生项目,以及 |
进出口项目 实例之间 | 创建,复制和移动项目. | | File locking | 锁定文件以避免合并冲突. | | GitLab Pages | 使用 GitLab Pages 构建,测试和部署您的静态网站. | | Groups and Subgroups | 分组组织您的项目. | | Issues Analytics | 检查每月创建了多少个问题. | | 项目 ,包括项目访问 和设置 | 托管源代码,并控制项目的可见性和设置配置. | | Search through GitLab | 搜索问题,合并请求,项目,组和待办事项. | | Snippets | 片段使您可以创建一些代码. | | Web IDE | 在 GitLab 的用户界面中编辑文件. | | Static Site Editor | 在静态网站上编辑内容. | | Wikis | 使用内置的 Wiki 增强您的存储库文档. |
Repositories
创建主题-存储库 | Description |
---|---|
分支和默认分支 | 如何在 GitLab 中使用分支. |
Commits and signing commits | 处理提交,并使用 GPG 对您的提交进行签名. |
创建分支 , 创建 |
并上传文件,并创建目录 | 在 GitLab 中创建分支,创建和上传文件以及创建目录. |
| Delete merged branches | 合并更改后的批量删除分支. |
| File templates | 通用文件的文件模板. |
| Files | 文件管理. |
| Jupyter Notebook files | GitLab 对.ipynb
文件的支持. |
| Protected branches | 使用受保护的分支. |
| Push rules | 对项目推送的附加控制. |
| Repositories | 在 GitLab 的用户界面中管理源代码存储库. |
| Repository mirroring | 推入或拉出 GitLab 外部的存储库 |
| Start a merge request | 通过 GitLab 的用户界面提交时启动合并请求. |
Merge Requests
创建主题-合并请求 | Description |
---|---|
Checking out merge requests locally | 在本地处理合并请求的提示. |
Cherry-picking | 使用 GitLab 进行挑剔的更改. |
Merge request thread resolution | 解析线程,将合并请求中的线程移至问题,并且仅在解决所有线程后才允许合并请求. |
Merge requests | 合并请求管理. |
Draft merge requests | 防止合并草稿合并请求. |
Integration and Automation
创建主题-集成和自动化 | Description |
---|---|
GitLab API | 通过简单而强大的 API 集成 GitLab. |
GitLab Integration | 与 GitLab 集成多个第三方服务,以允许外部问题跟踪器和外部身份验证. |
GitLab Webhooks | 当新代码被推送到您的项目时,让 GitLab 通知您. |
Jira Development Panel | 请参阅 Jira 开发面板中的 GitLab 信息. |
Integrations | 将项目与外部服务(例如 CI 和聊天)集成. |
Trello Power-Up | 与 GitLab 的 Trello 上电集成. |
Verify
内置的静态代码分析,代码测试,代码质量,依赖项检查和 Review Apps 可以更快地发现错误,提高安全性并缩短反馈周期. 自定义您的批准工作流控件,自动测试代码质量,并为每个代码更改启动过渡环境.
GitLab 持续集成是最受欢迎的下一代测试系统,可以扩展以更快地运行测试.
以下文档与 DevOps 验证阶段有关:
验证主题 | Description |
---|---|
Code Quality reports | 分析源代码质量. |
GitLab CI/CD | 探索与 GitLab 持续集成的特性和功能. |
JUnit test reports | 显示有关合并请求的 JUnit 测试报告. |
Multi-project pipelines | 可视化跨越多个项目的整个管道,包括所有跨项目的相互依赖关系. |
Pipeline Graphs | 可视化构建. |
Review Apps | 直接从合并请求预览对应用程序的更改. |
Package
GitLab 软件包允许组织将 GitLab 用作各种常见软件包管理器的私有存储库. 用户能够构建和发布程序包,这些程序包可以很容易地作为下游项目中的依赖项使用.
以下文档与 DevOps Package阶段有关:
套餐主题 | Description |
---|---|
Container Registry | GitLab 容器注册表使 GitLab 中的每个项目都有自己的空间来存储Docker映像. |
Dependency Proxy | GitLab 依赖代理为经常使用的上游映像/软件包设置了本地代理. |
Conan Repository | GitLab 柯南存储库使 GitLab 中的每个项目都有自己的空间来存储柯南软件包. |
Maven Repository | GitLab Maven 存储库使 GitLab 中的每个项目都有自己的空间来存储Maven软件包. |
NPM Registry | GitLab NPM 注册表使 GitLab 中的每个项目都有自己的空间来存储NPM软件包. |
Release
花更少的时间配置工具,而花更多的时间创建. 无论您要部署到一台服务器还是数千台服务器,都可以通过 GitLab 内置的持续交付和部署来自信,安全地构建,测试和发布代码.
以下文档与 DevOps 发布阶段有关:
发布主题 | Description |
---|---|
Auto Deploy | 配置 GitLab 以部署应用程序. |
Canary Deployments | 采用流行的 CI 策略,首先将机队的一小部分更新为新版本. |
Deploy Boards | 查看 Kubernetes 上运行的每个 CI 环境的当前运行状况和状态,显示部署中 Pod 的状态. |
Environments and deployments | 借助环境,您可以控制 GitLab 中软件的连续部署. |
Environment-specific variables | 将变量的范围限制为特定的环境. |
GitLab CI/CD | 探索使用 GitLab 进行持续部署和交付的功能. |
GitLab Pages | 直接从 GitLab 构建,测试和部署静态站点. |
Protected Runners | 选择”运行程序”仅选择受保护的分支和标签的作业. |
Scheduled Pipelines | 按计划执行管道. |
Configure
使用 GitLab Auto DevOps 自动执行从构建到部署和监视的整个工作流程. 最佳实践模板可帮助您从最小到零的配置开始. 然后自定义所有内容,从构建包到 CI / CD.
以下文档与 DevOps 配置阶段有关:
配置主题 | Description |
---|---|
Auto DevOps | 自动采用完整的 DevOps 生命周期. |
Create Kubernetes clusters | 使用 Kubernetes 和 GitLab |
Executable Runbooks | 记录了说明如何执行特定过程的过程. |
GitLab ChatOps | 通过聊天服务与 CI / CD 作业进行交互. |
Installing Applications | 在 Kubernetes 上安装 Helm 图表,例如 Ingress 和 Prometheus. |
Mattermost slash commands | 从 Mattermost 内部启用和使用斜杠命令. |
Multiple Kubernetes Clusters | 将多个 Kubernetes 集群关联到您的项目. |
Protected variables | 将变量限制为受保护的分支和标签. |
Serverless | 在 Kubernetes 上运行无服务器工作负载. |
Slack slash commands | 在 Slack 中启用和使用斜杠命令. |
Manage your infrastructure with Terraform | 运行 CI / CD 管道时管理基础结构. |
Monitor
确保您的应用程序始终响应并可用.
GitLab 收集并显示已部署应用程序的性能指标,因此您可以立即知道代码更改如何影响您的生产环境.
以下文档与 DevOps Monitor阶段有关:
监控主题 | Description |
---|---|
GitLab Performance Monitoring | 使用 Prometheus 和 Grafana 监视您的 GitLab 实例的性能. |
GitLab Prometheus | 配置捆绑的 Prometheus,以从您的 GitLab 实例收集各种指标. |
Health check | GitLab provides liveness and readiness probes to indicate service health and reachability to required services. |
Prometheus project integration | 配置每个项目的 Prometheus 集成并监视您的 CI / CD 环境. |
Prometheus metrics | 让 Prometheus 从各种服务中收集指标,例如 Kubernetes,NGINX,NGINX Ingress 控制器,HAProxy 和 Amazon Cloud Watch. |
Incident management | 使用 GitLab 可以帮助您更好地响应系统中可能发生的事件. |
Secure
检查您的应用程序是否存在安全漏洞,这些漏洞可能导致未经授权的访问,数据泄漏和服务拒绝. GitLab 将对您的应用程序代码执行静态和动态测试,查找已知缺陷并在合并请求中报告这些缺陷,以便您可以在合并之前修复它们. 安全团队可以使用仪表板来获得项目和组的高级视图,并在需要时启动补救过程.
以下文档与 DevOps Secure阶段有关:
安全主题 | Description |
---|---|
Compliance Dashboard | 查看组中的最新”合并请求”活动. |
Container Scanning | 使用 Clair 扫描 Docker 映像中的已知漏洞. |
Dependency List | 查看项目的依存关系及其已知漏洞. |
Dependency Scanning | 分析您的依赖项是否存在已知漏洞. |
Dynamic Application Security Testing (DAST) | 分析运行中的 Web 应用程序是否存在已知漏洞. |
Group Security Dashboard | 查看组及其子组中所有项目中的漏洞. |
Instance Security Dashboard | 查看您感兴趣的所有项目中的漏洞. |
License Compliance | 在项目的依赖项中搜索其许可证. |
Pipeline Security | 查看项目管道的安全报告. |
Project Security Dashboard | 查看项目的最新安全报告. |
Static Application Security Testing (SAST) | 分析源代码中的已知漏洞. |
New to Git and GitLab?
使用新系统可能会令人生畏.
我们有以下文档可快速提升您的 GitLab 知识:
Topic | Description |
---|---|
GitLab basics guides | 开始在命令行和 GitLab 上工作. |
GitLab workflow overview | 利用最佳的 GitLab 工作流程增强您的工作流程. |
Get started with GitLab CI/CD | 快速实施 GitLab CI / CD. |
Auto DevOps | 了解有关 GitLab Auto DevOps 的更多信息. |
GitLab Markdown | GitLab 的高级格式化系统(GitLab Flavored Markdown) |
User account
了解有关 GitLab 帐户管理的更多信息:
Topic | Description |
---|---|
User account | 管理您的帐户. |
Authentication | 具有两因素身份验证的帐户安全性,设置您的 SSH 密钥,并部署密钥以安全地访问您的项目. |
Profile settings | 管理您的个人资料设置,两因素身份验证等. |
User permissions | 了解项目中的每个角色可以做什么. |
Git and GitLab
了解有关使用 Git 以及将 Git 与 GitLab 结合使用的更多信息:
Topic | Description |
---|---|
Git | Git 入门,分支策略,Git LFS 和高级用法. |
Git cheat sheet | 下载描述最常用的 Git 操作的 PDF. |
GitLab Flow | 使用 GitLab Flow 策略探索 Git 的精华. |
Coming to GitLab from another platform
如果您是从另一个平台进入 GitLab,您会发现以下有用信息:
Topic | Description |
---|---|
Importing to GitLab | 从 GitHub,Bitbucket,GitLab.com,FogBugz 和 SVN 导入项目到 GitLab. |
Migrating from SVN | 将 SVN 存储库转换为 Git 和 GitLab. |
Build an integration with GitLab
与 GitLab 集成的方法很多,包括:
Topic | Description |
---|---|
GitLab API | 通过简单而强大的 API 集成 GitLab. |
Integrations and automation | 所有的 GitLab 集成和自动化选项. |
Contributing to GitLab
GitLab 社区版是开源的,而 GitLab 企业版是开放核的 .
了解如何通过以下资源为 GitLab 做出贡献:
Topic | Description |
---|---|
Development | 如何为 GitLab 开发做出贡献. |
Legal | 贡献者许可协议. |
Writing documentation | 如何为 GitLab 文档做出贡献. |