summaryrefslogtreecommitdiff
path: root/doc/ci/autodeploy/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ci/autodeploy/index.md')
-rw-r--r--doc/ci/autodeploy/index.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/ci/autodeploy/index.md b/doc/ci/autodeploy/index.md
new file mode 100644
index 00000000000..503a00969d5
--- /dev/null
+++ b/doc/ci/autodeploy/index.md
@@ -0,0 +1,39 @@
+# Autodeploy
+
+> [Introduced][mr-8135] in GitLab 8.15.
+
+Autodeploy is an easy way to configure GitLab CI for the deployment of your
+application. GitLab Community maintains a list of `.gitlab-ci.yml`
+templates for various infrastructure providers and deployment scripts
+powering them. These scripts are responsible for packaging your application,
+setting up the infrastructure and spinning up necessary services (for
+example a database).
+
+You can use [project services][project-services] to store credentials to
+your infrastructure provider and they will be available during the
+deployment.
+
+## Supported templates
+
+The list of supported autodeploy templates is available [here][autodeploy-templates].
+
+## Configuration
+
+1. Enable a deployment [project service][project-services] to store your
+credentials. For example, if you want to deploy to a Kubernetes cluster
+you have to enable [Kubernetes service][kubernetes-service].
+1. Configure GitLab Runner to use [docker-in-docker executor][docker-in-docker].
+1. Navigate to the "Project" tab and click "Set up autodeploy" button.
+ ![Autodeploy button](img/autodeploy_button.png)
+1. Select a template.
+ ![Dropdown with autodeploy templates](img/autodeploy_dropdown.png)
+1. Commit your changes and create a merge request.
+1. Test your deployment configuration using a [Review App][review-app] that was
+created automatically for you.
+
+[mr-8135]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8135
+[project-services]: ../../project_services/project_services.md
+[autodeploy-templates]: https://gitlab.com/gitlab-org/gitlab-ci-yml/tree/master/autodeploy
+[kubernetes-service]: ../../project_services/kubernetes.md
+[docker-in-docker]: ../docker/using_docker_build.md#use-docker-in-docker-executor
+[review-app]: ../review_apps/index.md