debian-mirror-gitlab/doc/ci/index.md

185 lines
16 KiB
Markdown
Raw Normal View History

2021-09-30 23:02:18 +05:30
---
stage: Verify
group: Pipeline Execution
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
comments: false
description: "Learn how to use GitLab CI/CD, the GitLab built-in Continuous Integration, Continuous Deployment, and Continuous Delivery toolset to build, test, and deploy your application."
type: index
---
# GitLab CI/CD **(FREE)**
2021-11-11 11:23:49 +05:30
GitLab CI/CD is a tool for software development using the continuous methodologies:
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
- [Continuous Integration (CI)](introduction/index.md#continuous-integration)
- [Continuous Delivery (CD)](introduction/index.md#continuous-delivery)
- [Continuous Deployment (CD)](introduction/index.md#continuous-deployment)
2021-09-30 23:02:18 +05:30
NOTE:
Out-of-the-box management systems can decrease hours spent on maintaining toolchains by 10% or more.
Watch our ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/)
2021-11-11 11:23:49 +05:30
webcast to learn about continuous methods and how GitLab CI/CD can help you simplify and scale software development.
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
Use GitLab CI/CD to catch bugs and errors early in
the development cycle. Ensure that all the code deployed to
2021-09-30 23:02:18 +05:30
production complies with the code standards you established for
your app.
2021-11-11 11:23:49 +05:30
GitLab CI/CD can automatically build, test, deploy, and
2021-09-30 23:02:18 +05:30
monitor your applications by using [Auto DevOps](../topics/autodevops/index.md).
For a complete overview of these methodologies and GitLab CI/CD,
read the [Introduction to CI/CD with GitLab](introduction/index.md).
<div class="video-fallback">
2021-11-18 22:05:49 +05:30
Video demonstration of continuous integration with GitLab CI/CD: <a href="https://www.youtube.com/watch?v=ljth1Q5oJoo">Continuous Integration with GitLab (overview demo)</a>.
2021-09-30 23:02:18 +05:30
</div>
<figure class="video-container">
2021-11-18 22:05:49 +05:30
<iframe src="https://www.youtube.com/embed/ljth1Q5oJoo" frameborder="0" allowfullscreen="true"> </iframe>
2021-09-30 23:02:18 +05:30
</figure>
2021-11-11 11:23:49 +05:30
## GitLab CI/CD concepts
2021-09-30 23:02:18 +05:30
GitLab CI/CD uses a number of concepts to describe and run your build and deploy.
| Concept | Description |
|:--------------------------------------------------------|:-------------------------------------------------------------------------------|
| [Pipelines](pipelines/index.md) | Structure your CI/CD process through pipelines. |
| [CI/CD variables](variables/index.md) | Reuse values based on a variable/value key pair. |
2021-11-18 22:05:49 +05:30
| [Environments](environments/index.md) | Deploy your application to different environments (for example, staging, production). |
2021-09-30 23:02:18 +05:30
| [Job artifacts](pipelines/job_artifacts.md) | Output, use, and reuse job artifacts. |
| [Cache dependencies](caching/index.md) | Cache your dependencies for a faster execution. |
| [GitLab Runner](https://docs.gitlab.com/runner/) | Configure your own runners to execute your scripts. |
| [Pipeline efficiency](pipelines/pipeline_efficiency.md) | Configure your pipelines to run quickly and efficiently. |
2021-10-27 15:23:28 +05:30
| [Test cases](test_cases/index.md) | Create testing scenarios. |
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
## GitLab CI/CD configuration
2021-09-30 23:02:18 +05:30
GitLab CI/CD supports numerous configuration options:
| Configuration | Description |
|:----------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------|
| [Schedule pipelines](pipelines/schedules.md) | Schedule pipelines to run as often as you need. |
| [Custom path for `.gitlab-ci.yml`](pipelines/settings.md#specify-a-custom-cicd-configuration-file) | Define a custom path for the CI/CD configuration file. |
| [Git submodules for CI/CD](git_submodules.md) | Configure jobs for using Git submodules. |
| [SSH keys for CI/CD](ssh_keys/index.md) | Using SSH keys in your CI pipelines. |
| [Pipeline triggers](triggers/index.md) | Trigger pipelines through the API. |
| [Pipelines for Merge Requests](pipelines/merge_request_pipelines.md) | Design a pipeline structure for running a pipeline in merge requests. |
2021-11-18 22:05:49 +05:30
| [Integrate with Kubernetes clusters](../user/infrastructure/clusters/index.md) | Connect your project to Google Kubernetes Engine (GKE) or an existing Kubernetes cluster. |
2021-09-30 23:02:18 +05:30
| [Optimize GitLab and GitLab Runner for large repositories](large_repositories/index.md) | Recommended strategies for handling large repositories. |
| [`.gitlab-ci.yml` full reference](yaml/index.md) | All the attributes you can use with GitLab CI/CD. |
2021-10-27 15:23:28 +05:30
Certain operations can only be performed according to the
2021-09-30 23:02:18 +05:30
[user](../user/permissions.md#gitlab-cicd-permissions) and [job](../user/permissions.md#job-permissions) permissions.
2021-11-11 11:23:49 +05:30
## GitLab CI/CD features
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
GitLab CI/CD features, grouped by DevOps stage, include:
2021-09-30 23:02:18 +05:30
| Feature | Description |
|:------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------|
| **Configure** | |
| [Auto DevOps](../topics/autodevops/index.md) | Set up your app's entire lifecycle. |
2021-11-11 11:23:49 +05:30
| [ChatOps](chatops/index.md) | Trigger CI jobs from chat, with results sent back to the channel. |
2022-03-02 08:16:31 +05:30
| [Connect to cloud services](cloud_services/index.md) | Connect to cloud providers using OpenID Connect (OIDC) to retrieve temporary credentials to access services or secrets. |
2021-09-30 23:02:18 +05:30
|-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------|
| **Verify** | |
| [Browser Performance Testing](../user/project/merge_requests/browser_performance_testing.md) | Quickly determine the browser performance impact of pending code changes. |
| [Load Performance Testing](../user/project/merge_requests/load_performance_testing.md) | Quickly determine the server performance impact of pending code changes. |
2021-11-11 11:23:49 +05:30
| [CI services](services/index.md) | Link Docker containers with your base image. |
2021-09-30 23:02:18 +05:30
| [GitLab CI/CD for external repositories](ci_cd_for_external_repos/index.md) **(PREMIUM)** | Get the benefits of GitLab CI/CD combined with repositories in GitHub and Bitbucket Cloud. |
| [Interactive Web Terminals](interactive_web_terminal/index.md) **(FREE SELF)** | Open an interactive web terminal to debug the running jobs. |
2021-12-11 22:18:48 +05:30
| [Review Apps](review_apps/index.md) | Configure GitLab CI/CD to preview code changes. |
| [Unit test reports](unit_test_reports.md) | Identify test failures directly on merge requests. |
2021-09-30 23:02:18 +05:30
| [Using Docker images](docker/using_docker_images.md) | Use GitLab and GitLab Runner with Docker to build and test applications. |
|-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------|
| **Release** | |
| [Auto Deploy](../topics/autodevops/stages.md#auto-deploy) | Deploy your application to a production environment in a Kubernetes cluster. |
| [Building Docker images](docker/using_docker_build.md) | Maintain Docker-based projects using GitLab CI/CD. |
| [Canary Deployments](../user/project/canary_deployments.md) | Ship features to only a portion of your pods and let a percentage of your user base to visit the temporarily deployed feature. |
2021-11-11 11:23:49 +05:30
| [Deploy boards](../user/project/deploy_boards.md) | Check the current health and status of each CI/CD environment running on Kubernetes. |
2021-11-18 22:05:49 +05:30
| [Feature Flags](../operations/feature_flags.md) | Deploy your features behind Feature Flags. |
2021-09-30 23:02:18 +05:30
| [GitLab Pages](../user/project/pages/index.md) | Deploy static websites. |
| [GitLab Releases](../user/project/releases/index.md) | Add release notes to Git tags. |
| [Cloud deployment](cloud_deployment/index.md) | Deploy your application to a main cloud provider. |
|-------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------|
| **Secure** | |
2021-12-11 22:18:48 +05:30
| [Code Quality](../user/project/merge_requests/code_quality.md) | Analyze your source code quality. |
2021-09-30 23:02:18 +05:30
| [Container Scanning](../user/application_security/container_scanning/index.md) **(ULTIMATE)** | Check your Docker containers for known vulnerabilities. |
| [Dependency Scanning](../user/application_security/dependency_scanning/index.md) **(ULTIMATE)** | Analyze your dependencies for known vulnerabilities. |
| [License Compliance](../user/compliance/license_compliance/index.md) **(ULTIMATE)** | Search your project dependencies for their licenses. |
| [Security Test reports](../user/application_security/index.md) **(ULTIMATE)** | Check for app vulnerabilities. |
2021-11-11 11:23:49 +05:30
## GitLab CI/CD examples
2021-09-30 23:02:18 +05:30
2021-11-18 22:05:49 +05:30
See the [CI/CD examples](examples/index.md) page for example project code and tutorials for
2021-11-11 11:23:49 +05:30
using GitLab CI/CD with various:
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
- App frameworks
- Languages
- Platforms
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
## GitLab CI/CD Administration
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
You can change the default behavior of GitLab CI/CD for:
- An entire GitLab instance in the [CI/CD administration settings](../administration/index.md#cicd-settings).
- Specific projects in the [pipelines settings](pipelines/settings.md).
2021-09-30 23:02:18 +05:30
See also:
2021-11-11 11:23:49 +05:30
- [Enable or disable GitLab CI/CD in a project](enable_or_disable_ci.md).
2021-09-30 23:02:18 +05:30
2021-12-11 22:18:48 +05:30
## Related topics
2021-09-30 23:02:18 +05:30
2021-11-11 11:23:49 +05:30
Learn more about GitLab CI/CD:
2021-09-30 23:02:18 +05:30
- [Why you might choose GitLab CI/CD](https://about.gitlab.com/blog/2016/10/17/gitlab-ci-oohlala/).
- [Reasons you might migrate from another platform](https://about.gitlab.com/blog/2016/07/22/building-our-web-app-on-gitlab-ci/).
- [5 Teams that made the switch to GitLab CI/CD](https://about.gitlab.com/blog/2019/04/25/5-teams-that-made-the-switch-to-gitlab-ci-cd/)
2021-12-11 22:18:48 +05:30
- If you use VS Code to edit your GitLab CI/CD configuration, the
[GitLab Workflow VS Code extension](../user/project/repository/vscode.md) helps you
[validate your configuration](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#validate-gitlab-ci-configuration)
and [view your pipeline status](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#information-about-your-branch-pipelines-mr-closing-issue).
2021-09-30 23:02:18 +05:30
See also the [Why CI/CD?](https://docs.google.com/presentation/d/1OGgk2Tcxbpl7DJaIOzCX4Vqg3dlwfELC3u2jEeCBbDk) presentation.
2021-11-11 11:23:49 +05:30
### Major version changes (breaking)
2021-09-30 23:02:18 +05:30
As GitLab CI/CD has evolved, certain breaking changes have
2021-11-11 11:23:49 +05:30
been necessary.
2021-09-30 23:02:18 +05:30
2021-12-11 22:18:48 +05:30
#### 14.0
- No breaking changes.
2021-09-30 23:02:18 +05:30
#### 13.0
- [Remove Backported `os.Expand`](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4915).
- [Remove Fedora 29 package support](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/16158).
- [Remove macOS 32-bit support](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/25466).
- [Removed `debug/jobs/list?v=1` endpoint](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/6361).
- [Remove support for array of strings when defining services for Docker executor](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4922).
- [Remove `--docker-services` flag on register command](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/6404).
- [Remove legacy build directory caching](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4180).
- [Remove `FF_USE_LEGACY_VOLUMES_MOUNTING_ORDER` feature flag](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/6581).
- [Remove support for Windows Server 1803](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/6553).
#### 12.0
- [Use `refspec` to clone/fetch Git repository](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4069).
- [Old cache configuration](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4070).
- [Old metrics server configuration](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4072).
- [Remove `FF_K8S_USE_ENTRYPOINT_OVER_COMMAND`](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4073).
- [Remove Linux distributions that reach EOL](https://gitlab.com/gitlab-org/gitlab-runner/-/merge_requests/1130).
- [Update command line API for helper images](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4013).
- [Remove old `git clean` flow](https://gitlab.com/gitlab-org/gitlab-runner/-/issues/4175).
#### 11.0
- No breaking changes.
#### 10.0
- No breaking changes.