Installing, upgrading, and uninstalling Config Connector

Beta

This product or feature is in a pre-release state and might change or have limited support. For more information, see the product launch stages.

This topic describes how to install Config Connector on your cluster.

Prerequisites

To prepare for this task, perform the following steps:

• Ensure that you have enabled the Google Kubernetes Engine API.
Enable Google Kubernetes Engine API
• Ensure that you have installed the Cloud SDK.
• Set your default project ID:

  gcloud config set project [PROJECT_ID]

• If you are working with zonal clusters, set your default compute zone:

  gcloud config set compute/zone [COMPUTE_ZONE]

• If you are working with regional clusters, set your default compute region:

  gcloud config set compute/region [COMPUTE_REGION]

• Update gcloud to the latest version:

  gcloud components update

Note: You can override these default settings in gcloud commands using the --project, --zone, and --region operational flags.

• You must configure kubectl to connect to your clusters. Follow the steps for GKE clusters or GKE On-Prem clusters.

Creating the ClusterRoleBinding

Config Connector needs permission to create Kubernetes Roles before it can create resources.

Verify that you can create Roles by running the following command.

kubectl auth can-i create roles

If the output is yes, continue to Create an Identity.

If the output is no, create a ClusterRoleBinding in your cluster. This allows you to create Roles. Replace [ACCOUNT_EMAIL] with the email associated with your GCP account.

kubectl create clusterrolebinding cluster-admin-binding \
  --clusterrole cluster-admin \
  --user [ACCOUNT_EMAIL]

The outputs should contain the phrase cluster-admin-binding created. If it does not, contact your account or cluster administrator.

Create an Identity

A Config Connector cluster needs a GCP identity to communicate with other resources. To set up the identity, do the following in order, once per cluster:

• Creating an Cloud Identity and Access Management (Cloud IAM) Service Account.
• Creating a Service Account Key.
• Importing the Key's credentials to your cluster as a Secret.

Note: This step needs to be performed only once per cluster.

1. Create the cnrm-system Service Account with gcloud:

   gcloud iam service-accounts create cnrm-system

2. Give the IAM Service Account elevated permissions on your project. Replace [PROJECT_ID] with your project ID.

   Note: If you prefer to grant editor access to the project replace roles/owner with roles/editor. Granting the editor role allows most Config Connector functionality except [project/organization] wide configurations such as Cloud IAM modifications.

   gcloud projects add-iam-policy-binding [PROJECT_ID] \
     --member serviceAccount:cnrm-system@[PROJECT_ID].iam.gserviceaccount.com \
     --role roles/owner

3. Create a Service Account Key and export its credentials to a file. Replace [PROJECT_ID] with your project ID and run the following:

   gcloud iam service-accounts keys create --iam-account \
    cnrm-system@[PROJECT_ID].iam.gserviceaccount.com key.json

4. Create the cnrm-system namespace.

   kubectl create namespace cnrm-system

5. Import the key's credentials as a Secret.

    kubectl create secret generic gcp-key --from-file key.json --namespace cnrm-system

6. Remove the credentials from your system.

   rm key.json

Installing Config Connector

You can install Config Connector on your cluster using kubectl.

Installing manually

To manually install Config Connector, download the installation tar file and extract it, then apply the contents to your cluster.

1. Download the latest installation bundle tar file:

   curl -X GET -sLO \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     --location-trusted \
     https://us-central1-cnrm-eap.cloudfunctions.net/download/latest/infra/install-bundle.tar.gz

2. Extract the tar file:

   tar zxvf install-bundle.tar.gz

3. Apply the manifests to your cluster:

   kubectl apply -f install-bundle/

Verify Your Installation

Config Connector runs a single system process. You can verify the pod for this process has a STATUS of Running, by executing the following command:

kubectl --namespace cnrm-system get pods

Note: The controller pod may take several minutes to start.

Troubleshooting

Q: The installation bundle or samples archive is empty or seems to be corrupted. A: Verify your authorization token with gcloud auth print-access-token. A valid token is a long string beginning with text similar to ya29.XXXXXXX...X.

gcloud auth print-access-token

If the token is not valid, re-authenticate to GCP.

After authenticating, re-deploy Config Connector.

Uninstalling Config Connector

Warning: When uninstalling all Config Connector Custom Resource Definitions (CRDs) their associated GCP resources are deleted by default. If you wish to change this behavior change the resource's deletion-policy to abandon. For more information, see Deleting a Resource. After re-installation, GCP resources are not re-attached to your Config Connector installation.

Manually uninstall Config Connector

To manually uninstall, delete the installation bundle from your cluster.

From the same folder containing the contents of the unpacked tarball from the manual installation, run this command to delete:

kubectl delete -f install-bundle/crds.yaml \
kubectl delete -f install-bundle/0-cnrm-system.yaml

Upgrading Config Connector

Before you begin

Warning: To upgrade Config Connector, you must delete the Config Connector CRDs, which deletes all associated GCP resources by default. To change this behavior, follow these steps.

Before beginning an upgrade, add the following annotation to each of your Config Connector resources:

...
metadata:
  annotations:
    cnrm.cloud.google.com/deletion-policy: abandon
...

Manual Upgrade

Note: Upgrades from alpha versions of Config Connector are not supported. Install Config Connector on a different cluster when using the beta.

To manually upgrade Config Connector:

1. Run the manual uninstall steps
2. Run the manual install steps

What's next

Get started with Config Connector.