diff --git a/docs/headless-install.md b/docs/headless-install.md index 28746d7bbb..bd5917db6d 100644 --- a/docs/headless-install.md +++ b/docs/headless-install.md @@ -65,7 +65,7 @@ Note the file path of the generated YAML file (the path is listed after the `--file` argument). In this case, the file path is: ```sh -/home/smcginnis/.tanzu/tkg/clusterconfigs/bs83endsfl.yaml +/home/smcginnis/.config/tanzu/tkg/clusterconfigs/bs83endsfl.yaml ``` Once you have the file path, you can copy that file over to your headless @@ -74,7 +74,7 @@ have at your disposal. Here is an example of using the SCP command to copy it into the home directory on the headless machine: ```sh -scp /home/smcginnis/.tanzu/tkg/clusterconfigs/bs83endsfl.yaml ubuntu@deployment-vm:~/ +scp /home/smcginnis/.config/tanzu/tkg/clusterconfigs/bs83endsfl.yaml ubuntu@deployment-vm:~/ ``` Now the file is available on the headless machine to actually perform the diff --git a/docs/site/content/docs/assets/aws-clusters.md b/docs/site/content/docs/assets/aws-clusters.md index 66f4ee4604..8e01dcf82b 100644 --- a/docs/site/content/docs/assets/aws-clusters.md +++ b/docs/site/content/docs/assets/aws-clusters.md @@ -86,7 +86,7 @@ Amazon EC2. 1. Next you will create a workload cluster. First, setup a workload cluster config file. ```sh - cp ~/.tanzu/tkg/clusterconfigs/ ~/.tanzu/tkg/clusterconfigs/workload1.yaml + cp ~/.config/tanzu/tkg/clusterconfigs/ ~/.config/tanzu/tkg/clusterconfigs/workload1.yaml ``` > ```` is the name of the management cluster YAML config file @@ -101,7 +101,9 @@ Amazon EC2. [](ignored) -1. In the new workload cluster file (`~/.tanzu/tkg/clusterconfigs/workload1.yaml`), edit the CLUSTER_NAME parameter to assign a name to your workload cluster. For example, + +1. In the new workload cluster file (`~/.config/tanzu/tkg/clusterconfigs/workload1.yaml`), edit the CLUSTER_NAME parameter to assign a name to your guest cluster. For example, + ```yaml CLUSTER_CIDR: 100.96.0.0/11 diff --git a/docs/site/content/docs/assets/cli-install-linux.md b/docs/site/content/docs/assets/cli-install-linux.md index b7816d11cc..e1e79cb67c 100644 --- a/docs/site/content/docs/assets/cli-install-linux.md +++ b/docs/site/content/docs/assets/cli-install-linux.md @@ -19,7 +19,7 @@ 1. Unpack the release. ```sh - tar xzvf ~/Downloads/tce-linux-amd64-v0.6.0.tar.gz + tar xzvf ~//tce-linux-amd64-v0.6.0.tar.gz ``` 1. Run the install script (make sure to use the appropriate directory for your platform). @@ -32,9 +32,10 @@ > This installs the `Tanzu` CLI and puts all the plugins in their proper location. > The first time you run the `tanzu` command the installed plugins and plugin repositories are initialized. This action might take a minute. -1. If you wish to run commands against any of the Kubernetes clusters that are created, you will need to download and install the latest version of `kubectl`. +1. You must download and install the latest version of `kubectl`. ```sh curl -LO https://dl.k8s.io/release/v1.20.1/bin/linux/amd64/kubectl sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl ``` + For more information, see [Install and Set Up kubectl on Linux](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) in the Kubernetes documentation. \ No newline at end of file diff --git a/docs/site/content/docs/assets/cli-install-mac.md b/docs/site/content/docs/assets/cli-install-mac.md index 6996d1ea4d..ad75d9b100 100644 --- a/docs/site/content/docs/assets/cli-install-mac.md +++ b/docs/site/content/docs/assets/cli-install-mac.md @@ -3,7 +3,7 @@ 1. Unpack the release. ```sh - tar xzvf ~/Downloads/tce-darwin-amd64-v0.6.0.tar.gz + tar xzvf ~//tce-darwin-amd64-v0.6.0.tar.gz ``` 1. Run the install script. @@ -16,9 +16,7 @@ > This installs the `Tanzu` CLI and puts all the plugins in their proper location. > The first time you run the `tanzu` command the installed plugins and plugin repositories are initialized. This action might take a minute. -1. If you wish to run commands against any of the Kubernetes clusters that are created, you will need to download and install the latest version of `kubectl`. +1. You must download and install the latest version of `kubectl`. For more information, see [Install and Set Up kubectl on macOS](https://kubernetes.io/docs/tasks/tools/install-kubectl-macos/) in the Kubernetes documentation. + + - ```sh - curl -LO https://dl.k8s.io/release/v1.20.1/bin/darwin/amd64/kubectl - sudo install -o root -g wheel -m 0755 kubectl /usr/local/bin/kubectl - ``` diff --git a/docs/site/content/docs/assets/final-step.md b/docs/site/content/docs/assets/final-step.md index f4d3c9880a..35d0ce1636 100644 --- a/docs/site/content/docs/assets/final-step.md +++ b/docs/site/content/docs/assets/final-step.md @@ -1,6 +1,11 @@ ### Finalize the Deployment -1. Click **Review Configuration** to see the details of the management cluster that you have configured. When you click **Review Configuration**, Tanzu populates the cluster configuration file, which is located in the `~/.tanzu/tkg/clusterconfigs` subdirectory, with the settings that you specified in the interface. You can optionally copy the cluster configuration file without completing the deployment. You can copy the cluster configuration file to another bootstrap machine and deploy the management cluster from that machine. For example, you might do this so that you can deploy the management cluster from a bootstrap machine that does not have a Web browser. +1. In the **CEIP Participation** section, optionally deselect the check box to opt out of the VMware Customer Experience Improvement Program. + + You can also opt in or out of the program after the deployment of the management cluster. For information about the CEIP, see [Opt in or Out of the VMware CEIP](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.3/vmware-tanzu-kubernetes-grid-13/GUID-cluster-lifecycle-multiple-management-clusters.html#ceip) and [https://www.vmware.com/solutions/trustvmware/ceip.html](https://www.vmware.com/solutions/trustvmware/ceip.html). + +2. Click **Review Configuration** to see the details of the management cluster that you have configured. When you click **Review Configuration**, Tanzu populates the cluster configuration file, which is located in the `~/.config/tanzu/tkg/clusterconfigs` subdirectory, with the settings that you specified in the interface. You can optionally copy the cluster configuration file without completing the deployment. You can copy the cluster configuration file to another bootstrap machine and deploy the management cluster from that machine. For example, you might do this so that you can deploy the management cluster from a bootstrap machine that does not have a Web browser. + 1. (Optional) Under **CLI Command Equivalent**, click the **Copy** button to copy the CLI command for the configuration that you specified. @@ -11,10 +16,10 @@ 1. Click **Deploy Management Cluster**. Deployment of the management cluster can take several minutes. The first run of `tanzu management-cluster 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. You can follow the progress of the deployment of the management cluster in the installer interface or in the terminal in which you ran `tanzu management-cluster create --ui`. If the machine on which you run `tanzu management-cluster create` shuts down or restarts before the local operations finish, the deployment will fail. If you inadvertently close the browser or browser tab in which the deployment is running before it finishes, the deployment continues in the terminal. - + + ![Monitor the management cluster deployment](../images/mgmt-cluster-deployment.png)--> + 1. In the **Identity Management** section, optionally disable **Enable Identity Management Settings** . ![Configure external Identity Provider](../images/install-v-7id.png) - You can disable identity management for proof-of-concept deployments, but it is strongly recommended to implement identity management in production deployments. If you disable identity management, you can reenable it later. + You can disable identity management for proof-of-concept deployments, but it is strongly recommended to implement identity management in production deployments. If you disable identity management, you can reenable it later. 1. If you enable identity management, select **OIDC** or **LDAPS**. **OIDC**: @@ -132,7 +132,7 @@ This section applies to all infrastructure providers. ![Review the management cluster configuration](../images/review-settings-vsphere.png) - When you click **Review Configuration**, Tanzu Kubernetes Grid populates the cluster configuration file, which is located in the `~/.tanzu/tkg/clusterconfigs` subdirectory, with the settings that you specified in the interface. You can optionally copy the cluster configuration file without completing the deployment. You can copy the cluster configuration file to another bootstrap machine and deploy the management cluster from that machine. For example, you might do this so that you can deploy the management cluster from a bootstrap machine that does not have a Web browser. + When you click **Review Configuration**, Tanzu Kubernetes Grid populates the cluster configuration file, which is located in the `~/.config/tanzu/tkg/clusterconfigs` subdirectory, with the settings that you specified in the interface. You can optionally copy the cluster configuration file without completing the deployment. You can copy the cluster configuration file to another bootstrap machine and deploy the management cluster from that machine. For example, you might do this so that you can deploy the management cluster from a bootstrap machine that does not have a Web browser. 1. (Optional) Under **CLI Command Equivalent**, click the **Copy** button to copy the CLI command for the configuration that you specified. @@ -142,7 +142,7 @@ This section applies to all infrastructure providers. 1. Click **Deploy Management Cluster**. Deployment of the management cluster can take several minutes. The first run of `tanzu management-cluster 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. You can follow the progress of the deployment of the management cluster in the installer interface or in the terminal in which you ran `tanzu management-cluster create --ui`. If the machine on which you run `tanzu management-cluster create` shuts down or restarts before the local operations finish, the deployment will fail. If you inadvertently close the browser or browser tab in which the deployment is running before it finishes, the deployment continues in the terminal. - + **NOTE**: The screen capture below shows the deployment status page in Tanzu Kubernetes Grid v1.3.1. ![Monitor the management cluster deployment](../images/mgmt-cluster-deployment.png) diff --git a/docs/site/content/docs/latest/deploy.md b/docs/site/content/docs/latest/deploy.md index f3e0079e68..167669d609 100644 --- a/docs/site/content/docs/latest/deploy.md +++ b/docs/site/content/docs/latest/deploy.md @@ -1,6 +1,6 @@ # Deploy Tanzu Kubernetes Clusters -After you have deployed a management cluster to vSphere, Amazon EC2, or Azure, or you have connected the Tanzu CLI to a vSphere with Tanzu Supervisor Cluster, you can use the Tanzu CLI to deploy Tanzu Kubernetes clusters. +After you have deployed a management cluster to vSphere, Amazon EC2, or Azure, or you have connected the Tanzu CLI to a vSphere with Tanzu Supervisor Cluster, you can use the Tanzu CLI to deploy Tanzu Kubernetes clusters. To deploy a Tanzu Kubernetes cluster, you create a configuration file that specifies the different options with which to deploy the cluster. You then run the `tanzu cluster create` command, specifying the configuration file in the `--file` option. @@ -18,15 +18,15 @@ For more information, see [Minimum VM Sizes for Cluster Nodes](../mgmt-clusters/ ## Create a Tanzu Kubernetes Cluster Configuration File -When you deploy a Tanzu Kubernetes cluster, most of the configuration for the cluster is the same as the configuration of the management cluster that you use to deploy it. Because most of the configuration is the same, the easiest way to obtain an initial configuration file for a Tanzu Kubernetes cluster is to make a copy of the management cluster configuration file and to update it. +When you deploy a Tanzu Kubernetes cluster, most of the configuration for the cluster is the same as the configuration of the management cluster that you use to deploy it. Because most of the configuration is the same, the easiest way to obtain an initial configuration file for a Tanzu Kubernetes cluster is to make a copy of the management cluster configuration file and to update it. 1. Locate the YAML configuration file for the management cluster. - - If you deployed the management cluster from the installer interface and you did not specify the `--file` option when you ran `tanzu management-cluster create --ui`, the configuration file is saved in `~/.tanzu/tkg/clusterconfigs/`. The file has a randomly generated name, for example, `bm8xk9bv1v.yaml`. + - If you deployed the management cluster from the installer interface and you did not specify the `--file` option when you ran `tanzu management-cluster create --ui`, the configuration file is saved in `~/.config/tanzu/tkg/clusterconfigs/`. The file has a randomly generated name, for example, `bm8xk9bv1v.yaml`. - If you deployed the management cluster from the installer interface and you did specify the `--file` option, the management cluster configuration is taken from in the file that you specified. - - If you deployed the management cluster from the Tanzu CLI without using the installer interface, the management cluster configuration is taken from either a file that you specified in the `--file` option, or from the default location, `~/.tanzu/tkg/cluster-config.yaml`. - -1. Make a copy of the management cluster configuration file and save it with a new name. + - If you deployed the management cluster from the Tanzu CLI without using the installer interface, the management cluster configuration is taken from either a file that you specified in the `--file` option, or from the default location, `~/.config/tanzu/tkg/cluster-config.yaml`. + +1. Make a copy of the management cluster configuration file and save it with a new name. For example, save the file as `my-aws-tkc.yaml`, `my-azure-tkc.yaml` or `my-vsphere-tkc.yaml`. @@ -37,13 +37,13 @@ When you deploy a Tanzu Kubernetes cluster, most of the configuration for the cl The simplest way to deploy a Tanzu Kubernetes cluster is to specify a configuration that is identical to that of the management cluster. In this case, you only need to specify a name for the cluster. If you are deploying the cluster to vSphere, you must also specify an IP address or FQDN for the Kubernetes API endpoint. **Note**: To configure a workload cluster to use an OS other than the default Ubuntu v20.0.4, you must set the `OS_NAME` and `OS_VERSION` values in the cluster configuration file. -The installer interface does not include node VM OS values in the management cluster configuration files that it saves to `~/.tanzu/tkg/clusterconfigs`. +The installer interface does not include node VM OS values in the management cluster configuration files that it saves to `~/.config/tanzu/tkg/clusterconfigs`. 1. Open the new YAML cluster configuration file in a text editor. 1. Optionally set a name for the cluster in the `CLUSTER_NAME` variable. For example, if you are deploying the cluster to vSphere, set the name to `my-vsphere-tkc`. - + ``` CLUSTER_NAME: my-vsphere-tkc ``` @@ -53,33 +53,33 @@ The installer interface does not include node VM OS values in the management clu The `CLUSTER_NAME` value passed to `tanzu cluster create` overrides the name you set in the configuration file.
Workload cluster names must be must be 42 characters or less, and must comply with DNS hostname requirements as amended in [RFC 1123](https://tools.ietf.org/html/rfc1123). -1. If you are deploying the cluster to vSphere, specify a static virtual IP address or FQDN in the `VSPHERE_CONTROL_PLANE_ENDPOINT` variable. +1. If you are deploying the cluster to vSphere, specify a static virtual IP address or FQDN in the `VSPHERE_CONTROL_PLANE_ENDPOINT` variable. No two clusters, including any management cluster and workload cluster, can have the same `VSPHERE_CONTROL_PLANE_ENDPOINT` address. - Ensure that this IP address is not in the DHCP range, but is in the same subnet as the DHCP range. - If you mapped a fully qualified domain name (FQDN) to the VIP address, you can specify the FQDN instead of the VIP address. - + ``` VSPHERE_CONTROL_PLANE_ENDPOINT: 10.90.110.100 ``` 1. Save the configuration file. -1. Run the `tanzu cluster create` command, specifying the path to the configuration file in the `--file` option. +1. Run the `tanzu cluster create` command, specifying the path to the configuration file in the `--file` option. If you saved the Tanzu Kubernetes cluster configuration file `my-vsphere-tkc.yaml` in the default `clusterconfigs` folder, run the following command to create a cluster with a name that you specified in the configuration file: - + ``` tanzu cluster create --file .tanzu/tkg/clusterconfigs/my-vsphere-tkc.yaml ``` If you did not specify a name in the configuration file, or to create a cluster with a different name to the one that you specified, specify the cluster name in the `tanzu cluster create` command. For example, to create a cluster named `another-vsphere-tkc` from the configuration file `my-vsphere-tkc.yaml`, run the following command: - + ``` tanzu cluster create another-vsphere-tkc --file .tanzu/tkg/clusterconfigs/my-vsphere-tkc.yaml ``` - Any name that you specify in the `tanzu cluster create` command will override the name you set in the configuration file. - + Any name that you specify in the `tanzu cluster create` command will override the name you set in the configuration file. + 1. To see information about the cluster, run the `tanzu cluster get` command, specifying the cluster name. ``` @@ -88,7 +88,7 @@ The installer interface does not include node VM OS values in the management clu The output lists information about the status of the control plane and worker nodes, the Kubernetes version that the cluster is running, and the names of the nodes. - ``` + ``` NAME NAMESPACE STATUS CONTROLPLANE WORKERS KUBERNETES ROLES my-vsphere-tkc default running 1/1 1/1 v1.20.5+vmware.1 @@ -102,47 +102,47 @@ The installer interface does not include node VM OS values in the management clu └─Workers └─MachineDeployment/my-vsphere-tkc-md-0 └─Machine/my-vsphere-tkc-md-0-657958d58-mgtpp True 8m33s - + ``` - + The cluster runs the default version of Kubernetes for this Tanzu Kubernetes Grid release, which in Tanzu Kubernetes Grid v1.3.0 is v1.20.1. ## Deploy a Cluster with Different Numbers of Control Plane and Worker Nodes -In the preceding example, because you did not change any of the node settings in the Tanzu Kubernetes cluster configuration file, the resulting Tanzu Kubernetes cluster has the same numbers of control plane and worker nodes as the management cluster. The nodes have the same CPU, memory, and disk configuration as the management cluster nodes. +In the preceding example, because you did not change any of the node settings in the Tanzu Kubernetes cluster configuration file, the resulting Tanzu Kubernetes cluster has the same numbers of control plane and worker nodes as the management cluster. The nodes have the same CPU, memory, and disk configuration as the management cluster nodes. - If you selected **Development** in the **Management Cluster Settings** section of the installer interface, or specified `CLUSTER_PLAN: dev` and the default numbers of nodes in the management cluster configuration, the Tanzu Kubernetes cluster consists of the following VMs or instances: - vSphere: - One control plane node, with a name similar to `my-dev-cluster-control-plane-nj4z6`. - - One worker node, with a name similar to `my-dev-cluster-md-0-6ff9f5cffb-jhcrh`. - - Amazon EC2: + - One worker node, with a name similar to `my-dev-cluster-md-0-6ff9f5cffb-jhcrh`. + - Amazon EC2: - One control plane node, with a name similar to `my-dev-cluster-control-plane-d78t5`. - One EC2 bastion node, with the name `my-dev-cluster-bastion`. - - One worker node, with a name similar to `my-dev-cluster-md-0-2vsr4`. + - One worker node, with a name similar to `my-dev-cluster-md-0-2vsr4`. - Azure: - One control plane node, with a name similar to `my-dev-cluster-20200902052434-control-plane-4d4p4`. - - One worker node, with a name similar to `my-dev-cluster-20200827115645-md-0-rjdbr`. + - One worker node, with a name similar to `my-dev-cluster-20200827115645-md-0-rjdbr`. - If you selected **Production** in the **Management Cluster Settings** section of the installer interface, or specified `CLUSTER_PLAN: prod` and the default numbers of nodes in the management cluster configuration file, Tanzu CLI deploys a cluster with three control plane nodes and automatically implements stacked control plane HA for the cluster. The Tanzu Kubernetes cluster consists of the following VMs or instances: - vSphere - Three control plane nodes, with names similar to `my-prod-cluster-control-plane-nj4z6`. - Three worker nodes, with names similar to `my-prod-cluster-md-0-6ff9f5cffb-jhcrh`. - - Amazon EC2: + - Amazon EC2: - Three control plane nodes, with names similar to `my-prod-cluster-control-plane-d78t5`. - One EC2 bastion node, with the name `my-prod-cluster-bastion`. - Three worker nodes, with names similar to `my-prod-cluster-md-0-2vsr4`. - - Azure: + - Azure: - Three control plane nodes, with names similar to `my-prod-cluster-20200902052434-control-plane-4d4p4`. - Three worker nodes, with names similar to `my-prod-cluster-20200827115645-md-0-rjdbr`. -If you copied the cluster configuration from the management cluster, you can update the `CLUSTER_PLAN` variable in the configuration to deploy a Tanzu Kubernetes cluster that uses the `prod` plan, even if the management cluster was deployed with the `dev` plan, and the reverse. +If you copied the cluster configuration from the management cluster, you can update the `CLUSTER_PLAN` variable in the configuration to deploy a Tanzu Kubernetes cluster that uses the `prod` plan, even if the management cluster was deployed with the `dev` plan, and the reverse. ``` CLUSTER_PLAN: prod ``` -To deploy a Tanzu Kubernetes cluster with more control plane nodes than the `dev` and `prod` plans define by default, specify the `CONTROL_PLANE_MACHINE_COUNT` variable in the cluster configuration file. The number of control plane nodes that you specify in `CONTROL_PLANE_MACHINE_COUNT` must be uneven. +To deploy a Tanzu Kubernetes cluster with more control plane nodes than the `dev` and `prod` plans define by default, specify the `CONTROL_PLANE_MACHINE_COUNT` variable in the cluster configuration file. The number of control plane nodes that you specify in `CONTROL_PLANE_MACHINE_COUNT` must be uneven. ``` CONTROL_PLANE_MACHINE_COUNT: 5 @@ -166,7 +166,7 @@ You configure proxies, Machine Health Check, private registries, and Antrea on ## Deploy a Cluster in a Specific Namespace -If you have created namespaces in your Tanzu Kubernetes Grid instance, you can deploy Tanzu Kubernetes clusters to those namespaces by specifying the `NAMESPACE` variable. If you do not specify the the `NAMESPACE` variable, Tanzu Kubernetes Grid places clusters in the `default` namespace. Any namespace that you identify in the `NAMESPACE` variable must exist in the management cluster before you run the command. For example, you might want to create different types of clusters in dedicated namespaces. For information about creating namespaces in the management cluster, see [Create Namespaces in the Management Cluster](../cluster-lifecycle/multiple-management-clusters.md#create-namespaces). +If you have created namespaces in your Tanzu Kubernetes Grid instance, you can deploy Tanzu Kubernetes clusters to those namespaces by specifying the `NAMESPACE` variable. If you do not specify the the `NAMESPACE` variable, Tanzu Kubernetes Grid places clusters in the `default` namespace. Any namespace that you identify in the `NAMESPACE` variable must exist in the management cluster before you run the command. For example, you might want to create different types of clusters in dedicated namespaces. For information about creating namespaces in the management cluster, see [Create Namespaces in the Management Cluster](../cluster-lifecycle/multiple-management-clusters.md#create-namespaces). ``` NAMESPACE: production diff --git a/docs/site/content/docs/latest/designs/standalone-clusters.md b/docs/site/content/docs/latest/designs/standalone-clusters.md index 197f5e4345..bfa7187a91 100644 --- a/docs/site/content/docs/latest/designs/standalone-clusters.md +++ b/docs/site/content/docs/latest/designs/standalone-clusters.md @@ -15,12 +15,12 @@ Using Tanzu Kubernetes Grid (TKG), users initialize their clusters using the fol ```shell # create a management cluster -tanzu management-cluster create --file ${HOME}/.tanzu/cluster-configs/some-config.yaml +tanzu management-cluster create --file ~/.config/tanzu/cluster-configs/some-config.yaml ## < ... logs for bootstrap cluster and management cluster ... > # create workload cluster -tanzu standalone-cluster create --file ${HOME}/.tanzu/cluster-configs/some-config.yaml +tanzu standalone-cluster create --file ${HOME}/.config/tanzu/cluster-configs/some-config.yaml ## < ... logs for bootstrap cluster and management cluster ... > ``` @@ -90,6 +90,7 @@ to do this efficiently, the following must be in place. * Cluster API management container images loaded * Cluster API providers used in TCE (CAPA, CAPV, CAPD, etc) container images loaded. For more information about Cluster API, see the [The Cluster API Book](https://cluster-api.sigs.k8s.io/) 1. Persist all provider configuration details in `~/.tanzu/cluster-config` until the user deletes the SC. + 1. Upon a management request of the SC, start the fully-baked image and apply the provider configuration. Assuming an SC pre-exists, a **scaling** request would look as follows. diff --git a/docs/site/content/docs/latest/headless-install.md b/docs/site/content/docs/latest/headless-install.md index 5575c373b8..6e473474a6 100644 --- a/docs/site/content/docs/latest/headless-install.md +++ b/docs/site/content/docs/latest/headless-install.md @@ -65,7 +65,7 @@ Note the file path of the generated YAML file (the path is listed after the `--file` argument). In this case, the file path is: ```sh -/home/smcginnis/.tanzu/tkg/clusterconfigs/bs83endsfl.yaml +/home/smcginnis/.config/tanzu/tkg/clusterconfigs/bs83endsfl.yaml ``` Once you have the file path, you can copy that file over to your headless @@ -74,7 +74,7 @@ have at your disposal. Here is an example of using the SCP command to copy it into the home directory on the headless machine: ```sh -scp /home/smcginnis/.tanzu/tkg/clusterconfigs/bs83endsfl.yaml ubuntu@deployment-vm:~/ +scp /home/smcginnis/.config/tanzu/tkg/clusterconfigs/bs83endsfl.yaml ubuntu@deployment-vm:~/ ``` Now the file is available on the headless machine to actually perform the diff --git a/docs/site/content/docs/latest/verify-deployment.md b/docs/site/content/docs/latest/verify-deployment.md index 38e2b41339..41e0ac1d53 100644 --- a/docs/site/content/docs/latest/verify-deployment.md +++ b/docs/site/content/docs/latest/verify-deployment.md @@ -4,17 +4,17 @@ Before you progress to installing packages, examine your cluster. ## Procedure 1. Run the following command to verify that management cluster started successfully. If you did not specify a name for the management cluster, it will be something similar to `tkg-mgmt-vsphere-20200323121503` or `tkg-mgmt-aws-20200323140554`. - ```sh tanzu management-cluster get ``` -2. Examine the folder structure. When Tanzu creates a management cluster for the first time, it creates a folder `~/.tanzu/tkg/providers` that contains all of the files required by Cluster API to create the management cluster. -The Tanzu installer interface saves the settings for the management cluster that it creates into a cluster configuration file `~/.tanzu/tkg/clusterconfigs/UNIQUE-ID.yaml`, where `UNIQUE-ID` is a generated filename. +2. Examine the folder structure. When Tanzu creates a management cluster for the first time, it creates a folder `~/.config/tanzu/tkg/providers` that contains all of the files required by Cluster API to create the management cluster. +The Tanzu installer interface saves the settings for the management cluster that it creates into a cluster configuration file `~/.config/tanzu/tkg/clusterconfigs/UNIQUE-ID.yaml`, where `UNIQUE-ID` is a generated filename. 3. To view the management cluster objects in vSphere, or Amazon EC2, do the following: - * If you deployed the management cluster to vSphere, go to the resource pool that you designated when you deployed the management cluster. You should see: - + * If you deployed the management cluster to vSphere, go to the resource pool that you designated when you deployed the management cluster. You should see: + * One or three control plane VMs, for development or production control plane, respectively, with names similar to `CLUSTER-NAME-control-plane-sx5rp` * A worker node VM with a name similar to `CLUSTER-NAME-md-0-6b8db6b59d-kbnk4` * If you deployed the management cluster to Amazon EC2, go to the **Instances** view of your EC2 dashboard. You should see the following VMs or instances. diff --git a/docs/site/content/docs/latest/workload-clusters.md b/docs/site/content/docs/latest/workload-clusters.md index 861f492ea9..8a9bf39dfd 100644 --- a/docs/site/content/docs/latest/workload-clusters.md +++ b/docs/site/content/docs/latest/workload-clusters.md @@ -25,10 +25,10 @@ For specific configuration parameters for vSphere and Amazon EC2, see: ## Before You Begin - Copy the configuration file: When you deploy a workload cluster, most of the configuration for the cluster is the same as the configuration of the management cluster. The easiest way to obtain an initial configuration file for a workload cluster is to make a copy of the management cluster configuration file and to update it. Locate the YAML configuration file for the management cluster. - - If you deployed the management cluster from the installer interface, the configuration file is here: ``~/.tanzu/tkg/clusterconfigs/.yaml`` + - If you deployed the management cluster from the installer interface, the configuration file is here: ``~/.config/tanzu/tkg/clusterconfigs/.yaml`` where ```` is either the name you specified in the installer interface or else the randomly generated name if you didn’t specify a name. - - If you deployed the management cluster from the Tanzu CLI, the configuration file is in the default location (`~/.tanzu/tkg/cluster-config.yaml`) or in the location you specified in the ``--file`` parameter. + - If you deployed the management cluster from the Tanzu CLI, the configuration file is in the default location (`~/.config/tanzu/tkg/cluster-config.yaml`) or in the location you specified in the ``--file`` parameter. - vSphere: If you are deploying workload clusters to vSphere, each cluster requires one static virtual IP address to provide a stable endpoint for Kubernetes. Make sure that this IP address is not in the DHCP range, but is in the same subnet as the DHCP range. - Create namespaces: To help you to organize and manage your development projects, you can optionally divide the management cluster into Kubernetes namespaces. You can then use Tanzu CLI to deploy workload clusters to specific namespaces in your management cluster. For example, you might want to create different types of workload clusters in dedicated namespaces. If you do not create additional namespaces, Tanzu Community Edition creates all workload clusters in the `default` namespace. Complete the following steps: @@ -48,7 +48,7 @@ For specific configuration parameters for vSphere and Amazon EC2, see: 1. Optional: Specify the number of worker nodes for the cluster in the `WORKER_MACHINE_COUNT` variable. 1. Optional: Deploy a workload cluster in a specific namespace. If you have created namespaces, you can deploy workload clusters to those namespaces by specifying the `NAMESPACE` variable. If you do not specify the `NAMESPACE` variable, Tanzu Community Edition places clusters in the `default` namespace. Any namespace that you identify in the `NAMESPACE` variable must exist in the management cluster before you run the command. You must provide a unique name for all workload clusters across all namespaces. If you provide a workload cluster name that is already in use in another namespace in the same instance, the deployment fails with an error. -1. Optional: To configure a workload cluster to use an OS other than the default Ubuntu v21.04, you must set the `OS_NAME` and `OS_VERSION` values in the cluster configuration file. The installer interface does not include node VM OS values in the management cluster configuration files that it saves to `~/.tanzu/tkg/clusterconfigs`. +1. Optional: To configure a workload cluster to use an OS other than the default Ubuntu v21.04, you must set the `OS_NAME` and `OS_VERSION` values in the cluster configuration file. The installer interface does not include node VM OS values in the management cluster configuration files that it saves to `~/.config/tanzu/tkg/clusterconfigs`. 1. Run the following command to deploy the workload cluster: ```sh