This quickstart shows you how to use Config Sync to implement a GitOps approach
for managing your Google Kubernetes Engine clusters. With a GitOps
workflow, you use a Git repository as the single source of truth for your
cluster configurations.

By using Config Sync, you get the following benefits:

- **Enforce consistency:** helps to ensure that all your clusters have the same configuration, reducing the risk of configuration drift.
- **Improve security:** centrally manage and audit your cluster configurations, making it easier to enforce security policies.
- **Increase velocity:** automate the rollout of configuration changes, letting you to deploy changes faster and more reliably.

In this tutorial, you create a GKE cluster and configure Config Sync to
sync configuration files from a sample repository. This tutorial helps you understand how
Config Sync works and gives you experience
using Config Sync to manage your clusters in a consistent and automated way.

## Before you begin

1.

   Make sure that you have the following role or roles on the project:

   Kubernetes Engine Admin

   #### Check for the roles

   1.
      In the Google Cloud console, go to the **IAM** page.

      [Go to IAM](https://console.cloud.google.com/projectselector/iam-admin/iam?supportedpurview=project)
   2. Select the project.
   3.
      In the **Principal** column, find all rows that identify you or a group that
      you're included in. To learn which groups you're included in, contact your
      administrator.

   4. For all rows that specify or include you, check the **Role** column to see whether the list of roles includes the required roles.

   #### Grant the roles

   1.
      In the Google Cloud console, go to the **IAM** page.

      [Go to IAM](https://console.cloud.google.com/projectselector/iam-admin/iam?supportedpurview=project)
   2. Select the project.
   3. Click **Grant access**.
   4.
      In the **New principals** field, enter your user identifier.

      This is typically the email address for a Google Account.

   5. Click **Select a role**, then search for the role.
   6. To grant additional roles, click **Add
      another role** and add each additional role.
   7. Click **Save**.

## Create a cluster

In this section, you create a cluster that you can use in this tutorial.
Although in a real-world scenario you would likely manage multiple
clusters, to simplify this tutorial you only create and manage one cluster.

To create a cluster, complete the following steps:

1. Enable the Google Kubernetes Engine API.

   [Go to GKE](https://console.cloud.google.com/apis/library/container.googleapis.com)
2. In the Google Cloud console, go to the **Kubernetes Engine** page.

   [Go to Google Kubernetes Engine](https://console.cloud.google.com/kubernetes/list)
3. Click **Create**.

4. In the **Autopilot** section, select **Configure**.

5. In the **Cluster basics** section, enter `cs-cluster` in the **Name**
   field. Leave all other fields with their recommended defaults.

6. Click **Create** . You are taken to the **Kubernetes clusters** page. It
   takes several minutes for your cluster to be created. When you see a green
   check mark in the **Status** column next to your cluster, it's ready.

## Configure your cluster

Now that you have a cluster, you can configure Config Sync to sync
configuration files from a Git repository.

To configure Config Sync in the Google Cloud console, complete the following
steps:

1. In the Google Cloud console, go to the **Config** page under the **Features** section.

   <br />

   [Go to Config](https://console.cloud.google.com/kubernetes/config_management)
2. Click **Install Config Sync**.
3. Select the Config Sync version that you want to use.
4. Under **Installation options** , select **Install Config Sync on individual clusters**.
5. In the **Available clusters** table, select `cs-cluster` and click **Install Config Sync** . In the **Settings** tab, you should see the status for the `cs-cluster` as **Enabled** after a few minutes.
6. On the **Config Sync dashboard** , click **Deploy cluster package**.
7. In the **Select clusters for package deployment** table, select `cs-cluster` and then click **Continue**.
8. Leave **Package hosted on Git** selected and then click **Continue**.
9. In the **Package name** field, enter `sample-repository`.
10. In the **Repository URL** field, enter `https://github.com/GoogleCloudPlatform/anthos-config-management-samples`.
11. In the **Path** field, enter `config-sync-quickstart/multirepo/root`.
12. Leave all other fields with their default values.
13. Click **Deploy Package**.

    After a few minutes, you should see **Synced** in the **Sync status**
    column for `cs-cluster`.

Now that Config Sync is synced to a repository, it continuously reconciles
the state of your clusters with the configs in the repository.

## View package details

To view the objects managed by Config Sync, go to the **Packages** tab and
click `cs-cluster`. The package details page provides an overview of all synced
resources, including the resource type and which namespace the resource is
synced to.

## (Optional) Explore the sample repository

The configurations applied to your cluster are defined in the
[`/config-sync-quickstart/multirepo/`](https://github.com/GoogleCloudPlatform/anthos-config-management-samples/tree/main/config-sync-quickstart/multirepo)
repository. This sample demonstrates a multi-repository setup where
cluster-admin-level configurations, represented by the `root` repository, are
separated from namespace-level configurations, represented by the `namespaces`
repository. In this example, these configurations are split into different
folders. In a real-world scenario, you could store configurations in two different
repositories with different access permissions.

At a high level, cluster-level or root repositories are typically managed by a
central administrator and contain cluster-wide resources, namespace
configurations, and policies. Namespace-level repositories typically contain
configurations specific to individual namespaces and are often managed by
application teams.

Some of the key types of files that you might store in a root repository include
the following:

- **Namespace creation:** files like `namespace-gamestore.yaml` create the namespaces themselves.
- **Cluster-scoped resources:** files that affect the entire cluster include resources like `ClusterRole` objects which add cluster-wide roles that grant permissions.
- **Connecting namespace repositories:** the key file in this multi-repository setup is the `reposync-gamestore.yaml` file. This `RepoSync` object tells Config Sync to sync configurations for the `gamestore` namespace from a different path. In this example, the `RepoSync` object points to the `config-sync-quickstart/multirepo/ namespaces/gamestore` directory within the same repository, but in a real-world scenario, you could point to a different Git repository.

The namespace repository contains application-specific configurations for the
`gamestore` namespace. For example, the `configmap-inventory.yaml` file contains
inventory data for the `gamestore` application. This type of GitOps setup
lets application teams have more autonomy over their own deployments and
namespace-scoped resources without needing to modify the central root
repository.

## Clean up

1. Go to the GKE menu in Google Cloud console.

   [Go to GKE](https://console.cloud.google.com/kubernetes/list)
2. Next to the `cs-cluster`, click **Actions** , then click **Delete**.

3. When prompted to confirm, click **Delete** again.

## What's next

- Learn about [validating configs](https://docs.cloud.google.com/kubernetes-engine/config-sync/docs/how-to/validating-configs.md.txt).