Stay organized with collections
Save and categorize content based on your preferences.
Cluster blueprints represent
patterns of infrastructure that you might need to deploy multiple times for
different purposes or with different configurations.
Deployment files are an optional feature that modify a blueprint's configuration
without changing the underlying Terraform and Packer modules. Common use cases
for using deployment files include the following:
Specifying a deployment_name that must be unique to each deployment
Specifying project_id, region, or zone that might vary across
deployments
Specifying an alternative Terraform remote state configuration
What can be specified in a deployment file
The following shows the parameters that can be set in a deployment file.
vars:
project_id: PROJECT_ID
deployment_name: DEPLOYMENT_NAME
region: REGION
zone: ZONE
terraform_backend_defaults:
type: gcs
configuration:
bucket: BUCKET_NAME
Using deployment files
Deployment files are supported in Cluster Toolkit v1.29.0 and later. For more
information on how to specify the deployment file, see
Cluster deployment overview.
Variable precedence
For variables that are specified in the vars section of blueprints and
deployment files, the following precedence is enforced:
If a variable is specified in both the deployment file and blueprint, the
value in the deployment file takes precedence
If a variable is specified in the deployment file and the --vars flag of
gcluster create or gcluster deploy commands, then the value supplied in the --vars
flag takes precedence
Any variable that isn't specified in the deployment file or --vars flag,
uses the value from the blueprint
If terraform_backend_defaults is set in a deployment file, then it replaces
all terraform_backend_defaults settings in the blueprint.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eCluster blueprints represent reusable infrastructure patterns for multiple deployments with varying configurations.\u003c/p\u003e\n"],["\u003cp\u003eDeployment files allow for the modification of a blueprint's settings without altering the underlying Terraform and Packer modules.\u003c/p\u003e\n"],["\u003cp\u003eDeployment files can be used to specify unique deployment names, project IDs, regions, zones, and alternative Terraform remote state configurations.\u003c/p\u003e\n"],["\u003cp\u003eValues in deployment files take precedence over blueprint values, while command-line \u003ccode\u003e--vars\u003c/code\u003e flags take precedence over deployment file values.\u003c/p\u003e\n"],["\u003cp\u003eIf the \u003ccode\u003eterraform_backend_defaults\u003c/code\u003e is set in a deployment file, it overrides all settings of \u003ccode\u003eterraform_backend_defaults\u003c/code\u003e specified in the blueprint.\u003c/p\u003e\n"]]],[],null,["# Cluster deployment files\n\n[Cluster blueprints](/cluster-toolkit/docs/setup/cluster-blueprint) represent\npatterns of infrastructure that you might need to deploy multiple times for\ndifferent purposes or with different configurations.\nDeployment files are an optional feature that modify a blueprint's configuration\nwithout changing the underlying Terraform and Packer modules. Common use cases\nfor using deployment files include the following:\n\n- Specifying a `deployment_name` that must be unique to each deployment\n- Specifying `project_id`, `region`, or `zone` that might vary across deployments\n- Specifying an alternative Terraform remote state configuration\n\nWhat can be specified in a deployment file\n------------------------------------------\n\nThe following shows the parameters that can be set in a deployment file. \n\n```\nvars:\n project_id: PROJECT_ID\n deployment_name: DEPLOYMENT_NAME\n region: REGION\n zone: ZONE\n\nterraform_backend_defaults:\n type: gcs\n configuration:\n bucket: BUCKET_NAME\n```\n\nUsing deployment files\n----------------------\n\nDeployment files are supported in Cluster Toolkit v1.29.0 and later. For more\ninformation on how to specify the deployment file, see\n[Cluster deployment overview](/cluster-toolkit/docs/deploy/deploy-cluster-overview#command-line-variables).\n\n### Variable precedence\n\nFor variables that are specified in the `vars` section of blueprints and\ndeployment files, the following precedence is enforced:\n\n- If a variable is specified in both the deployment file and blueprint, the value in the deployment file takes precedence\n- If a variable is specified in the deployment file and the `--vars` flag of `gcluster create` or `gcluster deploy` commands, then the value supplied in the `--vars` flag takes precedence\n- Any variable that isn't specified in the deployment file or `--vars` flag, uses the value from the blueprint\n\nIf `terraform_backend_defaults` is set in a deployment file, then it replaces\nall `terraform_backend_defaults` settings in the blueprint."]]
