Choose a tool to manage cluster lifecycle

GKE on Bare Metal provides you a choice of tools to create clusters and manage the cluster lifecycle operations (update, upgrade, and delete):

  • The command-line tool bmctl, which you run on your admin workstation in your on-premises data center. You create a configuration file that describes the cluster network, load balancing, and other cluster features. You specify this file on the command line to bmctl. You can also run kubectl on your admin workstation to upgrade and update clusters and to delete user clusters.
  • The Google Cloud console, Google Cloud CLI, or Terraform, which you can run from any computer that has network connectivity to your data center. These standard tools use the Anthos On-Prem API, which runs on Google Cloud infrastructure. Collectively, the standard tools are referred to as the Anthos On-Prem API clients. To manage the lifecycle of your clusters, the Anthos On-Prem API must store metadata about your cluster's state in Google Cloud, in the Google Cloud region that you specify when creating the cluster. This metadata lets the API manage the cluster lifecycle and doesn't include workload-specific data.

No matter which tool you use to create clusters, the information that you gather and provide to the tool, such as the IP addresses of cluster node machines and load balancer VIPs, is the same.

This selection lets you choose the best tool for your use case and environment. For example:

  • For your first installations in a development environment, you might want to use the console because the user interface provides additional guidance and help.
  • If your organization already uses the gcloud CLI or Terraform to manage other Google Cloud resources, you will probably want to use these tools for GKE on Bare Metal as well.
  • If your organization has regulatory requirements or restrictions, you might need to limit your reliance on Google Cloud and use bmctl on your admin workstation to create clusters and manage cluster lifecycle.

If you create a cluster with bmctl, you can enroll the cluster with the Anthos On-Prem API after the cluster is created, which lets you also use the Anthos On-Prem API clients.

Limitations with the Anthos On-Prem API clients

The bmctl tool was shipped with the first release of GKE on Bare Metal, and it is the most mature as far as features that it supports. We recommend that you review the functionality for the Anthos On-Prem API clients when making a choice. The following list summarizes current limitations. Check this list from time to time as the Anthos On-Prem API clients evolve.

  • Admin and user clusters are the only supported cluster types

  • The latest minor or patch versions aren't available in the Anthos On-Prem API until 7 to 10 days after the release

  • The following advanced networking features aren't supported: