gcluster deploy

NAME

gcluster deploy - deploys all resources in a Cluster Toolkit deployment directory or directly from a blueprint file.

SYNOPSIS

gcluster deploy (DEPLOYMENT_DIRECTORY | BLUEPRINT_FILE) [FLAGS]

DESCRIPTION

The gcluster deploy command deploys all resources defined in a deployment directory. If a blueprint file is provided instead of a deployment directory, then Cluster Toolkit creates the deployment directory first (equivalent to running gcluster create) and then immediately deploys it. To destroy the deployed resources, use gcluster destroy.

FLAGS

  • -a, --artifacts ARTIFACTS_DIR: The directory where deployment artifacts are stored. This directory is automatically configured if not set.
  • --auto-approve: Automatically approves proposed changes without prompting.
  • --json-output: Writes Terraform output to a JSON file instead of standard text output to the console.
  • --skip: A comma-separated list of group names to skip during deployment.
  • --only: A comma-separated list of group names to deploy exclusively. This value can't be used with --skip.
  • --skip-gke-security-check: Bypasses the dynamic GKE version security vulnerability check.

CREATE FLAGS

If a BLUEPRINT_FILE is provided, the following flags from gcluster create are also available:

  • -o, --out OUTPUT_DIR: The directory where the deployment folder is created.
  • -w, --overwrite-deployment: Lets you overwrite an existing deployment directory.
  • --force: Forces an overwrite without prompting.
  • -d, --deployment-file DEPLOYMENT_FILE: A deployment file to override blueprint variables and backend configuration.
  • --vars VARS: A comma-separated list of name=value variables to override YAML configuration.
  • --backend-config BACKEND_CONFIG: A comma-separated list of name=value variables to set Terraform backend configuration.
  • -l, --validation-level LEVEL: Sets the validation level (ERROR, WARNING, or IGNORE).
  • --skip-validators VALIDATORS: A comma-separated list of validators to skip.
  • --add-creator-label: Adds the ghpc_creator label to the expanded blueprint.

EXAMPLES

To deploy all resources in a deployment directory:

gcluster deploy ./my-deployment

To automatically approve and apply changes without prompting:

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

To create and immediately deploy a cluster from a blueprint file:

gcluster deploy blueprint.yaml -o ./my-deployment --auto-approve

To deploy only a specific group within a multi-group deployment:

gcluster deploy ./my-deployment --only=primary-cluster