Auto Deploy

Notes:

Introduced in GitLab 8.15.
Auto deploy is an experimental feature and is not recommended for Production use at this time.
As of GitLab 9.1, access to the Container Registry is only available while the Pipeline is running. Restarting a pod, scaling a service, or other actions which require on-going access will fail. On-going secure access is planned for a subsequent release.

Auto deploy 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).

How it works

The Autodeploy templates are based on the kubernetes-deploy project which is used to simplify the deployment process to Kubernetes by providing intelligent build, deploy, and destroy commands which you can use in your .gitlab-ci.yml as is. It uses Herokuish, which uses Heroku buildpacks to do some of the work, plus some of GitLab's own tools to package it all up. For your convenience, a Docker image is also provided.

You can use the Kubernetes project service to store credentials to your infrastructure provider and they will be available during the deployment.

Quick start

We made a simple guide to using Auto Deploy with GitLab.com.

Supported templates

The list of supported auto deploy templates is available in the gitlab-ci-yml project.

Configuration

Note: In order to understand why the following steps are required, read the how it works section.

To configure Autodeploy, you will need to:

Enable a deployment project service to store your credentials. For example, if you want to deploy to OpenShift you have to enable Kubernetes service.
Configure GitLab Runner to use the Docker or Kubernetes executor with privileged mode enabled.
Navigate to the "Project" tab and click "Set up auto deploy" button.
Select a template.
Commit your changes and create a merge request.
Test your deployment configuration using a Review App that was created automatically for you.

Private project support

Experimental support introduced in GitLab 9.1.

When a project has been marked as private, GitLab's Container Registry requires authentication when downloading containers. Auto deploy will automatically provide the required authentication information to Kubernetes, allowing temporary access to the registry. Authentication credentials will be valid while the pipeline is running, allowing for a successful initial deployment.

After the pipeline completes, Kubernetes will no longer be able to access the container registry. Restarting a pod, scaling a service, or other actions which require on-going access to the registry will fail. On-going secure access is planned for a subsequent release.

PostgreSQL database support

Experimental support introduced in GitLab 9.1.

In order to support applications that require a database, PostgreSQL is provisioned by default. Credentials to access the database are preconfigured, but can be customized by setting the associated variables. These credentials can be used for defining a DATABASE_URL of the format: postgres://user:password@postgres-host:postgres-port/postgres-database. It is important to note that the database itself is temporary, and contents will be not be saved.

PostgreSQL provisioning can be disabled by setting the variable DISABLE_POSTGRES to "yes".

The following PostgreSQL variables are supported:

DISABLE_POSTGRES: "yes": disable automatic deployment of PostgreSQL
POSTGRES_USER: "my-user": use custom username for PostgreSQL
POSTGRES_PASSWORD: "password": use custom password for PostgreSQL
POSTGRES_DB: "my database": use custom database name for PostgreSQL

Auto Monitoring

Introduced in GitLab 9.5.

Apps auto-deployed using one the Kubernetes templates can also be automatically monitored for:

Response Metrics: latency, throughput, error rate
System Metrics: CPU utilization, memory utilization

Metrics are gathered from nginx-ingress and Kubernetes.

To view the metrics, open the Monitoring dashboard for a deployed environment.

Configuring Auto Monitoring

If GitLab has been deployed using the omnibus-gitlab Helm chart, no configuration is required.

If you have installed GitLab using a different method:

Deploy Prometheus into your Kubernetes cluster
If you would like response metrics, ensure you are running at least version 0.9.0 of NGINX Ingress and enable Prometheus metrics.
Finally, annotate the NGINX Ingress deployment to be scraped by Prometheus using prometheus.io/scrape: "true" and prometheus.io/port: "10254".

7 KiB Raw Blame History