Skip to content
This repository has been archived by the owner on Jun 28, 2023. It is now read-only.

Doc - Multiple issues #1231

Merged
merged 12 commits into from
Aug 5, 2021
4 changes: 2 additions & 2 deletions docs/headless-install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/site/content/docs/assets/aws-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Amazon EC2.
1. Next you will create a guest cluster. First, setup a guest cluster config file.

```sh
cp ~/.tanzu/tkg/clusterconfigs/<MGMT-CONFIG-FILE> ~/.tanzu/tkg/clusterconfigs/guest1.yaml
cp ~/.config/tanzu/tkg/clusterconfigs/<MGMT-CONFIG-FILE> ~/.config/tanzu/tkg/clusterconfigs/guest1.yaml
```

> ``<MGMT-CONFIG-FILE>`` is the name of the management cluster YAML config file
Expand All @@ -101,7 +101,7 @@ Amazon EC2.

[](ignored)

1. In the new guest cluster file (`~/.tanzu/tkg/clusterconfigs/guest1.yaml`), edit the CLUSTER_NAME parameter to assign a name to your guest cluster. For example,
1. In the new guest cluster file (`~/.config/tanzu/tkg/clusterconfigs/guest1.yaml`), edit the CLUSTER_NAME parameter to assign a name to your guest cluster. For example,

```yaml
CLUSTER_CIDR: 100.96.0.0/11
Expand All @@ -118,7 +118,7 @@ Amazon EC2.
1. Create your guest cluster.

```sh
tanzu cluster create ${GUEST_CLUSTER_NAME} --file ${HOME}/.tanzu/tkg/clusterconfigs/guest1.yaml
tanzu cluster create ${GUEST_CLUSTER_NAME} --file ~/.config/tanzu/tkg/clusterconfigs/guest1.yaml
```

1. Validate the cluster starts successfully.
Expand Down
5 changes: 3 additions & 2 deletions docs/site/content/docs/assets/cli-install-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
1. Unpack the release.

```sh
tar xzvf ~/Downloads/tce-linux-amd64-v0.6.0.tar.gz
tar xzvf ~/<DOWNLOAD-DIR>/tce-linux-amd64-v0.6.0.tar.gz
```

1. Run the install script (make sure to use the appropriate directory for your platform).
Expand All @@ -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.
10 changes: 4 additions & 6 deletions docs/site/content/docs/assets/cli-install-mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
1. Unpack the release.

```sh
tar xzvf ~/Downloads/tce-darwin-amd64-v0.6.0.tar.gz
tar xzvf ~/<DOWNLOAD-DIR>/tce-darwin-amd64-v0.6.0.tar.gz
```

1. Run the install script.
Expand All @@ -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
```
6 changes: 3 additions & 3 deletions docs/site/content/docs/assets/final-step.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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).
<!--note to self - this is a vmware.com url, question out to eng-team on this-->
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 `~/.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.
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.
<!--The image below shows the configuration for a deployment to vSphere.
![Review the management cluster configuration](../images/review-settings-vsphere.png)-->
3. (Optional) Under **CLI Command Equivalent**, click the **Copy** button to copy the CLI command for the configuration that you specified.
Expand All @@ -16,10 +16,10 @@
5. 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)-->
![Monitor the management cluster deployment](../images/mgmt-cluster-deployment.png)-->

<!--## <a id="what-next"></a> What to Do Next

Expand Down
2 changes: 1 addition & 1 deletion docs/site/content/docs/assets/step1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This topic describes how to use the Tanzu installer interface to deploy a management cluster. The installer interface launches in a browser and takes you through steps to configure the management. The input values are saved in: `~/.tanzu/tkg/clusterconfigs/cluster-config.yaml`.
This topic describes how to use the Tanzu installer interface to deploy a management cluster. The installer interface launches in a browser and takes you through steps to configure the management. The input values are saved in: `~/.config/tanzu/tkg/clusterconfigs/cluster-config.yaml`.

## Before you begin

Expand Down
8 changes: 4 additions & 4 deletions docs/site/content/docs/assets/vsphere-clusters.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ vSphere.
1. Next you will create a guest cluster. First, setup a guest cluster config file.

```sh
cp ~/.tanzu/tkg/clusterconfigs/<MGMT-CONFIG-FILE> ~/.tanzu/tkg/clusterconfigs/guest1.yaml
cp ~/.config/tanzu/tkg/clusterconfigs/<MGMT-CONFIG-FILE> ~/.config/tanzu/tkg/clusterconfigs/guest1.yaml
```
> ``<MGMT-CONFIG-FILE>`` is the name of the management cluster YAML config file

Expand All @@ -108,7 +108,7 @@ vSphere.
[](ignored)


1. In the new guest cluster file (`~/.tanzu/tkg/clusterconfigs/guest1.yaml`), edit the CLUSTER_NAME parameter to assign a name to your guest cluster. For example,
1. In the new guest cluster file (`~/.config/tanzu/tkg/clusterconfigs/guest1.yaml`), edit the CLUSTER_NAME parameter to assign a name to your guest cluster. For example,

```yaml
CLUSTER_CIDR: 100.96.0.0/11
Expand All @@ -119,7 +119,7 @@ vSphere.
* If you did not specify a name for your management cluster, the installer generated a unique name, in this case, you must manually add the CLUSTER_NAME parameter and assign a guest cluster name.
* If you specified a name for your management cluster, the CLUSTER_NAME parameter is present and needs to be changed to the new guest cluster name.

