Version 1.5

gkeadm

gkeadm is a command-line tool for creating and managing admin workstations in GKE on-prem.

Downloading gkeadm

To create an admin workstation for a certain version of GKE on-prem, download that same version of the gkeadm tool.

To upgrade and admin workstation, download the version of gkeadm that matches the target version of your upgrade.

Creating an admin workstation

These are the steps for creating an admin workstation:

  1. Create a template for an admin workstation configuration file by running gkeadm create config.

  2. Fill in your admin workstation configuration file.

  3. Create your admin workstation by running gkeadm create admin-workstation. Provide your admin workstation configuration file as an argument.

For more information, see Creating an admin workstation.

Upgrading an admin workstation

To upgrade your admin workstation, download the version of gkeadm that matches the target version of your upgrade. Then run gkeadm upgrade admin-workstation. Use the same configuration file that you used to create your admin workstation.

In addition to your admin configuration file, you need to provide one of the following:

  • An infomation file. When you created your admin workstation, gkeadm generated this file for you.

  • An OS image file.

For more information, see Upgrading GKE on-prem.

Rolling back

To roll back your admin workstation to the previous version, use the same configuration file that you used to create your admin workstation. Then run gkeadm rollback admin-workstation.

In addition to your admin configuration file, you need to provide one of the following:

  • An infomation file. When you created your admin workstation, gkeadm generated this file for you.

  • An OS image file.

Restoring from backup

When you upgrade an admin workstation, gkeadm saves a backup file for you. Later, if you no longer have an admin workstation or if you've lost some of the files that were on your upgraded admin workstation, you can use the backup file to create an admin workstation that is restored to what was in place immediately after the upgrade.

To create an admin workstation from a backup file, run gkeadm create admin-workstation --restore-from-backup.

Getting help

To list all available commands:

gkeadm help

To get help for a specific command:

gkeadm COMMAND --help

Synopsis

gkeadm installs and manages the admin workstation.

Usage:
  gkeadm [flags]
  gkeadm [command]

Available Commands:
  create      Create a GKE On-Prem admin workstation
  delete      Delete a GKE On-Prem admin workstation
  help        Help about any command
  rollback    Rollback a GKE On-Prem admin workstation to the previous version
  upgrade     Upgrade a GKE On-Prem admin workstation
  version     Print the gkeadm version

Flags:
      --add_dir_header             If true, adds the file directory to the header
      --alsologtostderr            log to standard error as well as files
  -h, --help                       help for gkeadm
      --log_file string            If non-empty, use this log file
      --log_file_max_size uint     Defines the maximum size a log file can grow to. Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
      --skip_headers               If true, avoid header prefixes in the log messages
      --skip_log_headers           If true, avoid headers when opening log files
      --stderrthreshold severity   logs at or above this threshold go to stderr (default 2)
  -v, --v Level                    number for the log level verbosity (default 0)

Use "gkeadm [command] --help" for more information about a command.