gcluster

NAME

gcluster - provides the command-line interface for Cluster Toolkit.

SYNOPSIS

gcluster [GROUP] | COMMAND [FLAGS]

GLOBAL FLAGS

These flags are available to all commands:

  • --download-dependencies: Automatically downloads missing dependencies. Use --download-dependencies=false to make your deployment fail if dependencies are missing.
  • --no-color: Turns off colorized output.
  • --help: Displays help information for any command.

GROUPS

GROUP is one of the following:

job
Manages jobs on the cluster.
cluster
Manages clusters and environments.

COMMANDS

COMMAND is one of the following:

create
Creates a new deployment based on a provided blueprint.
deploy
Deploys all resources in a toolkit deployment directory.
destroy
Destroys all resources in a toolkit deployment directory.
expand
Expands the blueprint without creating a new deployment.
export-outputs
Exports outputs from a deployment group to other dependent groups.
import-inputs
Imports input values from previous deployment groups.
telemetry
Enables or disables telemetry data collection.
completion
Generates and loads a command completion script for Bash, Zsh, Fish, or PowerShell.

EXAMPLES

To create a deployment directory from a blueprint:

gcluster create blueprint.yaml -o ./my-deployment

To deploy all resources defined in a deployment directory:

gcluster deploy ./my-deployment --auto-approve

To list available clusters:

gcluster cluster list

To submit a workload to a cluster:

gcluster job submit \
    --cluster=my-cluster \
    --location=us-central1-a \
    --name=train-job \
    --image=gcr.io/my-project/training:v1 \
    --command="python3 train.py"

To destroy all resources created for a deployment:

gcluster destroy ./my-deployment --auto-approve