This topic summarizes how to deploy a Tanzu Kubernetes Grid management cluster or designate one from vSphere with Tanzu. Deploying or designating a management cluster completes the Tanzu Kubernetes Grid installation process and makes Tanzu Kubernetes Grid operational.
After you have performed the steps described in Install the Tanzu CLI and Other Tools, you can deploy management clusters to the platforms of your choice.
NOTE: On vSphere with Tanzu, available on vSphere 7 and later, VMware recommends configuring the built-in supervisor cluster as a management cluster instead of using the
tanzu CLI to deploy a new management cluster. Deploying a Tanzu Kubernetes Grid management cluster to vSphere 7 when vSphere with Tanzu is not enabled is supported, but the preferred option is to enable vSphere with Tanzu and use the Supervisor Cluster. For details, see vSphere with Tanzu Provides Management Cluster.
The management cluster is a Kubernetes cluster that runs Cluster API operations on a specific cloud provider to create and manage workload clusters on that provider. The management cluster is also where you configure the shared and in-cluster services that the workload clusters use.
You can deploy management clusters in two ways:
You can deploy and manage Tanzu Kubernetes Grid management clusters on:
You can deploy the management cluster as either a single control plane, for development, or as a highly-available multi-node control plane, for production environments.
You deploy your management cluster by running the
tanzu management-cluster create command on the bootstrap machine. You configure the management cluster in different ways, depending on whether you specify
--ui to launch the installer interface:
tanzu management-cluster create command uses these sources and inputs in the following order of increasing precedence:
~/.tanzu/tkg/providers/config_default.yaml: This file contains system defaults, and should not be changed.
--fileoption: The cluster configuration file, which defaults to
~/.tanzu/tkg/cluster-config.yaml. This file configures specific invocations of
tanzu management-cluster createand other
tanzucommands. Use different
--filefiles to save multiple configurations.
--uioption: Installer UI input. When you run
tanzu management-cluster create --ui, the installer sets all management cluster configuration values from user input and ignores all other CLI options.
tanzu management-cluster create creates a temporary management cluster using a Kubernetes in Docker (
kind) cluster on the bootstrap machine. After creating the temporary management cluster locally, Tanzu Kubernetes Grid uses it to provision the final management cluster in the platform of your choice.
In the process,
tanzu management-cluster create creates or modifies CLI configuration and state files in the user's home directory on the local bootstrap machine:
||Bill of Materials (BoM) files that list specific versions of all of the packages that Tanzu Kubernetes Grid requires when it creates a cluster with a specific OS and Kubernetes version. Tanzu Kubernetes Grid adds to this directory as new Tanzu Kubernetes release versions are published.||Add if not already present|
||Configuration template files for Cluster API, cloud providers, and other dependencies, organized with
||Add if not already present|
||Add if not first installation|
||Names, contexts, and certificate file locations for the management clusters that the
||Add new management cluster information and set it as
||Default cluster configuration file that the
Best practice is to use a configuration file unique to each cluster.
|Add empty file if not already present.|
||Cluster configuration file that
||List of configurations and locations for the Tanzu Kubernetes Grid core and all of its providers.||Add if not already present|
||Add if not already present|
||System-wide default configurations for providers.
Best practice is not to edit this file, but to change provider configs through
|Add if not already present|
||Add new management cluster info and set the cluster as the
||Configuration and state for the
||Add new management cluster name, context, and certificate info. Do not change current
When you deploy a management or a workload cluster, Tanzu Kubernetes Grid installs the following core add-ons in the cluster:
Tanzu Kubernetes Grid manages the lifecycle of the core add-ons. For example, it automatically upgrades the add-ons when you upgrade your management and workload clusters.
For more information about the core add-ons, see Update and Troubleshoot Core Add-On Configuration.