2021-01-29 00:20:46 +05:30
---
stage: Configure
group: Configure
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2021-01-29 00:20:46 +05:30
---
2021-03-11 19:13:27 +05:30
# Requirements for Auto DevOps **(FREE)**
2020-06-23 00:09:42 +05:30
2021-02-22 17:27:13 +05:30
You can set up Auto DevOps for [Kubernetes ](#auto-devops-requirements-for-kubernetes ),
[Amazon Elastic Container Service (ECS) ](#auto-devops-requirements-for-amazon-ecs ),
or [Amazon Cloud Compute ](#auto-devops-requirements-for-amazon-ecs ).
2020-06-23 00:09:42 +05:30
For more information about Auto DevOps, see [the main Auto DevOps page ](index.md )
or the [quick start guide ](quick_start_guide.md ).
## Auto DevOps requirements for Kubernetes
To make full use of Auto DevOps with Kubernetes, you need:
- **Kubernetes** (for [Auto Review Apps ](stages.md#auto-review-apps ),
[Auto Deploy ](stages.md#auto-deploy ), and [Auto Monitoring ](stages.md#auto-monitoring ))
To enable deployments, you need:
1. A [Kubernetes 1.12+ cluster ](../../user/project/clusters/index.md ) for your
project. The easiest 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, you must perform additional configuration for
[Auto Deploy for Kubernetes 1.16+ ](stages.md#kubernetes-116 ).
2021-09-04 01:27:46 +05:30
1. For external HTTP traffic, an Ingress controller is required. For regular
deployments, any Ingress controller should work, but as of GitLab 14.0,
[canary deployments ](../../user/project/canary_deployments.md ) require
NGINX Ingress. You can deploy the NGINX Ingress controller to your
Kubernetes cluster either through the GitLab [Cluster management project template ](../../user/clusters/management_project_template.md )
or manually by using the [`ingress-nginx` ](https://github.com/kubernetes/ingress-nginx/tree/master/charts/ingress-nginx )
Helm chart.
2020-06-23 00:09:42 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2021-09-04 01:27:46 +05:30
For metrics to appear when using the [Prometheus cluster integration ](../../user/clusters/integrations.md#prometheus-cluster-integration ), you must [enable Prometheus metrics ](https://github.com/kubernetes/ingress-nginx/tree/master/charts/ingress-nginx#prometheus-metrics ).
When deploying [using custom charts ](customize.md#custom-helm-chart ), you must also
2020-06-23 00:09:42 +05:30
[annotate ](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ )
2021-09-04 01:27:46 +05:30
the Ingress manifest to be scraped by Prometheus using
2020-06-23 00:09:42 +05:30
`prometheus.io/scrape: "true"` and `prometheus.io/port: "10254"` .
2021-09-04 01:27:46 +05:30
NOTE:
If your cluster is installed on bare metal, see
[Auto DevOps Requirements for bare metal ](#auto-devops-requirements-for-bare-metal ).
2020-06-23 00:09:42 +05:30
- **Base domain** (for [Auto Review Apps ](stages.md#auto-review-apps ),
[Auto Deploy ](stages.md#auto-deploy ), and [Auto Monitoring ](stages.md#auto-monitoring ))
2021-03-11 19:13:27 +05:30
You must [specify the Auto DevOps base domain ](index.md#auto-devops-base-domain ),
which all of your Auto DevOps applications use. This domain must be configured
with wildcard DNS.
2020-06-23 00:09:42 +05:30
- **GitLab Runner** (for all stages)
2020-11-24 15:15:51 +05:30
Your runner must be configured to run Docker, usually with either the
2020-06-23 00:09:42 +05:30
[Docker ](https://docs.gitlab.com/runner/executors/docker.html )
or [Kubernetes ](https://docs.gitlab.com/runner/executors/kubernetes.html ) executors, with
[privileged mode enabled ](https://docs.gitlab.com/runner/executors/docker.html#use-docker-in-docker-with-privileged-mode ).
2020-11-24 15:15:51 +05:30
The runners don't need to be installed in the Kubernetes cluster, but the
2020-06-23 00:09:42 +05:30
Kubernetes executor is easy to use and automatically autoscales.
2020-11-24 15:15:51 +05:30
You can configure Docker-based runners to autoscale as well, using
2020-06-23 00:09:42 +05:30
[Docker Machine ](https://docs.gitlab.com/runner/install/autoscaling.html ).
2021-09-04 01:27:46 +05:30
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 )
that are assigned to specific projects.
2020-06-23 00:09:42 +05:30
- **Prometheus** (for [Auto Monitoring ](stages.md#auto-monitoring ))
To enable Auto Monitoring, you need Prometheus installed either inside or
outside your cluster, and configured to scrape your Kubernetes cluster.
2021-09-04 01:27:46 +05:30
If you've configured the GitLab integration with Kubernetes, you can
instruct GitLab to query an in-cluster Prometheus by enabling
the [Prometheus cluster integration ](../../user/clusters/integrations.md#prometheus-cluster-integration ).
2020-06-23 00:09:42 +05:30
2021-09-04 01:27:46 +05:30
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 ).
2020-06-23 00:09:42 +05:30
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 ).
- **cert-manager** (optional, for TLS/HTTPS)
2021-09-04 01:27:46 +05:30
To enable HTTPS endpoints for your application, you can [install cert-manager ](https://cert-manager.io/docs/installation/kubernetes/ ),
2020-06-23 00:09:42 +05:30
a native Kubernetes certificate management controller that helps with issuing
certificates. Installing cert-manager on your cluster issues a
2021-04-29 21:17:54 +05:30
[Let's Encrypt ](https://letsencrypt.org/ ) certificate and ensures the
2021-09-04 01:27:46 +05:30
certificates are valid and up-to-date.
2020-06-23 00:09:42 +05:30
2021-09-04 01:27:46 +05:30
If you don't have Kubernetes or Prometheus configured, then
2020-06-23 00:09:42 +05:30
[Auto Review Apps ](stages.md#auto-review-apps ),
[Auto Deploy ](stages.md#auto-deploy ), and [Auto Monitoring ](stages.md#auto-monitoring )
are skipped.
2021-04-17 20:07:23 +05:30
After all requirements are met, you can [enable Auto DevOps ](index.md#enable-or-disable-auto-devops ).
2020-06-23 00:09:42 +05:30
## Auto DevOps requirements for Amazon ECS
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/208132) in GitLab 13.0.
2020-07-28 23:09:34 +05:30
You can choose to target [AWS ECS ](../../ci/cloud_deployment/index.md ) as a deployment platform instead of using Kubernetes.
2020-06-23 00:09:42 +05:30
2021-04-17 20:07:23 +05:30
To get started on Auto DevOps to AWS ECS, you must add a specific CI/CD variable.
To do so, follow these steps:
2020-06-23 00:09:42 +05:30
2021-04-17 20:07:23 +05:30
1. In your project, go to **Settings > CI/CD** and expand the **Variables**
2020-06-23 00:09:42 +05:30
section.
1. Specify which AWS platform to target during the Auto DevOps deployment
2020-07-28 23:09:34 +05:30
by adding the `AUTO_DEVOPS_PLATFORM_TARGET` variable with one of the following values:
- `FARGATE` if the service you're targeting must be of launch type FARGATE.
- `ECS` if you're not enforcing any launch type check when deploying to ECS.
2020-06-23 00:09:42 +05:30
2020-07-28 23:09:34 +05:30
When you trigger a pipeline, if you have Auto DevOps enabled and if you have correctly
2021-04-17 20:07:23 +05:30
[entered AWS credentials as variables ](../../ci/cloud_deployment/index.md#deploy-your-application-to-the-aws-elastic-container-service-ecs ),
2021-02-22 17:27:13 +05:30
your application is deployed to AWS ECS.
2020-07-28 23:09:34 +05:30
2020-06-23 00:09:42 +05:30
If you have both a valid `AUTO_DEVOPS_PLATFORM_TARGET` variable and a Kubernetes cluster tied to your project,
2021-02-22 17:27:13 +05:30
only the deployment to Kubernetes runs.
2020-06-23 00:09:42 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
Setting the `AUTO_DEVOPS_PLATFORM_TARGET` variable to `ECS` triggers jobs
2020-06-23 00:09:42 +05:30
defined in the [`Jobs/Deploy/ECS.gitlab-ci.yml` template ](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Jobs/Deploy/ECS.gitlab-ci.yml ).
However, it's not recommended to [include ](../../ci/yaml/README.md#includetemplate )
it on its own. This template is designed to be used with Auto DevOps only. It may change
unexpectedly causing your pipeline to fail if included on its own. Also, the job
2020-07-28 23:09:34 +05:30
names within this template may also change. Do not override these jobs' names in your
2021-02-22 17:27:13 +05:30
own pipeline, as the override stops working when the name changes.
## Auto DevOps requirements for Amazon EC2
[Introduced ](https://gitlab.com/gitlab-org/gitlab/-/issues/216008 ) in GitLab 13.6.
You can target [AWS EC2 ](../../ci/cloud_deployment/index.md )
as a deployment platform instead of Kubernetes. To use Auto DevOps with AWS EC2, you must add a
2021-04-17 20:07:23 +05:30
specific CI/CD variable.
2021-02-22 17:27:13 +05:30
For more details, see [Custom build job for Auto DevOps ](../../ci/cloud_deployment/index.md#custom-build-job-for-auto-devops )
for deployments to AWS EC2.
2021-09-04 01:27:46 +05:30
## Auto DevOps requirements for bare metal
According to the [Kubernetes Ingress-NGINX docs ](https://kubernetes.github.io/ingress-nginx/deploy/baremetal/ ):
> In traditional cloud environments, where network load balancers are available on-demand,
a single Kubernetes manifest suffices to provide a single point of contact to the NGINX Ingress
controller to external clients and, indirectly, to any application running inside the cluster.
Bare-metal environments lack this commodity, requiring a slightly different setup to offer the
same kind of access to external consumers.
The docs linked above explain the issue and present possible solutions, for example:
- Through [MetalLB ](https://github.com/metallb/metallb ).
- Through [PorterLB ](https://github.com/kubesphere/porterlb ).
