summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Lewis <mlewis@gitlab.com>2018-10-17 22:16:52 +0000
committerMike Lewis <mlewis@gitlab.com>2018-10-17 22:16:52 +0000
commit0be053ffc24340fe19434c43b6a863e2fb3d0a7e (patch)
tree05490ebe4f36c07494df2e0eaa0437c206a6b10a
parentaf7b9a7a13d9e8092b48cd9089e2d91217be854a (diff)
downloadgitlab-ce-0be053ffc24340fe19434c43b6a863e2fb3d0a7e.tar.gz
Edits to Auto DevOps doc
-rw-r--r--doc/topics/autodevops/index.md79
1 files changed, 46 insertions, 33 deletions
diff --git a/doc/topics/autodevops/index.md b/doc/topics/autodevops/index.md
index d4bf66c49da..820d6db9ea0 100644
--- a/doc/topics/autodevops/index.md
+++ b/doc/topics/autodevops/index.md
@@ -2,15 +2,15 @@
> [Introduced][ce-37115] in GitLab 10.0. Generally available on GitLab 11.0.
-Auto DevOps provides pre-defined CI configuration which will automatically detect, build, test,
-deploy, and monitor your applications. Leveraging CI best practices and tools, Auto DevOps aims
-to simplify the setup and execution of a mature & modern software development lifecycle.
+Auto DevOps provides a pre-defined continuous integration (CI) configuration which will automatically detect, build, test,
+deploy, and monitor your applications. Leveraging CI best practices and tools, Auto DevOps can
+simplify the setup and execution of a mature and modern software development lifecycle.
## Overview
NOTE: **Enabled by default:**
-Starting with GitLab 11.3, the Auto DevOps pipeline will be enabled by default for all
-projects. If it's not explicitly enabled for the project, Auto DevOps will be automatically
+Starting with GitLab 11.3, the Auto DevOps pipeline is enabled by default for all
+projects. If it is not explicitly enabled for the project, Auto DevOps will be automatically
disabled on the first pipeline failure. Your project will continue to use an alternative
[CI/CD configuration file](../../ci/yaml/README.md) if one is found. A GitLab
administrator can [change this setting](../../user/admin_area/settings/continuous_integration.html#auto-devops)
@@ -22,7 +22,7 @@ with minimal configuration. Just push your code and GitLab takes
care of everything else. This makes it easier to start new projects and brings
consistency to how applications are set up throughout a company.
-## Quick start
+## Quick start for GitLab.com
If you are using GitLab.com, see the [quick start guide](quick_start_guide.md)
for using Auto DevOps with GitLab.com and a Kubernetes cluster on Google Kubernetes
@@ -30,19 +30,19 @@ Engine.
## Comparison to application platforms and PaaS
-Auto DevOps provides functionality described by others as an application
-platform or as a Platform as a Service (PaaS). It takes inspiration from the
+Auto DevOps provides functionality that is often included in an application
+platform or a Platform as a Service (PaaS). It takes inspiration from the
innovative work done by [Heroku](https://www.heroku.com/) and goes beyond it
-in a couple of ways:
+in multiple ways:
-1. Auto DevOps works with any Kubernetes cluster, you're not limited to running
- on GitLab's infrastructure (note that many features also work without Kubernetes).
+1. Auto DevOps works with any Kubernetes cluster; you're not limited to running
+ on GitLab's infrastructure. (Note that many features also work without Kubernetes.)
1. There is no additional cost (no markup on the infrastructure costs), and you
can use a self-hosted Kubernetes cluster or Containers as a Service on any
- public cloud (for example [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/)).
+ public cloud (for example, [Google Kubernetes Engine](https://cloud.google.com/kubernetes-engine/)).
1. Auto DevOps has more features including security testing, performance testing,
and code quality testing.
-1. It offers an incremental graduation path. If you need advanced customizations
+1. It offers an incremental graduation path. If you need advanced customizations,
you can start modifying the templates without having to start over on a
completely different platform.
@@ -204,31 +204,31 @@ Review the [requirements](#requirements) to ensure all necessary components to m
full use of Auto DevOps are available. If this is your fist time, we recommend you follow the
[quick start guide](quick_start_guide.md).
-GitLab.com users can enable/disable Auto DevOps at the project-level only. Self-managed users
-can enable/disable Auto DevOps at either the project-level or instance-level.
+GitLab.com users can enable/disable Auto DevOps at the project level only. Self-managed users
+can enable/disable Auto DevOps at either the project level or instance level.
-### Enable/disable Auto DevOps at the instance-level (Administrators only)
+### Enable/disable Auto DevOps at the instance level (Administrators only)
1. Go to **Admin area > Settings > Continuous Integration and Deployment**
-1. Check (or uncheck to disable) the box that reads "Default to Auto DevOps pipeline for all projects"
-1. Optionally, set up the Auto DevOps [base domain](#auto-devops-base-domain) which is going to be used for Auto Deploy and Auto Review Apps.
+1. Check (or uncheck to disable) the checkbox labeled **Default to Auto DevOps pipeline for all projects**.
+1. Optionally, set up the Auto DevOps [base domain](#auto-devops-base-domain) which will be used for Auto Deploy and Auto Review Apps.
1. Click **Save changes** for the changes to take effect.
NOTE: **Note:**
-Even when disabled at the instance-level, project maintainers will still be able to enable
-Auto DevOps at the project-level.
+Even when disabled at the instance level, project maintainers are still able to enable
+Auto DevOps at the project level.
-### Enable/disable Auto DevOps at the project-level
+### Enable Auto DevOps at the project level
-1. Check that your project doesn't have a `.gitlab-ci.yml`, or remove it otherwise
-1. Go to your project's **Settings > CI/CD > Auto DevOps**
-1. Check (or uncheck to disable) the box that reads "Default to Auto DevOps pipeline"
+1. Check that your project doesn't have a `.gitlab-ci.yml`, or if one exists, remove it.
+1. Go to your project's **Settings > CI/CD > Auto DevOps**.
+1. Check the **Default to Auto DevOps pipeline** checkbox.
1. Optionally, but recommended, add in the [base domain](#auto-devops-base-domain)
that will be used by Kubernetes to [deploy your application](#auto-deploy)
- and choose the [deployment strategy](#deployment-strategy)
-1. Hit **Save changes** for the changes to take effect
+ and choose the [deployment strategy](#deployment-strategy).
+1. Click **Save changes**.
-Once saved, an Auto DevOps pipeline will be triggered on the default branch.
+When the settings are saved, an Auto DevOps pipeline is triggered on the default branch.
NOTE: **Note:**
For GitLab versions 10.0 - 10.2, when enabling Auto DevOps, a pipeline needs to be
@@ -241,6 +241,12 @@ There is also a feature flag to enable Auto DevOps to a percentage of projects
which can be enabled from the console with
`Feature.get(:force_autodevops_on_by_default).enable_percentage_of_actors(10)`.
+### Disable Auto DevOps at the project level
+
+1. Go to your project's **Settings > CI/CD > Auto DevOps**.
+1. Uncheck the **Default to Auto DevOps pipeline** checkbox.
+1. Click **Save changes** for the changes to take effect.
+
### Deployment strategy
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/38542) in GitLab 11.0.
@@ -322,10 +328,11 @@ analysis on the current code and checks for potential security issues. Once the
report is created, it's uploaded as an artifact which you can later download and
check out.
-In GitLab Ultimate, any security warnings are also
+Any security warnings are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/sast.html).
-*Auto SAST stage will be skipped on licenses other than Ultimate.*
+NOTE: **Note:**
+The Auto SAST stage will be skipped on licenses other than Ultimate.
### Auto Dependency Scanning **[ULTIMATE]**
@@ -340,6 +347,9 @@ check out.
Any security warnings are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/dependency_scanning.html).
+NOTE: **Note:**
+The Auto Dependency Sacnning stage will be skipped on licenses other than Ultimate.
+
### Auto License Management **[ULTIMATE]**
> Introduced in [GitLab Ultimate][ee] 11.0.
@@ -353,7 +363,8 @@ check out.
Any licenses are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/license_management.html).
-*Auto License Management stage will be skipped on licenses other than Ultimate.*
+NOTE: **Note:**
+The Auto License Management stage will be skipped on licenses other than Ultimate.
### Auto Container Scanning
@@ -368,7 +379,8 @@ check out.
In GitLab Ultimate, any security warnings are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/container_scanning.html).
-*Auto Container Scanning stage will be skipped on licenses other than Ultimate.*
+NOTE: **Note:**
+The Auto Container Scanning stage will be skipped on licenses other than Ultimate.
### Auto Review Apps
@@ -389,7 +401,7 @@ branch's code so developers, designers, QA, product managers, and other
reviewers can actually see and interact with code changes as part of the review
process. Auto Review Apps create a Review App for each branch.
-Auto Review Apps will deploy your app to your kubernetes cluster only. When no cluster
+Auto Review Apps will deploy your app to your Kubernetes cluster only. When no cluster
is available, no deployment will occur.
The Review App will have a unique URL based on the project name, the branch
@@ -412,7 +424,8 @@ later download and check out.
In GitLab Ultimate, any security warnings are also
[shown in the merge request widget](https://docs.gitlab.com/ee//user/project/merge_requests/dast.html).
-*Auto DAST stage will be skipped on licenses other than Ultimate.*
+NOTE: **Note:**
+*The Auto DAST stage will be skipped on licenses other than Ultimate.*
### Auto Browser Performance Testing **[PREMIUM]**