1. In the guest cluster file (`~/.tanzu/tkg/clusterconfigs/guest1.yaml`), edit the VSPHERE_CONTROL_PLANE_ENDPOINT parameter to apply a viable IP.
1. In the guest cluster file (`~/.config/tanzu/tkg/clusterconfigs/guest1.yaml`), edit the VSPHERE_CONTROL_PLANE_ENDPOINT parameter to apply a viable IP.

> This will be the API Server IP for your guest cluster. You must choose an IP that is routable and not used elsewhere in your network, e.g., out of your DHCP range.

Expand All @@ -133,7 +133,7 @@ vSphere.
1. Create your guest cluster.

```sh
tanzu cluster create ${GUEST_CLUSTER_NAME} --file ${HOME}/.tanzu/tkg/clusterconfigs/guest1.yaml
tanzu cluster create ${GUEST_CLUSTER_NAME} --file ~/.config/tanzu/tkg/clusterconfigs/guest1.yaml
```

1. Validate the cluster starts successfully.
Expand Down
1 change: 1 addition & 0 deletions docs/site/content/docs/latest/cli-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Windows is not directly supported right now, if you are bootstrapping from a Wi
* Install Windows Subsystem for Linux, for more information, see [Windows Subsystem for Linux Installation Guide for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
* Ensure your bootstrap machine has the following prerequisites:
* 6 GB of RAM and a 2-core CPU
* You must download and install the latest version of `kubectl`. For more information, see [Install Tools](https://kubernetes.io/docs/tasks/tools/) in the Kubernetes documentation.

## Procedure

Expand Down
12 changes: 6 additions & 6 deletions docs/site/content/docs/latest/deploy-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ This section applies to all infrastructure providers.

- **vSphere**: You must enter the CIDR of the vSphere network that you selected under **Network Name**. The vSphere network CIDR includes the IP address of your **Control Plane Endpoint**. If you entered an FQDN under **Control Plane Endpoint**, add both the FQDN and the vSphere network CIDR to **No proxy**. Internally, Tanzu Kubernetes Grid appends `localhost`, `127.0.0.1`, the values of **Cluster Pod CIDR** and **Cluster Service CIDR**, `.svc`, and `.svc.cluster.local` to the list that you enter in this field.
- **Amazon EC2**: Internally, Tanzu Kubernetes Grid appends `localhost`, `127.0.0.1`, your VPC CIDR, **Cluster Pod CIDR**, and **Cluster Service CIDR**, `.svc`, `.svc.cluster.local`, and `169.254.0.0/16` to the list that you enter in this field.


**Important:** If the management cluster VMs need to communicate with external services and infrastructure endpoints in your Tanzu Kubernetes Grid environment, ensure that those endpoints are reachable by the proxies that you configured above or add them to **No proxy**. Depending on your environment configuration, this may include, but is not limited to, your OIDC or LDAP server, Harbor, and in the case of vSphere, NSX-T and NSX Advanced Load Balancer.

**Important:** If the management cluster VMs need to communicate with external services and infrastructure endpoints in your Tanzu Kubernetes Grid environment, ensure that those endpoints are reachable by the proxies that you configured above or add them to **No proxy**. Depending on your environment configuration, this may include, but is not limited to, your OIDC or LDAP server, Harbor, and in the case of vSphere, NSX-T and NSX Advanced Load Balancer.



Expand All @@ -51,13 +51,13 @@ This section applies to all infrastructure providers.
## <a id="id-mgmt"></a> Configure Identity Management

For information about how Tanzu Kubernetes Grid implements identity management, see [Enabling Identity Management in Tanzu Kubernetes Grid](enabling-id-mgmt.md).
<!-- ??I don't know if this is something we want to reference or if we need to supply our own??? I presume this full section needs to be reworked for TCE -->
<!-- ??I don't know if this is something we want to reference or if we need to supply our own??? I presume this full section needs to be reworked for TCE -->

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**:
Expand Down Expand Up @@ -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.

Expand All @@ -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)
Expand Down
Loading