@microbs.io/plugin-gke v0.2.3

microbs-plugin-gke

Contents

• Usage
• Prerequisites
• Configuration

Usage

Before using the gke plugin you must have its prerequisites.

setup

|! Google will charge you for your use of GKE (more info).

When running microbs setup [-k], the gke plugin runs gcloud container clusters create.

Currently, the gke plugin deploys a fixed-sized cluster in "Standard" mode (i.e. not "Autopilot") with the following configuration:

• Machine type: e2-highcpu-4
• Number of nodes: 1 node for each zone in the given region_name (usually 3 nodes total).
• Disks: 32GB SSD Persistent Disks

rollout

The gke plugin is unaffected by microbs rollout.

destroy

When running microbs destroy [-k], the gke plugin runs gcloud container clusters delete.

Prerequisites

Create GCP resources

You must create the following GCP resources before using the gke plugin:

• Project
• VPC network
• VPC subnetwork
• Service account
• Service account key

Install dependencies

The gke plugin requires the following software dependencies on the same machine as microbs:

Install the plugin

microbs installs this plugin automatically when you install microbs.

To reinstall this plugin, run this command:

microbs plugins install gke

To upgrade this plugin to the latest version, run this command:

microbs plugins update gke

Configuration

This section documents the gke plugin configurations for config.yaml.

Required fields

plugins.gke.project_name

Name of the project in which your GKE cluster will be deployed.

Example: acmecorp

plugins.gke.region_name

Name of the region in which your GKE cluster will be deployed. Your VPC network must support your chosen region.

See the available regions for acceptable values. Do NOT include the zone suffix (e.g. -a, -b, -c, -d).

Examples: us-central1, asia-east1

plugins.gke.network_name

Name of the VPC network in which your GKE cluster will be deployed.

Example: microbs

plugins.gke.subnetwork_name

Name of the VPC subnetwork in which your GKE cluster will be deployed.

Example: microbs-us-east1

plugins.gke.service_account_name

Name of the service account that microbs will use to authenticate interactions with GCP.

Example: username@acmecorp.iam.gserviceaccount.com

plugins.gke.service_account_key_path

Path to the service account key JSON file that microbs will use to authenticate interactions with GCP.

Example: /path/to/my/secret/key/acmecorp-999999-49d9ba2b8b6d.json