You can configure automated deployments for your
[workloads](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/deploying-workloads-overview) on
Google Kubernetes Engine (GKE).

This page shows you how to set up a simple
continuous integration/continuous delivery (CI/CD) pipeline for the workload.
When you push a change to your repository, Cloud Build automatically builds
and deploys the container to your GKE cluster.

> [!NOTE]
> **Note:** You can set up a continuous-delivery pipeline to deploy to a progression of GKE clusters, with optional manual approval for any target cluster. For more information, see [Cloud Deploy](https://docs.cloud.google.com/deploy/docs/overview.md.txt).

## How an automated deployment works

If you have a workload that references a
single-container image in GKE, you can configure an
automated deployment, so that your application is re-built and deployed each time a
code change is checked into the repository.

With an automated deployment, you define your workload as a YAML file and store that
YAML file in your repository (consistent with best practices). GKE
generates YAML that you can use for this purpose.

You have the following two options for using YAML files:

- If you don't yet have a YAML file that defines your workload, you can use
  the generated YAML file. Save the YAML file in your repository.
  Cloud Build uses it to deploy your workload each time.

- If you already have a YAML file that defines your workload, you can point
  GKE to its location in your repository. You can compare the
  YAML file in your repository with the recommended YAML file to ensure
  you're deploying the correct workload in the correct way.

## Before you begin


Before you start, make sure that you have performed the following tasks:

- Enable the Google Kubernetes Engine API.
[Enable Google Kubernetes Engine API](https://console.cloud.google.com/apis/enableflow?apiid=container.googleapis.com)
- To use the Google Cloud CLI for this task, [install](https://docs.cloud.google.com/sdk/docs/install) and then [initialize](https://docs.cloud.google.com/sdk/docs/initialize.md.txt) the gcloud CLI. If you previously installed the gcloud CLI, get the latest version by running the `gcloud components update` command. Earlier gcloud CLI versions might not support running the commands in this document.

  > [!NOTE]
  > **Note:** For existing gcloud CLI installations, make sure to set the `compute/region` [property](https://docs.cloud.google.com/sdk/docs/properties.md.txt#setting_properties). If you use primarily zonal clusters, set the `compute/zone` instead. By setting a default location, you can avoid errors in the gcloud CLI like the following: `One of [--zone, --region] must be supplied: Please specify location`. You might need to specify the location in certain commands if the location of your cluster differs from the default that you set.

<!-- -->

- Enable the following additional APIs:

  - Cloud Build

    [Enable Cloud Build API](https://console.cloud.google.com/apis/library/cloudbuild.googleapis.com?q=cloud+build)
  - Cloud Source Repositories

    [Enable Cloud Source Repositories API](https://console.cloud.google.com/apis/library/sourcerepo.googleapis.com?q=source+repositories)
  - Artifact Registry

    [Enable Artifact Registry API](https://console.cloud.google.com/apis/library/artifactregistry.googleapis.com)

## Requirements

Automated deployments have the following requirements:

- You can only use an automated deployment with workloads of type
  `Deployment` that specify a single container image. Multi-container workloads
  and other workload types (for example, `ReplicaSet`) are not supported.

- Your source-code repository must contain a Dockerfile to build the image.

  You can host this repository on one of the following products:
  - [Cloud Source Repositories](https://docs.cloud.google.com/source-repositories)
  - GitHub
  - Bitbucket

  If you use GitHub or Bitbucket, you need to grant Google Cloud access to your
  repository.
- Store your container image in Artifact Registry, in the same
  Google Cloud project as your GKE cluster. You need to have the
  image in Artifact Registry, and you need to have
  [deployed](https://docs.cloud.google.com/kubernetes-engine/docs/how-to/deploying-workloads-overview) it at
  least once, so that you have a workload in GKE.

## Creating the automated deployment

To create an automated deployment, perform the following steps:

1. Go to the **Workloads** page in the Google Cloud console.

   [Go to Workloads](https://console.cloud.google.com/kubernetes/workload)
2. In the workloads list, click the name of the Deployment you want to modify.

3. Click **Actions \> Automated deployment**.

In the **Automate deployment** pane, perform the following steps:

1. Under **Source repository**, choose your source code repository:

   1. In the **Repository Provider** drop-down list, choose the provider for your
      repository

      An automated deployment supports the following source control hosts:
      - Cloud Source Repositories
      - GitHub
      - Bitbucket

        If you are using GitHub or Bitbucket, authenticate with your username
        and password.

        > [!NOTE]
        > **Note:** An automated deployment creates a mirror of your GitHub or Bitbucket repositories on Cloud Source Repositories. When you push changes to your original repository, Cloud Source Repositories picks up the changes automatically.

   2. From the **Repository** drop-down list, select the name of the repository
      containing the source code for your Deployment.

   3. Click **Continue**.

2. Under **Build configurations**, specify the Build configuration information:

   1. Enter the name of the branch from which you want to build, or a regular expression ([RegExp2](https://github.com/google/re2/wiki/Syntax)) to match the branch or branches. The default branch is `master`. When you push to this branch, Cloud Build builds your application.
   2. Enter the relative path of the **Dockerfile directory**.
   3. Enter the **Dockerfile name**.

      > [!NOTE]
      > **Note:** The **Image name** field is automatically generated based on the repository name.

   4. Select a service account to use when executing the build. If the service account is missing the **roles/container.developer** permission, grant the permission to the selected service account by clicking **Grant all**.

   5. Click **Continue**.

3. Under **Automated deployment configuration**, provide the configuration YAML
   file location.

   The system automatically generates a YAML file, which you can use to
   populate the YAML file in your repository.
   1. Click **View Google-recommended YAML** to see the generated YAML file.

   2. Compare it to your own YAML file, if you have it, and update yours based
      on this one.

      Otherwise, create a new file and populate it with the generated YAML. This
      helps ensure the workload that gets deployed matches what's currently
      running. The file can have any name, but must have a `.yaml` or `.yml`
      extension.
   3. Specify the relative path to the directory that contains the YAML file.

      If there is more than one YAML file in the specified directory,
      GKE uses all of them.
4. Click **Set Up** to finish configuring your automated deployment.

## What happens next

After you set up automated deployment for the selected workload, you have a
[Cloud Build
trigger](https://docs.cloud.google.com/build/docs/automating-builds/create-manage-triggers) that builds a container image after a push to the selected branch
of the repository. Cloud Build also deploys a new revision of your
workload to the cluster where the original image was deployed.

For more information on your workload, see the **Deployment Details** page
(Revision History tab).