Installing with the GKE add-on

Standard

---

Note: Config Controller is now available. Config Controller is a managed offering of Config Connector that is hosted and managed by Google Cloud. We recommend using Config Controller instead of installing and managing Config Connector yourself.

This page describes how to install Config Connector on a Google Kubernetes Engine (GKE) cluster using the Config Connector add-on.

If you are using GKE on Google Cloud, we recommend you install Config Connector using this add-on. For details on other installation options, see Choosing an installation type.

Before you begin

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

• Enable the Google Kubernetes Engine API.
Enable Google Kubernetes Engine API
• If you want to use the Google Cloud CLI for this task, install and then initialize the gcloud CLI.
  Note: For existing gcloud CLI installations, make sure to set the compute/region and compute/zone properties. By setting default locations, you can avoid errors in gcloud CLI like the following: One of [--zone, --region] must be supplied: Please specify location.

• Select or create a Google Cloud project to install Config Connector in.

Installing the Config Connector add-on

You use the Config Connector add-on by creating a new GKE cluster, or enabling it on an existing cluster. After installing the Config Connector add-on, you configure your Config Connector installation with your Google service accounts and your namespaces.

Note: When you enable the Config Connector add-on, Config Connector creates a namespace called configconnector-operator-system. Do not make any changes or add any resources to this namespace.

Requirements

The Config Connector add-on has the following requirements:

• You must use a GKE version of:

  • 1.15.11-gke.5 and later
  • 1.16.8-gke.8 and later
  • 1.17.4-gke.5 and later

• You must enable a Workload Identity pool and Kubernetes Engine Monitoring on the clusters where you enable Config Connector.

Setting up a GKE cluster

You can use the Config Connector add-on on a new or existing cluster.

Creating a new cluster with the Config Connector add-on enabled

You can create a GKE cluster using the gcloud CLI or the Google Cloud console.

gcloud

To create a cluster with the Google Cloud CLI run the following command:

gcloud container clusters create CLUSTER_NAME \
    --release-channel CHANNEL \
    --addons ConfigConnector \
    --workload-pool=PROJECT_ID.svc.id.goog \
    --logging=SYSTEM \
    --monitoring=SYSTEM

Replace the following:

• CLUSTER_NAME with the name of your GKE cluster.
• CHANNEL with a GKE release channel, rapid and regular are supported.
• PROJECT_ID with your Google Cloud project ID.

Google Cloud console

To create a cluster with the Google Cloud console, perform the following steps:

1. Visit the Google Kubernetes Engine menu in Google Cloud console.

   Visit the Google Kubernetes Engine menu

2. Click Create. The Create a Kubernetes cluster page appears.

3. Specify a Name for your cluster.

4. Choose a supported Master version.

5. Configure the rest of your cluster as you want.

6. From the navigation pane, under Cluster, click Security.

7. Select the Enable Workload Identity checkbox.

8. From the navigation pane on the left side, under Cluster, click Features.

9. Select the Enable Config Connector checkbox.

10. Click Create.

After you've created the cluster, move on to Creating an identity.

Enabling the Config Connector add-on on an existing cluster

You can enable the Config Connector add-on on an existing GKE cluster with gcloud or the Google Cloud console.

Prerequisites

Enabling the Config Connector add-on on an existing cluster has the following prerequisites:

• You need a cluster that meets the requirements for the Config Connector add-on.

• Set up Workload Identity on the cluster where you want to install Config Connector.

  Note: Enabling Workload Identity on an existing cluster does not automatically enable Workload Identity on the cluster's existing node pools. We recommend that you enable Workload Identity on all your cluster's node pools since Config Connector could run on any of them.

To enable Workload Identity for a node pool, use the gcloud command-line tool:

gcloud container node-pools update NODE_POOL \
    --workload-metadata=GKE_METADATA \
    --cluster CLUSTER_NAME

Replace the following:

• NODE_POOL with your node pool's name
• CLUSTER_NAME with your cluster's name

Enabling the Config Connector add-on

You can enable the Config Connector add-on in an existing GKE cluster with the Google Cloud CLI or the Google Cloud console.

gcloud

To enable the Config Connector add-on in an existing GKE cluster use the Google Cloud CLI:

gcloud container clusters update CLUSTER_NAME \
    --update-addons ConfigConnector=ENABLED

Replace CLUSTER_NAME with the name of your GKE cluster.

Google Cloud console

1. Visit the Google Kubernetes Engine menu in Google Cloud console.

   Visit the Google Kubernetes Engine menu

2. Select the cluster that you want to install Config Connector on. The Cluster Details page appears.

3. Under the Features section, locate the Config Connector row and click Edit.

4. Select the Enable Config Connector checkbox and click Save Changes to update your cluster.

Creating an identity

Config Connector creates and manages Google Cloud resources by authenticating with a Identity and Access Management (IAM) service account and using GKE's Workload Identity to bind IAM service accounts with Kubernetes service accounts.

Note: You only need to perform these steps once per cluster.

To create the identity, complete the following steps:

1. Create an IAM service account. If you want to use an existing service account, you can use that account and skip this step.
   
   To create the service account, use the following command:

     gcloud iam service-accounts create SERVICE_ACCOUNT_NAME

   Replace SERVICE_ACCOUNT_NAME with a name for your service account.

To learn more about creating service accounts, see Creating and managing service accounts.

2. Give the IAM service account elevated permissions on your project:

   gcloud projects add-iam-policy-binding PROJECT_ID \
       --member="serviceAccount:SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com" \
       --role="roles/editor"

   Replace the following:
   • PROJECT_ID with your project ID.
   • SERVICE_ACCOUNT_NAME with your service account's name.
   Note: Granting the editor role allows most Config Connector functionality except project and organization wide configurations such as IAM modifications. In a production environment, we recommend that you set more granular permissions. For more information about IAM roles, see Understanding roles.
