diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-09 03:07:59 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-09 03:07:59 +0000 |
commit | ce130e211808c9b02116f30af4a043f1a4d3a717 (patch) | |
tree | 133b0cb229d979361518e806189223eb99edf6c3 | |
parent | ed4df05ce917d6cf175aeb508b0485ae5f281a0a (diff) | |
download | gitlab-ce-ce130e211808c9b02116f30af4a043f1a4d3a717.tar.gz |
Add latest changes from gitlab-org/gitlab@master
-rw-r--r-- | .gitlab/merge_request_templates/Documentation.md | 1 | ||||
-rw-r--r-- | doc/ci/multi_project_pipelines.md | 44 | ||||
-rw-r--r-- | doc/ci/pipelines.md | 7 | ||||
-rw-r--r-- | doc/ssh/README.md | 27 | ||||
-rw-r--r-- | doc/user/project/deploy_tokens/index.md | 9 |
5 files changed, 56 insertions, 32 deletions
diff --git a/.gitlab/merge_request_templates/Documentation.md b/.gitlab/merge_request_templates/Documentation.md index 2a7da2a436f..901228ee77e 100644 --- a/.gitlab/merge_request_templates/Documentation.md +++ b/.gitlab/merge_request_templates/Documentation.md @@ -1,5 +1,6 @@ <!-- Follow the documentation workflow https://docs.gitlab.com/ee/development/documentation/workflow.html --> <!-- Additional information is located at https://docs.gitlab.com/ee/development/documentation/ --> +<!-- To find the designated Tech Writer for the stage/group, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers --> <!-- Mention "documentation" or "docs" in the MR title --> <!-- For changing documentation location use the "Change documentation location" template --> diff --git a/doc/ci/multi_project_pipelines.md b/doc/ci/multi_project_pipelines.md index e41a6f0d9b1..d56935dc3a3 100644 --- a/doc/ci/multi_project_pipelines.md +++ b/doc/ci/multi_project_pipelines.md @@ -2,26 +2,18 @@ type: reference --- -# Multi-project pipelines **(PREMIUM)** +# Multi-project pipelines -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2121) in -[GitLab Premium 9.3](https://about.gitlab.com/releases/2017/06/22/gitlab-9-3-released/#multi-project-pipeline-graphs). +> - [Introduced](https://about.gitlab.com/releases/2015/08/22/gitlab-7-14-released/#build-triggers-api-gitlab-ci) in GitLab 7.14, as Build Triggers. +> - [Made available](https://gitlab.com/gitlab-org/gitlab/issues/199224) in all tiers in GitLab 12.8. -When you set up [GitLab CI/CD](README.md) across multiple projects, you can visualize -the entire pipeline, including all cross-project inter-dependencies. +You can set up [GitLab CI/CD](README.md) across multiple projects, so that a pipeline +in one project can trigger a pipeline in another project. ## Overview -GitLab CI/CD is a powerful continuous integration tool that works not only per project, but also across projects. When you -configure GitLab CI for your project, you can visualize the stages -of your [jobs](pipelines.md#configuring-pipelines) on a [pipeline graph](pipelines.md#visualizing-pipelines). - -![Multi-project pipeline graph](img/multi_project_pipeline_graph.png) - -In the Merge Request Widget, multi-project pipeline mini-graphs are displayed, -and when hovering or tapping (on touchscreen devices) they will expand and be shown adjacent to each other. - -![Multi-project mini graph](img/multi_pipeline_mini_graph.gif) +GitLab CI/CD is a powerful continuous integration tool that works not only per project, +but also across projects with multi-project pipelines. Multi-project pipelines are useful for larger products that require cross-project inter-dependencies, such as those adopting a [microservices architecture](https://about.gitlab.com/blog/2016/08/16/trends-in-version-control-land-microservices/). @@ -30,6 +22,9 @@ For a demonstration of how cross-functional development teams can use cross-pipe triggering to trigger multiple pipelines for different microservices projects, see [Cross-project Pipeline Triggering and Visualization](https://about.gitlab.com/handbook/marketing/product-marketing/demo/#cross-project-pipeline-triggering-and-visualization-may-2019---1110). +Additionally, it's possible to visualize the entire pipeline, including all cross-project +inter-dependencies. **(PREMIUM)** + ## Use cases Let's assume you deploy your web app from different projects in GitLab: @@ -40,8 +35,25 @@ Let's assume you deploy your web app from different projects in GitLab: With Multi-Project Pipelines you can visualize the entire pipeline, including all build and test stages for the three projects. +## Multi-project pipeline visualization **(PREMIUM)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/2121) in [GitLab Premium 9.3](https://about.gitlab.com/releases/2017/06/22/gitlab-9-3-released/#multi-project-pipeline-graphs). + +When you configure GitLab CI for your project, you can visualize the stages of your +[jobs](pipelines.md#configuring-pipelines) on a [pipeline graph](pipelines.md#visualizing-pipelines). + +![Multi-project pipeline graph](img/multi_project_pipeline_graph.png) + +In the Merge Request Widget, multi-project pipeline mini-graphs are displayed, +and when hovering or tapping (on touchscreen devices) they will expand and be shown adjacent to each other. + +![Multi-project mini graph](img/multi_pipeline_mini_graph.gif) + ## Triggering multi-project pipelines through API +> - Use of `CI_JOB_TOKEN` for multi-project pipelines was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2017) in [GitLab Premium][ee] 9.3. +> - Use of `CI_JOB_TOKEN` for multi-project pipelines was [made available](https://gitlab.com/gitlab-org/gitlab/issues/31573) in all tiers in GitLab 12.4. + When you use the [`CI_JOB_TOKEN` to trigger pipelines](triggers/README.md#ci-job-token), GitLab recognizes the source of the job token, and thus internally ties these pipelines together, allowing you to visualize their relationships on pipeline graphs. @@ -52,7 +64,7 @@ outbound connections for upstream and downstream pipeline dependencies. ## Creating multi-project pipelines from `.gitlab-ci.yml` > - [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/8997) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.8. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/issues/199224) to GitLab Core in 12.8. +> - [Made available](https://gitlab.com/gitlab-org/gitlab/issues/199224) in all tiers in 12.8. ### Triggering a downstream pipeline using a bridge job diff --git a/doc/ci/pipelines.md b/doc/ci/pipelines.md index be6da22e074..d9522444ef0 100644 --- a/doc/ci/pipelines.md +++ b/doc/ci/pipelines.md @@ -299,11 +299,12 @@ Pipeline status and test coverage report badges are available and configurable f For information on adding pipeline badges to projects, see [Pipeline badges](../user/project/pipelines/settings.md#pipeline-badges). -## Multi-project pipelines **(PREMIUM)** +## Multi-project pipelines -Pipelines for different projects can be combined and visualized together. +Pipelines for different projects can be combined together into [Multi-project pipelines](multi_project_pipelines.md). -For more information, see [Multi-project pipelines](multi_project_pipelines.md). +[Multi-project pipeline graphs](multi_project_pipelines.md#multi-project-pipeline-visualization-premium) help +you visualize the entire pipeline, including all cross-project inter-dependencies. **(PREMIUM)** ## Parent-child pipelines diff --git a/doc/ssh/README.md b/doc/ssh/README.md index c7fdfe697d0..ef24f234f42 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -343,12 +343,16 @@ This is really useful for cloning repositories to your Continuous Integration (CI) server. By using deploy keys, you don't have to set up a dummy user account. -If you are a project maintainer or owner, you can add a deploy key in the -project's **{settings}** **Settings > CI / CD** page by expanding the -**Deploy Keys** section. Specify a title for the new -deploy key and paste a public SSH key. After this, the machine that uses -the corresponding private SSH key has read-only or read-write (if enabled) -access to the project. +Project maintainers and owners can add a deploy key. To add one: + +1. Go to the settings page: + - On GitLab 12.8 and earlier, navigate to the project's **Settings > Repository**. + - On GitLab 12.9 and later, navigate to the project's **Settings > CI / CD**. +1. Expand the **Deploy Keys** section. +1. Specify a title for the new deploy key and paste a public SSH key. + +After this, the machine that uses the corresponding private SSH key has read-only or +read-write (if enabled) access to the project. You can't add the same deploy key twice using the form. If you want to add the same key to another project, please enable it in the @@ -387,9 +391,14 @@ of broader usage for something like "Anywhere you need to give read access to your repository". Once a GitLab administrator adds the Global Deployment key, project maintainers -and owners can add it in project's **{settings}** **Settings > CI / CD** page by expanding the -**Deploy Keys** section and clicking **Enable** next to the appropriate key listed -under **Public deploy keys available to any project**. +and owners can add it by: + +1. Navigating the settings page: + - On GitLab 12.8 and earlier, the project's **Settings > Repository** page. + - On GitLab 12.9 and later, the project's **Settings > CI / CD** page. +1. Expanding the **Deploy Keys** section. +1. Clicking **Enable** next to the appropriate key listed under + **Public deploy keys available to any project**. NOTE: **Note:** The heading **Public deploy keys available to any project** only appears diff --git a/doc/user/project/deploy_tokens/index.md b/doc/user/project/deploy_tokens/index.md index 4479653417c..75dd242cb81 100644 --- a/doc/user/project/deploy_tokens/index.md +++ b/doc/user/project/deploy_tokens/index.md @@ -1,11 +1,12 @@ # Deploy Tokens -> [Introduced][ce-17894] in GitLab 10.7. +> - [Introduced][ce-17894] in GitLab 10.7. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/issues/199370) from **Settings > Repository** in GitLab 12.9. -Deploy tokens allow to download (through `git clone`), or read the container registry images of a project without the need of having a user and a password. +Deploy tokens allow you to download (through `git clone`) or read the container registry images of a project without having a user and a password. -Please note, that the expiration of deploy tokens happens on the date you define, -at midnight UTC and that they can be only managed by [maintainers](../../permissions.md). +Please note that deploy tokens expire on the date you define, +at midnight UTC, and that they can be only managed by [maintainers](../../permissions.md). ## Creating a Deploy Token |