diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.md | 2 | ||||
-rw-r--r-- | doc/ci/junit_test_reports.md | 15 | ||||
-rw-r--r-- | doc/ci/multi_project_pipelines.md | 2 | ||||
-rw-r--r-- | doc/ci/pipelines/index.md | 4 | ||||
-rw-r--r-- | doc/ci/pipelines/job_artifacts.md | 2 | ||||
-rw-r--r-- | doc/ci/pipelines/settings.md | 2 | ||||
-rw-r--r-- | doc/topics/autodevops/index.md | 30 | ||||
-rw-r--r-- | doc/user/project/clusters/add_remove_clusters.md | 6 | ||||
-rw-r--r-- | doc/user/project/clusters/runbooks/index.md | 4 |
9 files changed, 53 insertions, 14 deletions
diff --git a/doc/README.md b/doc/README.md index 3a3e93244c4..8c6f76306c4 100644 --- a/doc/README.md +++ b/doc/README.md @@ -306,7 +306,7 @@ The following documentation relates to the DevOps **Configure** stage: | Configure Topics | Description | |:-----------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------| | [Auto DevOps](topics/autodevops/index.md) | Automatically employ a complete DevOps lifecycle. | -| [Create Kubernetes clusters](user/project/clusters/add_remove_clusters.md#add-new-cluster) | Use Kubernetes and GitLab. | +| [Create Kubernetes clusters](user/project/clusters/add_remove_clusters.md#create-new-cluster) | Use Kubernetes and GitLab. | | [Executable Runbooks](user/project/clusters/runbooks/index.md) | Documented procedures that explain how to carry out particular processes. | | [GitLab ChatOps](ci/chatops/README.md) | Interact with CI/CD jobs through chat services. | | [Installing Applications](user/project/clusters/index.md#installing-applications) | Deploy Helm, Ingress, and Prometheus on Kubernetes. | diff --git a/doc/ci/junit_test_reports.md b/doc/ci/junit_test_reports.md index 78c9965aa08..313ade0887e 100644 --- a/doc/ci/junit_test_reports.md +++ b/doc/ci/junit_test_reports.md @@ -151,6 +151,21 @@ java: - target/failsafe-reports/TEST-*.xml ``` +### Python example + +This example uses pytest with the `--junitxml=report.xml` flag to format the output +for JUnit: + +```yaml +pytest: + stage: test + script: + - pytest --junitxml=report.xml + artifacts: + reports: + junit: report.xml +``` + ### C/C++ example There are a few tools that can produce JUnit reports in C/C++. diff --git a/doc/ci/multi_project_pipelines.md b/doc/ci/multi_project_pipelines.md index 7c79bf350b9..14277b6b55b 100644 --- a/doc/ci/multi_project_pipelines.md +++ b/doc/ci/multi_project_pipelines.md @@ -10,8 +10,6 @@ type: reference 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 with multi-project pipelines. diff --git a/doc/ci/pipelines/index.md b/doc/ci/pipelines/index.md index 28c587f39bb..18f5c5f6827 100644 --- a/doc/ci/pipelines/index.md +++ b/doc/ci/pipelines/index.md @@ -12,8 +12,6 @@ Watch our ["Mastering continuous software development"](https://about.gitlab.com/webcast/mastering-ci-cd/) webcast to see a comprehensive demo of GitLab CI/CD pipeline. -## Introduction - Pipelines are the top-level component of continuous integration, delivery, and deployment. Pipelines comprise: @@ -33,7 +31,7 @@ If you have a [mirrored repository that GitLab pulls from](../../user/project/re you may need to enable pipeline triggering in your project's **Settings > Repository > Pull from a remote repository > Trigger pipelines for mirror updates**. -### Simple pipeline example +## Simple pipeline example As an example, imagine a pipeline consisting of four stages, executed in the following order: diff --git a/doc/ci/pipelines/job_artifacts.md b/doc/ci/pipelines/job_artifacts.md index d44df8defcf..ed791ea9c4a 100644 --- a/doc/ci/pipelines/job_artifacts.md +++ b/doc/ci/pipelines/job_artifacts.md @@ -3,7 +3,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/user/project/pipelines/job_artifa type: reference, howto --- -# Introduction to job artifacts +# Job artifacts > - Introduced in GitLab 8.2 and GitLab Runner 0.7.0. > - Starting with GitLab 8.4 and GitLab Runner 1.0, the artifacts archive format changed to `ZIP`, and it is now possible to browse its contents, with the added ability of downloading the files separately. diff --git a/doc/ci/pipelines/settings.md b/doc/ci/pipelines/settings.md index 48862986114..b1c5ee6e24f 100644 --- a/doc/ci/pipelines/settings.md +++ b/doc/ci/pipelines/settings.md @@ -3,7 +3,7 @@ disqus_identifier: 'https://docs.gitlab.com/ee/user/project/pipelines/settings.h type: reference, howto --- -# Pipelines settings +# Pipeline settings To reach the pipelines settings navigate to your project's **Settings > CI/CD**. diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index bf58a2f7510..cc6d7d65115 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -109,7 +109,7 @@ To make full use of Auto DevOps, you will need: To enable deployments, you will need: 1. A [Kubernetes 1.12+ cluster](../../user/project/clusters/index.md) for the project. The easiest - way is to add a [new cluster using the GitLab UI](../../user/project/clusters/add_remove_clusters.md#add-new-cluster). + way is to create a [new cluster using the GitLab UI](../../user/project/clusters/add_remove_clusters.md#create-new-cluster). For Kubernetes 1.16+ clusters, there is some additional configuration for [Auto Deploy for Kubernetes 1.16+](#kubernetes-116). 1. NGINX Ingress. You can deploy it to your Kubernetes cluster by installing the [GitLab-managed app for Ingress](../../user/clusters/applications.md#ingress), @@ -404,6 +404,33 @@ If Auto Build fails despite the project meeting the buildpack requirements, set a project variable `TRACE=true` to enable verbose logging, which may help to troubleshoot. +#### Auto Build using Cloud Native Buildpacks (beta) + +> Introduced in [GitLab 12.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28165). + +Auto Build supports building your application using [Cloud Native Buildpacks](https://buildpacks.io) +through the [`pack` command](https://github.com/buildpacks/pack). To use Cloud Native Buildpacks, +set the CI variable `AUTO_DEVOPS_BUILD_IMAGE_CNB_ENABLED` to a non-empty value. + +Cloud Native Buildpacks (CNBs) are an evolution of Heroku buildpacks, and +will eventually supersede Herokuish-based builds within Auto DevOps. For more +information, see [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/212692). + +Builds using Cloud Native Buildpacks support the same options as builds using +Heroku buildpacks, with the following caveats: + +- The buildpack must be a Cloud Native Buildpack. A Heroku buildpack can be + converted to a Cloud Native Buildpack using Heroku's + [`cnb-shim`](https://github.com/heroku/cnb-shim). +- `BUILDPACK_URL` must be in a form + [supported by `pack`](https://buildpacks.io/docs/app-developer-guide/specific-buildpacks/). +- The `/bin/herokuish` command is not present in the resulting image, and prefixing + commands with `/bin/herokuish procfile exec` is no longer required (nor possible). + +NOTE: **Note**: Auto Test still uses Herokuish, as test suite detection is not +yet part of the Cloud Native Buildpack specification. For more information, see +[this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/212689). + ### Auto Test Auto Test automatically runs the appropriate tests for your application using @@ -1162,6 +1189,7 @@ applications. |-----------------------------------------|------------------------------------| | `ADDITIONAL_HOSTS` | Fully qualified domain names specified as a comma-separated list that are added to the Ingress hosts. | | `<ENVIRONMENT>_ADDITIONAL_HOSTS` | For a specific environment, the fully qualified domain names specified as a comma-separated list that are added to the Ingress hosts. This takes precedence over `ADDITIONAL_HOSTS`. | +| `AUTO_DEVOPS_BUILD_IMAGE_CNB_ENABLED` | When set to a non-empty value and no `Dockerfile` is present, Auto Build builds your application using Cloud Native Buildpacks instead of Herokuish. [More details](#auto-build-using-cloud-native-buildpacks-beta). | | `AUTO_DEVOPS_BUILD_IMAGE_EXTRA_ARGS` | Extra arguments to be passed to the `docker build` command. Note that using quotes will not prevent word splitting. [More details](#passing-arguments-to-docker-build). | | `AUTO_DEVOPS_BUILD_IMAGE_FORWARDED_CI_VARIABLES` | A [comma-separated list of CI variable names](#passing-secrets-to-docker-build) to be passed to the `docker build` command as secrets. | | `AUTO_DEVOPS_CHART` | Helm Chart used to deploy your apps. Defaults to the one [provided by GitLab](https://gitlab.com/gitlab-org/charts/auto-deploy-app). | diff --git a/doc/user/project/clusters/add_remove_clusters.md b/doc/user/project/clusters/add_remove_clusters.md index 7f7978d1089..dce273ce602 100644 --- a/doc/user/project/clusters/add_remove_clusters.md +++ b/doc/user/project/clusters/add_remove_clusters.md @@ -14,7 +14,7 @@ Google Kubernetes Engine Integration. All you have to do is [follow this link](h ## Before you begin -Before [adding a Kubernetes cluster](#add-new-cluster) using GitLab, you need: +Before [adding a Kubernetes cluster](#create-new-cluster) using GitLab, you need: - GitLab itself. Either: - A GitLab.com [account](https://about.gitlab.com/pricing/#gitlab-com). @@ -127,9 +127,9 @@ If you don't want to use GitLab Runner in privileged mode, either: 1. Installing a Runner [using `docker+machine`](https://docs.gitlab.com/runner/executors/docker_machine.html). -## Add new cluster +## Create new cluster -New clusters can be added using GitLab for: +New clusters can be created using GitLab for: - [Google Kubernetes Engine (GKE)](add_gke_clusters.md). - [Amazon Elastic Kubernetes Service (EKS)](add_eks_clusters.md). diff --git a/doc/user/project/clusters/runbooks/index.md b/doc/user/project/clusters/runbooks/index.md index ad3d675f158..5575cd1d2d4 100644 --- a/doc/user/project/clusters/runbooks/index.md +++ b/doc/user/project/clusters/runbooks/index.md @@ -35,7 +35,7 @@ for an overview of how this is accomplished in GitLab!** To create an executable runbook, you will need: 1. **Kubernetes** - A Kubernetes cluster is required to deploy the rest of the applications. - The simplest way to get started is to add a cluster using one of [GitLab's integrations](../add_remove_clusters.md#add-new-cluster). + The simplest way to get started is to add a cluster using one of [GitLab's integrations](../add_remove_clusters.md#create-new-cluster). 1. **Helm Tiller** - Helm is a package manager for Kubernetes and is required to install all the other applications. It is installed in its own pod inside the cluster which can run the Helm CLI in a safe environment. @@ -60,7 +60,7 @@ the components outlined above and the preloaded demo runbook. ### 1. Add a Kubernetes cluster -Follow the steps outlined in [Add new cluster](../add_remove_clusters.md#add-new-cluster) +Follow the steps outlined in [Create new cluster](../add_remove_clusters.md#create-new-cluster) to add a Kubernetes cluster to your project. ### 2. Install Helm Tiller, Ingress, and JupyterHub |