Stay organized with collections
Save and categorize content based on your preferences.
You can use the gkectl command line interface for a for a variety tasks,
including the following:
Generate a template for a cluster configuration file.
Validate a cluster configuration file.
Prepare a vSphere environment.
Create a cluster.
Upgrade a cluster.
Update a cluster.
Resize a cluster.
Diagnose cluster issues.
To list all commands:
gkectl help
To get help for a specific command:
gkectl COMMAND --help
Environment variable for the admin cluster kubeconfig file
Several gkectl commands require the path of the admin cluster kubeconfig file.
You can specify the path by exporting a GKECTL_KUBECONFIG environment
variable. For example:
[[["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-08-25 UTC."],[[["\u003cp\u003e\u003ccode\u003egkectl\u003c/code\u003e is a command-line interface used for managing clusters, including creating, upgrading, updating, and resizing them.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egkectl\u003c/code\u003e tool can also generate and validate cluster configuration files and assist in preparing a vSphere environment.\u003c/p\u003e\n"],["\u003cp\u003eUse \u003ccode\u003egkectl help\u003c/code\u003e to list all commands or \u003ccode\u003egkectl COMMAND --help\u003c/code\u003e for specific command details.\u003c/p\u003e\n"],["\u003cp\u003eYou can set the \u003ccode\u003eGKECTL_KUBECONFIG\u003c/code\u003e environment variable to specify the path of the admin cluster kubeconfig file, or use the \u003ccode\u003e--kubeconfig\u003c/code\u003e flag with each command.\u003c/p\u003e\n"]]],[],null,["# gkectl\n\nYou can use the `gkectl` command line interface for a for a variety tasks,\nincluding the following:\n\n- Generate a template for a cluster configuration file.\n- Validate a cluster configuration file.\n- Prepare a vSphere environment.\n- Create a cluster.\n- Upgrade a cluster.\n- Update a cluster.\n- Resize a cluster.\n- Diagnose cluster issues.\n\nTo list all commands:\n\n```\ngkectl help\n```\n\nTo get help for a specific command:\n\n```\ngkectl COMMAND --help\n```\n\nEnvironment variable for the admin cluster kubeconfig file\n----------------------------------------------------------\n\nSeveral `gkectl` commands require the path of the admin cluster kubeconfig file.\nYou can specify the path by exporting a `GKECTL_KUBECONFIG` environment\nvariable. For example:\n\n```\nexport GKECTL_KUBECONFIG=/path/to/my-admin-cluster-kubeconfig\n```\n\nIf you do not export the `GKECTL_KUBECONFIG` environment variable, then you must\nuse the `--kubeconfig` flag when you run the command.\n\nDownload `gkectl`\n-----------------\n\nFor information on downloading `gkectl`, see\n[Downloads](/anthos/clusters/docs/on-prem/1.9/downloads)."]]
