The `gcloud` utility

CLI for the Google Cloud Platform.

TL;DR
Further readings
1. Sources

TL;DR

Properties can be set via environment variables following the format CLOUDSDK_SECTIONNAME_PROPERTYNAME.

Variable	Default	Summary
`CLOUDSDK_CONFIG`	`$HOME/.config/gcloud` `%APPDATA%\gcloud`	CLI configuration directory
`CLOUDSDK_CORE_PROJECT`	``	Project
`CLOUDSDK_COMPUTE_ZONE`	``	Compute zone
`CLOUDSDK_ACTIVE_CONFIG_NAME`	``	Active configuration

Path	Summary	Notes
`$CLOUDSDK_CONFIG`	CLI configuration directory	Must be writable
`$CLOUDSDK_CONFIG/configurations/config_default`	Default configuration
`$CLOUDSDK_CONFIG/application_default_credentials.json`	Default application credentials

Setup

# Install.
asdf plugin add 'gcloud' && asdf install 'gcloud' 'latest'

# [optional if one know what they're doing] Initialize.
gcloud init
gcloud init --no-browser
gcloud --configuration 'secondary' init --console-only

Usage

# Show information about the installation and the active configuration.
gcloud info
gcloud info --format='value(config.paths.global_config_dir)'

# Show information about gcloud commands and other topics.
gcloud help
gcloud help compute instances create
gcloud cheat-sheet


# Login.
gcloud auth login
gcloud … --brief
gcloud … "email@example.com"

# Print access tokens.
gcloud auth print-access-token
gcloud … "email@example.com"

# List all credentialed accounts.
# Also identify the current active account.
gcloud auth list

# Revoke credentials.
# A.K.A. logout.
gcloud auth revoke "email@example.com"
gcloud auth revoke --all


# Setup applications.
gcloud auth application-default login
gcloud … --no-launch-browser

# Activate service accounts.
gcloud auth activate-service-account \
  "serviceaccount@gcpproject.iam.gserviceaccount.com" \
  --key-file "/path/to/sa.credentials.json"


# Configure the CLI.
gcloud config set 'account' "serviceaccount@gcpproject.iam.gserviceaccount.com"
gcloud … 'project' "project_id"
gcloud … 'compute/region' "europe-west1"
gcloud config unset 'project'

# List current settings.
gcloud config list
gcloud … --configuration "profile_name"


# Create new profiles.
gcloud config configurations create "new_active_profile"
gcloud … --no-activate "new_inactive_profile"

# List available profiles.
gcloud config configurations list

# Switch to different configurations.
gcloud config configurations activate "old_profile"


# Update the SDK installation to the latest version.
gcloud components update

# Install components.
gcloud components install 'skaffold'

# Remove components.
gcloud components remove 'config-connector'


# List all project the current user has access to.
gcloud projects list --sort-by='projectId'

# Delete projects.
gcloud projects delete "project_name"

# Undo delete project.
# Available for a limited period of time only.
gcloud projects undelete "project_name"

# Add the 'pubsub.admin' IAM Role to the 'awesome-sa' service account in the
# 'gcp-project' project.
gcloud projects add-iam-policy-binding "project_name" \
  --member "serviceAccount:awesome-sa@gcp-project.iam.gserviceaccount.com" \
  --role 'roles/pubsub.admin'

# Remove the 'pubsub.subscriber' IAM Role from the 'awesome-sa' service account
# in the 'gcpproject' project.
gcloud projects remove-iam-policy-binding "project_name" \
  --member="serviceAccount:awesome-sa@gcp-project.iam.gserviceaccount.com" \
  --role='roles/pubsub.subscriber'


# SSH into compute instances.
# Includes GKE clusters' compute instances.
gcloud compute ssh "instance-name" --zone "zone_name"
gcloud … --zone "zone_name" "instance_name" --project "project_name"


# Get all Kubernetes versions available for use in GKE clusters.
gcloud container get-server-config --format 'yaml(validNodeVersions)'
gcloud … --format 'yaml(validMasterVersions)' --zone "compute_zone_name"
gcloud … --flatten='channels' --filter='channels.channel=RAPID' \
  --format='yaml(channels.channel,channels.validVersions)'

# Generate 'kubeconfig' entries for GKE clusters.
gcloud container clusters get-credentials "cluster_name"
gcloud … "cluster_name" --region "region_name"


# Show operations.
# Filters are suggested.
gcloud container operations list --filter='NOT status:DONE'
gcloud compute … --filter='region:europe-west4 AND -status:DONE'
gcloud container … \
  --filter='name:operation-1513320920760-9c26cff5 AND status:RUNNING'
gcloud compute … \
  --filter='region:(europe-west4 us-east2)' \
  --filter='status!=DONE'


# Connect to cloud SQL instances.
gcloud sql connect "instance_name" --user="root" --quiet


# Use specific service accounts for an operation.
# The service account must have been already activated.
gcloud config set account "serviceaccount@gcpproject.iam.gserviceaccount.com" \
&& gcloud auth application-default login --no-launch-browser \
&& gcloud compute instances list

6.9 KiB Raw Blame History

The gcloud utility

TL;DR

Further readings

Sources

6.9 KiB

Raw Blame History

The `gcloud` utility