3. Create an IAM policy binding between the IAM service account and the predefined Kubernetes service account that Config Connector runs:

   gcloud iam service-accounts add-iam-policy-binding \
   SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com \
       --member="serviceAccount:PROJECT_ID.svc.id.goog[cnrm-system/cnrm-controller-manager]" \
       --role="roles/iam.workloadIdentityUser"

   Replace the following:
   • SERVICE_ACCOUNT_NAME with your service account's name.
   • PROJECT_ID with your project ID.

Configuring Config Connector

Note: When you enable the Config Connector add-on, it automatically creates a ConfigConnector CustomResource that is configured in namespaced-mode. This is done for legacy reasons. You must still complete the following steps to configure the ConfigConnector to use cluster-mode. If you'd like to install Config Connector in namespaced-mode instead, see these installation instructions.

To complete the installation, create a configuration file for the ConfigConnector CustomResource, then apply it using the kubectl apply command. The Config Connector Operator installs Google Cloud Resource CRDs and Config Connector components in your cluster.

To configure the operator, complete the following steps:

1. Copy the following YAML file into a file named configconnector.yaml:

   # configconnector.yaml
   apiVersion: core.cnrm.cloud.google.com/v1beta1
   kind: ConfigConnector
   metadata:
     # the name is restricted to ensure that there is only one
     # ConfigConnector resource installed in your cluster
     name: configconnector.core.cnrm.cloud.google.com
   spec:
    mode: cluster
    googleServiceAccount: "SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com"
   

   Replace the following:
   • SERVICE_ACCOUNT_NAME with your service account's name.
   • PROJECT_ID with your project ID.
2. Apply the configuration to your cluster with kubectl apply:

     kubectl apply -f configconnector.yaml

Specifying where to create your resources

Config Connector can organize resources by project, folder, or organization, which is the same way you would organize resources with Google Cloud.

Before creating resources with Config Connector, you must configure where to create your resources. To determine where to create the resource, Config Connector uses an annotation on either the resource configuration or an existing Namespace. For more information, see Organizing resources.

If you do not have a Namespace for this purpose, create one with kubectl.

kubectl create namespace NAMESPACE

Replace NAMESPACE with your namespace name. For example config-connector.

Select a tab to choose where you want Config Connector to create resources.

Project

To create resources in a certain project, run the following command:

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/project-id=PROJECT_ID

Replace the following:

• NAMESPACE with your namespace name.
• PROJECT_ID with your Google Cloud project ID.

Folder

To create resources in a certain folder, run the following command:

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/folder-id=FOLDER_ID

Replace the following:

• NAMESPACE with your namespace name.
• FOLDER_ID with your Google Cloud folder ID.

Organization

To create resources in a certain organization, run the following command:

    kubectl annotate namespace \
    NAMESPACE cnrm.cloud.google.com/organization-id=ORGANIZATION_ID

Replace the following:

• NAMESPACE with your namespace name.
• ORGANIZATION_ID with your Google Cloud organization ID.

When you annotate your namespace, Config Connector creates resources in the corresponding project, folder or organization. To learn more about how Config Connector uses Kubernetes namespaces, see Kubernetes Namespaces and Google Cloud projects.

Verifying your installation

Config Connector runs all of its components in a namespace named cnrm-system. You can verify the Pods are ready by running the following command:

kubectl wait -n cnrm-system \
      --for=condition=Ready pod --all

If Config Connector is installed correctly, the output is similar to the following:

pod/cnrm-controller-manager-0 condition met

Note: The controller Pod can take several minutes to start.

Upgrading Config Connector

Upgrades to your cluster's Config Connector add-on are managed by Google Cloud.

If you want to routinely have Config Connector upgraded to the latest version, enroll your clusters in the Rapid channel. If you want even faster upgrades, consider using Config Controller.

Google Cloud maps specific GKE minor versions to specific Config Connector versions. When your cluster is upgraded to a new GKE minor version, your cluster's Config Connector add-on is automatically upgraded.

Every 1-2 weeks, GKE minor versions that are available on the Rapid channel only (that is, GKE minor versions that are not available on the Regular or Stable channels) are upgraded to the latest Config Connector version. Clusters on those GKE minor versions are automatically upgraded accordingly. To learn about how to determine which versions are available on which release channels, see Viewing the default and available versions for release channels.

Google Cloud does not upgrade GKE minor versions that are already available on the Regular or Stable channels to newer Config Connector versions for stability reasons, except in emergency situations where a widespread issue has been detected.

Note: The resources in your cluster are preserved whenever an upgrade occurs.

Uninstalling Config Connector

To uninstall Config Connector, complete the following steps:

1. Use kubectl delete to remove the Config Connector CRDs along with controller components:

   kubectl delete ConfigConnector configconnector.core.cnrm.cloud.google.com --wait=true
   

2. Disable the Config Connector add-on in your cluster using the gcloud CLI or the Google Cloud console:

   gcloud

   To disable the Config Connector add-on with gcloud, run the following command:

   gcloud container clusters update CLUSTER_NAME --update-addons ConfigConnector=DISABLED
   

   Replace CLUSTER_NAME with the name of the cluster that has Config Connector add-on installed.

   Cloud console

   To disable the Config Connector add-on from the Google Cloud console, perform the following steps.

   1. Go to the Google Kubernetes Engine Clusters page on the Google Cloud console and select the cluster that you want to update.

      Visit the Google Kubernetes Engine menu

   2. Click Edit. The Edit clusters screen appears.

   3. Click Add-ons.

   4. Select Config Connector and choose Disabled.

   5. Click Save to update your cluster.

What's next

• Get started with Config Connector.
• Learn how to troubleshoot Config Connector.