summaryrefslogtreecommitdiff
path: root/doc/development/auto_devops.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2019-10-02 06:06:28 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2019-10-02 06:06:28 +0000
commit404bb44ef7dfc2b0d4da6b946b8b96007aca4b56 (patch)
treedbc4049f82cb048b471e853c6015ac303981cef9 /doc/development/auto_devops.md
parentd14219486e0f3b6e642eaeff0862dea169e5d260 (diff)
downloadgitlab-ce-404bb44ef7dfc2b0d4da6b946b8b96007aca4b56.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/auto_devops.md')
-rw-r--r--doc/development/auto_devops.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/development/auto_devops.md b/doc/development/auto_devops.md
new file mode 100644
index 00000000000..f88bcc9cfb8
--- /dev/null
+++ b/doc/development/auto_devops.md
@@ -0,0 +1,42 @@
+# Auto DevOps development guide
+
+This document provides a development guide for contributors to
+[Auto DevOps](../topics/autodevops/index.md)
+
+## Development
+
+Auto DevOps builds on top of GitLab CI to create an automatic pipeline
+based on your project contents. When Auto DevOps is enabled for a
+project, the user does not need to explicitly include any pipeline configuration
+through a [`.gitlab-ci.yml` file](../ci/yaml/README.md).
+
+In the absence of a `.gitlab-ci.yml` file, the [Auto DevOps CI
+template](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Auto-DevOps.gitlab-ci.yml)
+is used implicitly to configure the pipeline for the project. This
+template is a top-level template that includes other sub-templates,
+which then defines jobs.
+
+Some jobs use images that are built from external projects:
+
+- [Auto Build](../topics/autodevops/index.md#auto-build) uses
+ [configuration](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml)
+ in which the `build` job uses an image that is built using the
+ [`auto-build-image`](https://gitlab.com/gitlab-org/cluster-integration/auto-build-image)
+ project.
+- [Auto Deploy](../topics/autodevops/index.md#auto-deploy) uses
+ [configuration](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/gitlab/ci/templates/Jobs/Deploy.gitlab-ci.yml)
+ in which the jobs defined in this template use an image that is built using the
+ [`auto-deploy-image`](https://gitlab.com/gitlab-org/cluster-integration/auto-deploy-image)
+ project. By default, the Helm chart defined in
+ [`auto-deploy-app`](https://gitlab.com/gitlab-org/charts/auto-deploy-app)
+ is used to deploy.
+
+There are extra variables that get passed to the CI jobs when Auto
+DevOps is enabled that are not present in a normal CI job. These can be
+found in
+[`ProjectAutoDevops`](https://gitlab.com/gitlab-org/gitlab/blob/bf69484afa94e091c3e1383945f60dbe4e8681af/app/models/project_auto_devops.rb).
+
+## Development environment
+
+Configuring [GDK for Auto
+DevOps](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/auto_devops.md).