GKE PoC Toolkit

• Introduction
• Prerequisites
• What gets installed?
• Install
• Quickstart
• What's next?

Introduction

The GKE Proof of Concept (PoC) Toolkit is a demo generator for Google Kubernetes Engine (GKE). It sets out to provide a set of infrastructure as code (IaC) which deploys GKE clusters with a strong security posture that can be used to step through demos, stand up a POC, and deliver a codified example which can be the basis of a production implementation in your own CICD pipelines.

Prerequisites

Cloud Project

You'll need access to at least one Google Cloud Project with billing enabled. See [Creating and Managing Projects] (https://cloud.google.com/resource-manager/docs/creating-managing-projects) for creating a new project. To make cleanup easier, it's recommended to create a new project.

If you are using a Shared VPC, you will need a separate host project for the Shared VPC.

Tools

You'll need the following tools installed in order to deploy the toolkit.

• bash or bash compatible shell
• Terraform >= 0.13
• Google Cloud SDK version >= 325.0.0
• kubectl

  NOTE: It is recommended the major/minor version at least match the current default GKE release channel (version 1.20 at the time of this document).

Configure Authentication

The Terraform configuration will execute against your GCP environment and create various resources. The script will use your personal account to build out these resources. To setup the default account the script will use, run the following command to select the appropriate account:

gcloud auth login

NOTE: If this is your first time deploying, you should also run gcloud init and reinitialize your configuration.

What gets installed

For more details on the default configuration and what can be customized, you can check out our architectural document here.

Sample inputs to modify the defaults can be found here.

Install

Setup default project and default application credentials for gcloud:

PROJECT_ID=<project id targeted for clusters>

gcloud config set project $PROJECT_ID
gcloud auth login
gcloud auth application-default login

Set gkekitctl cli version type and OS, then download the cli binary:

VERSION=$(curl -s https://api.github.com/repos/GoogleCloudPlatform/gke-poc-toolkit/releases/latest | grep browser_download_url | cut -d "/" -f 8 | tail -1)

OS="darwin" # choice of darwin or amd64 

curl -sLSf -o ./gkekitctl https://github.com/GoogleCloudPlatform/gke-poc-toolkit/releases/download/${VERSION}/gkekitctl-${OS} && chmod +x ./gkekitctl

Validate cli was installed properly:

./gkekitctl

# Output should look like:
Tool to quickly deploy some pretty dope GKE demos

Usage:
  gkekitctl [command]

Examples:
        gkekitctl create
	gkectl create --config <file.yaml>
	gkekitctl delete

Available Commands:
  completion  generate the autocompletion script for the specified shell
  create      Create GKE Demo Environment
  delete      delete GKE Demo Environment
  help        Help about any command

Initialize the cli:

./gkekitctl init

Quickstart

Single stand alone cluster

Default behavior creates a single stand alone cluster. Make sure you have a project created and project ID handy. Run the create command and input the project ID when prompted. These are the default values used for gkekitctl create when no additional input is provided.

./gkekitctl create

# Prompt should look like:
INFO[0000] ☸️ ----- GKE POC TOOLKIT ----- 🛠
INFO[0000] Enter your Google Cloud Project ID:

Multi-cluster shared VPC

To create a shared VPC environment and install multiple clusters into the shared VPC pass a config file into the create command. There is a sample config file saved to ./cli/samples/multi-cluster.yaml. Update the sample with your specific variables before running the create command!

./gkekitctl create --config samples/multi-cluster.yaml

Cleanup

If cleaning up a cluster installed with the cli defaults, simply run:

./gkekitctl delete

Otherwise pass in the same config file used to create the resources:

./gkekitctl delete --config ./cli/samples/multi-cluster.yaml

What's next?

If you want to get fancy with your clusters, read up on other options in the architecture doc and go bananas. There are some validation steps you can run through to prove out some of the security features. One for cluster security features and another for workload security features. We welcome contributions. Please give our contributing doc a read and join us!