You can use the Tanzu CLI to deploy a management cluster to vSphere, Amazon Elastic Compute Cloud (Amazon EC2), and Microsoft Azure with a configuration that you specify in a YAML configuration file.
Before you can deploy a management cluster, you must make sure that your environment meets the requirements for the target infrastructure provider.
TKG_CUSTOM_IMAGE_REPOSITORYas an environment variable.
t3.xlarge, see Amazon EC2 Instance Types.
Before you deploy a management cluster to Amazon EC2 for the first time, you must create a CloudFormation stack for Tanzu Kubernetes Grid,
tkg-cloud-vmware-com, in your AWS account. This CloudFormation stack includes the identity and access management (IAM) resources that Tanzu Kubernetes Grid needs to create and run clusters on Amazon EC2. For more information, see Permissions Set by Tanzu Kubernetes Grid in Prepare to Deploy Management Clusters to Amazon EC2.
If you have already created the CloudFormation stack for Tanzu Kubernetes Grid in your AWS account, skip the rest of this procedure.
If you have not already created the CloudFormation stack for Tanzu Kubernetes Grid in your AWS account, ensure that AWS authentication variables are set either in the local environment or in your AWS default credential provider chain. For instructions, see Configure AWS Account Credentials and SSH Key.
If you have configured AWS credentials in multiple places, the credential settings used to create the CloudFormation stack are applied in the following order of precedence:
AWS_REGIONare applied first.
AWS_SHARED_CREDENTIAL_FILE. If this environment variable in not defined, the default location of
$HOME/.aws/credentialsis used. If you use credential profiles, the command uses the profile name specified in the
AWS_PROFILElocal environment configuration variable. If you do not specify a value for this variable, the profile named
For an example of how the default AWS credential provider chain is interpreted for Java apps, see Working with AWS Credentials in the AWS documentation.
Run the following command:
tanzu mc permissions aws set
For more information about this command, run
tanzu mc permissions aws set --help.
tanzu mc permissions aws set command replaces the
clusterawsadm command line utility that existed in Tanzu Kubernetes Grid v1.1.x and earlier. For existing management and Tanzu Kubernetes clusters initially deployed with v1.1.x or earlier, continue to use the CloudFormation stack that was created by running the
clusterawsadm alpha bootstrap create-stack command. For Tanzu Kubernetes Grid v1.2 and later clusters, use the
Standard_D4s_v3, see Sizes for virtual machines in Azure.
Before creating a management cluster using the Tanzu CLI, you must define its configuration in a YAML configuration file that provides the base configuration for the cluster. When you deploy the management cluster from the CLI, you specify this file by using the
--file option of the
tanzu mc create command.
tanzu config init command for the first time creates the
~/.config/tanzu/tkg subdirectory that contains the Tanzu Kubernetes Grid configuration files.
If you have previously deployed a management cluster by running
tanzu mc create --ui, the
~/.config/tanzu/tkg/clusterconfigs directory contains management cluster configuration files with settings saved from each invocation of the installer interface. Depending the infrastructure on which you deployed the management cluster, you can use these files as templates for cluster configuration files for new deployments to the same infrastructure. Alternatively, you can create management cluster configuration files from the templates that are provided in this documentation.
VMware recommends using a dedicated configuration file for each management cluster, with configuration settings specific to a single infrastructure.
tanzu mc createCommand
After you have created or updated the cluster configuration file and downloaded the most recent BOM, you can deploy a management cluster by running the
tanzu mc create --file CONFIG-FILE command, where
CONFIG-FILE is the name of the configuration file. If your configuration file is the default
~/.config/tanzu/tkg/cluster-config.yaml, you can omit the
--file option. If you would like to review the Kubernetes manifest that the
tanzu mc create command will apply you can optionally use the
--dry-run flag to print the manifest without making changes. This invocation will still run the validation checks described below before generating the Kubernetes manifest.
tanzu mc create command takes time to complete. While
tanzu mc create is running, do not run additional invocations of
tanzu mc create on the same bootstrap machine to deploy multiple management clusters, change context, or edit
To deploy a management cluster, run the
tanzu mc create command. For example:
tanzu mc create --file path/to/cluster-config-file.yaml
If you are creating the management cluster on Tanzu Kubernetes Grid v1.5.0, v1.5.1, v1.5.2, or v1.5.3, run the
tanzu plugin sync command to install Tanzu Kubernetes Grid plugins after the
tanzu mc create command completes successfully.
(vSphere only) After you deploy a management cluster to vSphere you must configure the IP addresses of its control plane endpoint and its nodes to be static, as described in Configure DHCP Reservations for the Control Plane Endpoint and All Nodes (vSphere Only).
When you run
tanzu mc create, the command performs several validation checks before deploying the management cluster. The checks are different depending on the infrastructure to which you are deploying the management cluster.
The command verifies that the target vSphere infrastructure meets the following requirements:
The command verifies that the target Amazon EC2 infrastructure meets the following requirements:
The command verifies that the target Azure infrastructure meets the following requirements:
If any of these conditions are not met, the
tanzu mc create command fails.
When you run
tanzu mc create, you can follow the progress of the deployment of the management cluster in the terminal. The first run of
tanzu mc create takes longer than subsequent runs because it has to pull the required Docker images into the image store on your bootstrap machine. Subsequent runs do not require this step, so are faster.
tanzu mc create fails before the management cluster deploys, you should clean up artifacts on your bootstrap machine before you re-run
tanzu mc create. See the Troubleshooting Tanzu Kubernetes Grid Issues topic for details. If the machine on which you run
tanzu mc create shuts down or restarts before the local operations finish, the deployment will fail.
If the deployment succeeds, you see a confirmation message in the terminal:
Management cluster created! You can now create your first workload cluster by running tanzu cluster create [name] -f [file]
For information about what happened during the deployment of the management cluster, how to connect
kubectl to the management cluster, and how to create namespaces see Examine the Management Cluster Deployment.