diff options
Diffstat (limited to 'doc/topics/autodevops')
| -rw-r--r-- | doc/topics/autodevops/cicd_variables.md | 1 | ||||
| -rw-r--r-- | doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md | 4 | ||||
| -rw-r--r-- | doc/topics/autodevops/customize.md | 10 | ||||
| -rw-r--r-- | doc/topics/autodevops/index.md | 2 | ||||
| -rw-r--r-- | doc/topics/autodevops/requirements.md | 4 | ||||
| -rw-r--r-- | doc/topics/autodevops/stages.md | 57 |
6 files changed, 49 insertions, 29 deletions
diff --git a/doc/topics/autodevops/cicd_variables.md b/doc/topics/autodevops/cicd_variables.md index 169d34aad77..b22b4677f24 100644 --- a/doc/topics/autodevops/cicd_variables.md +++ b/doc/topics/autodevops/cicd_variables.md @@ -94,7 +94,6 @@ Use these variables to disable CI/CD jobs. | `bandit-sast` | `SAST_DISABLED` | | If the variable is present, the job isn't created. | | `brakeman-sast` | `SAST_DISABLED` | | If the variable is present, the job isn't created. | | `canary` | `CANARY_ENABLED` | | This manual job is created if the variable is present. | -| `cluster_image_scanning` | `CLUSTER_IMAGE_SCANNING_DISABLED` | | If the variable is present, the job isn't created. | | `code_intelligence` | `CODE_INTELLIGENCE_DISABLED` | From GitLab 13.6 | If the variable is present, the job isn't created. | | `code_quality` | `CODE_QUALITY_DISABLED` | | If the variable is present, the job isn't created. | | `container_scanning` | `CONTAINER_SCANNING_DISABLED` | | If the variable is present, the job isn't created. | diff --git a/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md b/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md index 78c51572973..9bd1d30e1b1 100644 --- a/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md +++ b/doc/topics/autodevops/cloud_deployments/auto_devops_with_gke.md @@ -172,7 +172,7 @@ The jobs are separated into stages: are allowed to fail in the test stage: - The `test` job runs unit and integration tests by detecting the language and - framework ([Auto Test](../stages.md#auto-test)) + framework ([Auto Test](../stages.md#auto-test-deprecated)) - The `code_quality` job checks the code quality and is allowed to fail ([Auto Code Quality](../stages.md#auto-code-quality)) - The `container_scanning` job checks the Docker container if it has any @@ -188,7 +188,7 @@ The jobs are separated into stages: ([Auto License Compliance](../stages.md#auto-license-compliance)) - **Review** - Pipelines on the default branch include this stage with a `dast_environment_deploy` job. - To learn more, see [Dynamic Application Security Testing (DAST)](../../../user/application_security/dast/index.md). + For more information, see [Dynamic Application Security Testing (DAST)](../../../user/application_security/dast/index.md). - **Production** - After the tests and checks finish, the application deploys in Kubernetes ([Auto Deploy](../stages.md#auto-deploy)). diff --git a/doc/topics/autodevops/customize.md b/doc/topics/autodevops/customize.md index 776112d6303..b8ea242df1a 100644 --- a/doc/topics/autodevops/customize.md +++ b/doc/topics/autodevops/customize.md @@ -52,7 +52,13 @@ Specify either: - The CI/CD variable `BUILDPACK_URL` with any of [`pack`'s URI specification formats](https://buildpacks.io/docs/app-developer-guide/specify-buildpacks/). - A [`project.toml` project descriptor](https://buildpacks.io/docs/app-developer-guide/using-project-descriptor/) with the buildpacks you would like to include. -### Customize buildpacks with Herokuish +<!--- start_remove The following content will be removed on remove_date: '2024-08-22' --> + +### Customize buildpacks with Herokuish (deprecated) + +WARNING: +Support for Herokuish was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108234) in GitLab 15.8, +and is planned for removal in 17.0. Use [Cloud Native Buildpacks](stages.md#moving-from-herokuish-to-cloud-native-buildpacks) instead. Specify either: @@ -69,6 +75,8 @@ reference: - The branch `mybranch`: `https://github.com/heroku/heroku-buildpack-ruby.git#mybranch`. - The commit SHA `f97d8a8ab49`: `https://github.com/heroku/heroku-buildpack-ruby.git#f97d8a8ab49`. +<!--- end_remove --> + ### Multiple buildpacks Because Auto Test cannot use the `.buildpacks` file, Auto DevOps does diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md index d16229b525f..588be855659 100644 --- a/doc/topics/autodevops/index.md +++ b/doc/topics/autodevops/index.md @@ -32,7 +32,7 @@ Auto DevOps supports development during each of the [DevOps stages](stages.md). |---------|-------------| | Build | [Auto Build](stages.md#auto-build) | | Build | [Auto Dependency Scanning](stages.md#auto-dependency-scanning) | -| Test | [Auto Test](stages.md#auto-test) | +| Test | [Auto Test](stages.md#auto-test-deprecated) | | Test | [Auto Browser Performance Testing](stages.md#auto-browser-performance-testing) | | Test | [Auto Code Intelligence](stages.md#auto-code-intelligence) | | Test | [Auto Code Quality](stages.md#auto-code-quality) | diff --git a/doc/topics/autodevops/requirements.md b/doc/topics/autodevops/requirements.md index f5e06843e60..a409c6f1520 100644 --- a/doc/topics/autodevops/requirements.md +++ b/doc/topics/autodevops/requirements.md @@ -139,7 +139,7 @@ To make full use of Auto DevOps with Kubernetes, you need: [Docker Machine](https://docs.gitlab.com/runner/executors/docker_machine.html). Runners should be registered as [shared runners](../../ci/runners/runners_scope.md#shared-runners) - for the entire GitLab instance, or [specific runners](../../ci/runners/runners_scope.md#specific-runners) + for the entire GitLab instance, or [project runners](../../ci/runners/runners_scope.md#project-runners) that are assigned to specific projects. - **Prometheus** (for [Auto Monitoring](stages.md#auto-monitoring)) @@ -152,7 +152,7 @@ To make full use of Auto DevOps with Kubernetes, you need: The [Prometheus integration](../../user/project/integrations/prometheus.md) integration must be activated for the project, or activated at the group or instance level. - Learn more about [Project integration management](../../user/admin_area/settings/project_integration_management.md). + For more information, see [Project integration management](../../user/admin_area/settings/project_integration_management.md). To get response metrics (in addition to system metrics), you must [configure Prometheus to monitor NGINX](../../user/project/integrations/prometheus_library/nginx_ingress.md#configuring-nginx-ingress-monitoring). diff --git a/doc/topics/autodevops/stages.md b/doc/topics/autodevops/stages.md index aba0b2d7fae..0c5c87cdf0f 100644 --- a/doc/topics/autodevops/stages.md +++ b/doc/topics/autodevops/stages.md @@ -63,7 +63,7 @@ For the requirements of other languages and frameworks, read the 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). +[issue 212689](https://gitlab.com/gitlab-org/gitlab/-/issues/212689). #### Mount volumes into the build container @@ -89,10 +89,16 @@ buildjob: Read more about defining volumes in the [`pack build` documentation](https://buildpacks.io/docs/tools/pack/cli/pack_build/). -### Auto Build using Herokuish +<!--- start_remove The following content will be removed on remove_date: '2024-08-22' --> + +### Auto Build using Herokuish (deprecated) > [Replaced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63351) with Cloud Native Buildpacks in GitLab 14.0. +WARNING: +Support for Herokuish was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108234) in GitLab 15.8, +and is planned for removal in 17.0. Use [Cloud Native Buildpacks](#moving-from-herokuish-to-cloud-native-buildpacks) instead. + Prior to GitLab 14.0, [Herokuish](https://github.com/gliderlabs/herokuish) was the default build method for projects without a `Dockerfile`. Herokuish can still be used by setting the CI/CD variable `AUTO_DEVOPS_BUILD_IMAGE_CNB_ENABLED` @@ -103,6 +109,8 @@ If Auto Build fails despite the project meeting the buildpack requirements, set a project CI/CD variable `TRACE=true` to enable verbose logging, which may help you troubleshoot. +<!--- end_remove --> + ### Moving from Herokuish to Cloud Native Buildpacks Builds using Cloud Native Buildpacks support the same options as builds using @@ -118,7 +126,15 @@ Herokuish, with the following caveats: Instead, custom commands should be prefixed with `/cnb/lifecycle/launcher` to receive the correct execution environment. -## Auto Test +<!--- start_remove The following content will be removed on remove_date: '2024-08-22' --> + +## Auto Test (deprecated) + +WARNING: +Support for Herokuish was +[deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/108234) +in GitLab 15.8, and is planned for removal in 17.0. Because Auto Test uses +Herokuish, Auto Test is also deprecated. Auto Test runs the appropriate tests for your application using [Herokuish](https://github.com/gliderlabs/herokuish) and @@ -140,10 +156,11 @@ Cloud Native Buildpacks, and only buildpacks that implement the [Testpack API](https://devcenter.heroku.com/articles/testpack-api) are supported. <!-- vale gitlab.Spelling = YES --> +<!--- end_remove --> ### Currently supported languages -Note that not all buildpacks support Auto Test yet, as it's a relatively new +Not all buildpacks support Auto Test yet, as it's a relatively new enhancement. All of Heroku's [officially supported languages](https://devcenter.heroku.com/articles/heroku-ci#supported-languages) support Auto Test. The languages supported by Heroku's Herokuish buildpacks all @@ -193,8 +210,8 @@ After creating the report, it's uploaded as an artifact which you can later download and check out. The merge request widget also displays any security warnings on [Ultimate](https://about.gitlab.com/pricing/) licenses. -To learn more about [how SAST works](../../user/application_security/sast/index.md), -see the documentation. +For more information, see +[Static Application Security Testing (SAST)](../../user/application_security/sast/index.md). ## Auto Secret Detection @@ -208,7 +225,7 @@ After creating the report, it's uploaded as an artifact which you can later download and evaluate. The merge request widget also displays any security warnings on [Ultimate](https://about.gitlab.com/pricing/) licenses. -To learn more, see [Secret Detection](../../user/application_security/secret_detection/index.md). +For more information, see [Secret Detection](../../user/application_security/secret_detection/index.md). ## Auto Dependency Scanning **(ULTIMATE)** @@ -220,9 +237,8 @@ The Auto Dependency Scanning stage is skipped on licenses other than After creating the report, it's uploaded as an artifact which you can later download and check out. The merge request widget displays any security warnings detected, -To learn more about -[Dependency Scanning](../../user/application_security/dependency_scanning/index.md), -see the documentation. +For more information, see +[Dependency Scanning](../../user/application_security/dependency_scanning/index.md). ## Auto License Compliance **(ULTIMATE)** @@ -236,9 +252,8 @@ is skipped on licenses other than [Ultimate](https://about.gitlab.com/pricing/). After creating the report, it's uploaded as an artifact which you can later download and check out. The merge request displays any detected licenses. -To learn more about -[License Compliance](../../user/compliance/license_compliance/index.md), see the -documentation. +For more information, see +[License Compliance](../../user/compliance/license_compliance/index.md). ## Auto Container Scanning @@ -249,9 +264,8 @@ skipped on licenses other than [Ultimate](https://about.gitlab.com/pricing/). After creating the report, it's uploaded as an artifact which you can later download and check out. The merge request displays any detected security issues. -To learn more about -[Container Scanning](../../user/application_security/container_scanning/index.md), -see the documentation. +For more information, see +[Container Scanning](../../user/application_security/container_scanning/index.md). ## Auto Review Apps @@ -306,9 +320,8 @@ After the DAST scan completes, any security warnings are displayed on the [Security Dashboard](../../user/application_security/security_dashboard/index.md) and the merge request widget. -To learn more about -[Dynamic Application Security Testing](../../user/application_security/dast/index.md), -see the documentation. +For more information, see +[Dynamic Application Security Testing (DAST)](../../user/application_security/dast/index.md). ### Overriding the DAST target @@ -485,9 +498,9 @@ as a Helm post-install hook. As some applications can't run without a successful database initialization step, GitLab deploys the first release without the application deployment, and only the database initialization step. After the database initialization completes, GitLab deploys a second release with the application -deployment as normal. +deployment as standard. -Note that a post-install hook means that if any deploy succeeds, +A post-install hook means that if any deploy succeeds, `DB_INITIALIZE` isn't processed thereafter. If present, `DB_MIGRATE` is run as a shell command within an application pod as @@ -502,7 +515,7 @@ For example, in a Rails application in an image built with Unless your repository contains a `Dockerfile`, your image is built with Cloud Native Buildpacks, and you must prefix commands run in these images with `/cnb/lifecycle/launcher`, (or `/bin/herokuish procfile exec` when -using [Herokuish](#auto-build-using-herokuish)) +using [Herokuish](#auto-build-using-herokuish-deprecated)) to replicate the environment where your application runs. |