From 8297c30e2ff81d957672b75bc441c2250c85a98e Mon Sep 17 00:00:00 2001 From: Tanvir Tatla Date: Fri, 8 Sep 2023 15:19:24 -0700 Subject: [PATCH 1/3] Update vSphere Prereq Doc --- .../vsphere/customize/vsphere-ovas.md | 4 ++-- .../getting-started/vsphere/vsphere-prereq.md | 22 +++++++++---------- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/content/en/docs/getting-started/vsphere/customize/vsphere-ovas.md b/docs/content/en/docs/getting-started/vsphere/customize/vsphere-ovas.md index ba61bf05df35..121cdb436547 100644 --- a/docs/content/en/docs/getting-started/vsphere/customize/vsphere-ovas.md +++ b/docs/content/en/docs/getting-started/vsphere/customize/vsphere-ovas.md @@ -10,7 +10,7 @@ description: > If you want to specify an OVA template, you will need to import OVA files into vSphere before you can use it in your EKS Anywhere cluster. This guide was written using VMware Cloud on AWS, -but the [VMware OVA import guide can be found here](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-17BEDA21-43F6-41F4-8FB2-E01D275FE9B4.html). +but the [VMware OVA import guide can be found here.](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-17BEDA21-43F6-41F4-8FB2-E01D275FE9B4.html) {{% alert title="Note" color="primary" %}} If you don't specify a template in the cluster spec file, EKS Anywhere will use the proper default one for the Kubernetes minor version and OS family you specified in the spec file. @@ -29,7 +29,7 @@ EKS Anywhere supports the following operating system families * Ubuntu * RHEL -A list of OVAs for this release can be found on the [artifacts page]({{< relref "../../../osmgmt/artifacts" >}}). +A list of OVAs for this release can be found on the [artifacts page.]({{< relref "../../../osmgmt/artifacts" >}}) ## Using vCenter Web User Interface diff --git a/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md b/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md index c38941fe4077..4dedb26f7aa7 100644 --- a/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md +++ b/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md @@ -15,15 +15,15 @@ Set up an Administrative machine as described in [Install EKS Anywhere ]({{< rel ### Prepare a VMware vSphere environment To prepare a VMware vSphere environment to run EKS Anywhere, you need the following: -* A vSphere 7+ environment running vCenter -* Capacity to deploy 6-10 VMs -* [DHCP service]({{< relref "customize/vsphere-dhcp/" >}}) running in vSphere environment in the primary VM network for your workload cluster +* A vSphere 7+ environment running vCenter. +* Capacity to deploy 6-10 VMs. +* [DHCP service]({{< relref "customize/vsphere-dhcp/" >}}) running in vSphere environment in the primary VM network for your workload cluster. * [Prepare DHCP IP addresses pool]({{< relref "../../clustermgmt/cluster-upgrades/vsphere-and-cloudstack-upgrades.md/#prepare-dhcp-ip-addresses-pool" >}}) * One network in vSphere to use for the cluster. EKS Anywhere clusters need access to vCenter through the network to enable self-managing and storage capabilities. * An [OVA]({{< relref "customize/vsphere-ovas/" >}}) imported into vSphere and converted into a template for the workload VMs -* User credentials to create VMs and attach networks, etc +* It's critical that you set up your [vSphere user credentials properly.]({{< relref "../vsphere-preparation#configuring-vsphere-user-group-and-roles" >}}) * One IP address routable from cluster but excluded from DHCP offering. - This IP address is to be used as the [Control Plane Endpoint IP]({{< relref "./vsphere-spec/#controlplaneconfigurationendpointhost-required" >}}) + This IP address is to be used as the [Control Plane Endpoint IP.]({{< relref "./vsphere-spec/#controlplaneconfigurationendpointhost-required" >}}) Below are some suggestions to ensure that this IP address is never handed out by your DHCP server. @@ -50,10 +50,10 @@ The administrative machine and the target workload environment will need network You need to get the following information before creating the cluster: * **Static IP Addresses**: -You will need one IP address for the management cluster control plane endpoint, and a separate one for the controlplane of each workload cluster you add. +You will need one IP address for the management cluster control plane endpoint, and a separate IP address for the control plane of each workload cluster you add. Let’s say you are going to have the management cluster and two workload clusters. -For those, you would need three IP addresses, one for each. +For those, you would need three IP addresses, one for each cluster. All of those addresses will be configured the same way in the configuration file you will generate for each cluster. A static IP address will be used for each control plane VM in your EKS Anywhere cluster. @@ -79,14 +79,14 @@ A separate IP address must be assigned for each workload cluster. * **thumbprint** (required if insecure=false): The SHA1 thumbprint of the vCenter server certificate which is only required if you have a self-signed certificate for your vSphere endpoint. There are several ways to obtain your vCenter thumbprint. -If you have [govc installed](https://github.com/vmware/govmomi/blob/master/govc/README.md), you can run the following command in the Administrative machine terminal, and take a note of the output: +If you have [govc installed,](https://github.com/vmware/govmomi/blob/master/govc/README.md) you can run the following command in the Administrative machine terminal, and take a note of the output: ```bash govc about.cert -thumbprint -k ``` * **template**: The VM template to use for your EKS Anywhere cluster. -This template was created when you imported the OVA file into vSphere. +This template was created when you imported the [OVA file]({{< relref "../vsphere-preparation##deploy-an-ova-template" >}}) into vSphere. ![Import ova wizard](/images/ovatemplate.png) @@ -96,7 +96,7 @@ This template was created when you imported the OVA file into vSphere. * **folder**: -The folder parameter in VSphereMachineConfig allows you to organize the VMs of an EKS Anywhere cluster. +The [folder]({{< relref "../vsphere-preparation#configuring-folder-resources" >}}) parameter in VSphereMachineConfig allows you to organize the VMs of an EKS Anywhere cluster. With this, each cluster can be organized as a folder in vSphere. You will have a separate folder for the management cluster and each cluster you are adding. @@ -104,6 +104,6 @@ You will have a separate folder for the management cluster and each cluster you * **resourcePool**: -The vSphere Resource pools for your VMs in the EKS Anywhere cluster. If there is a resource pool: `//host//Resources` +The vSphere resource pools for your VMs in the EKS Anywhere cluster. If there is a resource pool: `//host//Resources` ![Import ova wizard](/images/resourcepool.png) From 8c123f9ed4c1c25ec3cf9367e5d0160f1f1c56f2 Mon Sep 17 00:00:00 2001 From: Tanvir Tatla Date: Mon, 2 Oct 2023 15:53:39 -0700 Subject: [PATCH 2/3] fix relref --- .../en/docs/getting-started/vsphere/vsphere-prereq.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md b/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md index 4dedb26f7aa7..da5c7f9b410e 100644 --- a/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md +++ b/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md @@ -21,7 +21,7 @@ To prepare a VMware vSphere environment to run EKS Anywhere, you need the follow * [Prepare DHCP IP addresses pool]({{< relref "../../clustermgmt/cluster-upgrades/vsphere-and-cloudstack-upgrades.md/#prepare-dhcp-ip-addresses-pool" >}}) * One network in vSphere to use for the cluster. EKS Anywhere clusters need access to vCenter through the network to enable self-managing and storage capabilities. * An [OVA]({{< relref "customize/vsphere-ovas/" >}}) imported into vSphere and converted into a template for the workload VMs -* It's critical that you set up your [vSphere user credentials properly.]({{< relref "../vsphere-preparation#configuring-vsphere-user-group-and-roles" >}}) +* It's critical that you set up your [vSphere user credentials properly.]({{< relref "./vsphere-preparation#configuring-vsphere-user-group-and-roles" >}}) * One IP address routable from cluster but excluded from DHCP offering. This IP address is to be used as the [Control Plane Endpoint IP.]({{< relref "./vsphere-spec/#controlplaneconfigurationendpointhost-required" >}}) @@ -86,7 +86,7 @@ If you have [govc installed,](https://github.com/vmware/govmomi/blob/master/govc ``` * **template**: The VM template to use for your EKS Anywhere cluster. -This template was created when you imported the [OVA file]({{< relref "../vsphere-preparation##deploy-an-ova-template" >}}) into vSphere. +This template was created when you imported the [OVA file]({{< relref "./vsphere-preparation##deploy-an-ova-template" >}}) into vSphere. ![Import ova wizard](/images/ovatemplate.png) @@ -96,7 +96,7 @@ This template was created when you imported the [OVA file]({{< relref "../vspher * **folder**: -The [folder]({{< relref "../vsphere-preparation#configuring-folder-resources" >}}) parameter in VSphereMachineConfig allows you to organize the VMs of an EKS Anywhere cluster. +The [folder]({{< relref "./vsphere-preparation#configuring-folder-resources" >}}) parameter in VSphereMachineConfig allows you to organize the VMs of an EKS Anywhere cluster. With this, each cluster can be organized as a folder in vSphere. You will have a separate folder for the management cluster and each cluster you are adding. From db0c91ccf549211453ee3b441373c7bf622c08c4 Mon Sep 17 00:00:00 2001 From: Tanvir Tatla Date: Mon, 2 Oct 2023 17:23:25 -0700 Subject: [PATCH 3/3] fix typo in relref --- docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md b/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md index da5c7f9b410e..5284ebe13f8f 100644 --- a/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md +++ b/docs/content/en/docs/getting-started/vsphere/vsphere-prereq.md @@ -86,7 +86,7 @@ If you have [govc installed,](https://github.com/vmware/govmomi/blob/master/govc ``` * **template**: The VM template to use for your EKS Anywhere cluster. -This template was created when you imported the [OVA file]({{< relref "./vsphere-preparation##deploy-an-ova-template" >}}) into vSphere. +This template was created when you imported the [OVA file]({{< relref "./vsphere-preparation#deploy-an-ova-template" >}}) into vSphere. ![Import ova wizard](/images/ovatemplate.png)