From 26fa84152b1138cf2fedf1effa648fb05ef32be0 Mon Sep 17 00:00:00 2001 From: shanrajad23 Date: Wed, 6 Nov 2024 15:32:37 +0530 Subject: [PATCH 1/3] fixing vmware and other doc links Signed-off-by: shanrajad23 --- src/deployment-guides/pinniped-with-tkg.md | 12 +++---- src/deployment-guides/tap.md | 14 ++++---- src/deployment-guides/tkg-data-protection.md | 6 ++-- src/deployment-guides/tkg-nsxt-airgap.md | 33 +++++++++---------- src/deployment-guides/tkg-package-install.md | 4 +-- .../tkg-vsphere-vds-airgap.md | 18 +++++----- src/deployment-guides/tko-aws.md | 28 ++++++++-------- 7 files changed, 57 insertions(+), 58 deletions(-) diff --git a/src/deployment-guides/pinniped-with-tkg.md b/src/deployment-guides/pinniped-with-tkg.md index b6843d43..a4457ef2 100644 --- a/src/deployment-guides/pinniped-with-tkg.md +++ b/src/deployment-guides/pinniped-with-tkg.md @@ -29,11 +29,11 @@ To use your company’s internal LDAPS server as the identity provider, obtain L To use OIDC as the identity provider, you must have an account with an identity provider that supports the OpenID Connect standard, for example, [Okta](https://www.okta.com/). -For more information on using Okta as your OIDC provider, see [Register a Tanzu Kubernetes Grid Application in Okta](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-iam-configure-id-mgmt.html#obtain-your-identity-provider-details-3). +For more information on using Okta as your OIDC provider, see [Register a Tanzu Kubernetes Grid Application in Okta](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html#during). ### Configure LDAPS or OIDC Settings in Tanzu Kubernetes Grid -When you are deploying your management cluster using the installer interface, configure LDAPS or OIDC in the Identity Management section. For instructions, see [Configure Identity Management](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-mgmt-clusters-deploy-ui.html#id-mgmt) in Deploy Management Clusters with the Installer Interface. +When you are deploying your management cluster using the installer interface, configure LDAPS or OIDC in the Identity Management section. For instructions, see [Configure Identity Management](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html) in Deploy Management Clusters with the Installer Interface. 1. In the **Identity Management** section of the management cluster deployment UI, 1. Enable **Enable Identity Management Settings**. @@ -104,9 +104,9 @@ To use your company’s internal LDAPS server as the identity provider, obtain L To use OIDC as the identity provider, you must have an account with an identity provider that supports the OpenID Connect standard, for example, [Okta](https://www.okta.com/). -For more information on using Okta as your OIDC provider, see [Register a Tanzu Kubernetes Grid Application in Okta](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-iam-configure-id-mgmt.html#obtain-your-identity-provider-details-3). +For more information on using Okta as your OIDC provider, see [Register a Tanzu Kubernetes Grid Application in Okta](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html#during). -For more information on obtaining your identity provider details, see [Obtain Your Identity Provider Details](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-iam-configure-id-mgmt.html#idp). +For more information on obtaining your identity provider details, see [Obtain Your Identity Provider Details](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html). ### Generate the Pinniped Add-on Secret for the Management Cluster and deploy Pinniped package @@ -298,7 +298,7 @@ After deploying the management cluster, do the following to complete the identit - **OIDC**: Check the Status of an OIDC Identity Management Service. - **LDAP**: Check the Status of an LDAP Identity Management Service. - **OIDC**: Provide the Callback URI to the OIDC Provider. -3. If you want to use regular, non-administrator `kubeconfig` files for access to the management cluster, after completing the configuration of identity management, configure RBAC by following the instructions in [Configure RBAC for a Management Cluster](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-iam-configure-rbac.html#rbac-mgmt). +3. If you want to use regular, non-administrator `kubeconfig` files for access to the management cluster, after completing the configuration of identity management, configure RBAC by following the instructions in [Configure RBAC for a Management Cluster](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-rbac.html#rbac-mgmt). ## Connect kubectl to the Management Cluster @@ -572,7 +572,7 @@ If a workload cluster was created before you enabled identity management for you To give users access to a management or a workload cluster, you generate a `kubeconfig` file and then share the file with those users. If you provide them with the administrator `kubeconfig` for the cluster, they have full access to the cluster and do not need to be authenticated. However, if you provide users with the regular `kubeconfig`, they must have a user account in your OIDC or LDAP identity provider and you must configure RBAC on the cluster to grant access permissions to the designated user. -For more information on how to configure role-based access control (RBAC) in Tanzu Kubernetes Grid, see [Configure RBAC](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-iam-configure-rbac.html#rbac-mgmt). +For more information on how to configure role-based access control (RBAC) in Tanzu Kubernetes Grid, see [Configure RBAC](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-rbac.html). ### Generate and Test a Non-Administrator `kubeconfig` File for the Tanzu Clusters diff --git a/src/deployment-guides/tap.md b/src/deployment-guides/tap.md index 9803dc0e..63a715c8 100644 --- a/src/deployment-guides/tap.md +++ b/src/deployment-guides/tap.md @@ -24,7 +24,7 @@ Before deploying VMware Tanzu Application Platform, ensure that the following pr * Accept the End User License Agreements (EULAs). * The Kubernetes CLI, kubectl, v1.20, v1.21 or v1.22, installed and authenticated with administrator rights for your target cluster. -Additional details concerning prerequisites may be found in Tanzu Application Platform [documentation](https://docs.vmware.com/en/Tanzu-Application-Platform/1.1/tap/GUID-prerequisites.html). +Additional details concerning prerequisites may be found in Tanzu Application Platform [documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/overview.html). >**Note** Use the Kubernetes defaults `serviceDomain` of `cluster.local` in workload clusters where Tanzu Application Platform is deployed. @@ -149,7 +149,7 @@ Provide following user inputs to set environment variables into commands and exe * `INSTALL_REGISTRY_USERNAME`- tanzu net username * `INSTALL_REGISTRY_PASSWORD` - tanzu net password - For more information, see [Build Profile](https://docs.vmware.com/en/VMware-Tanzu-Application-Platform/1.1/tap/GUID-multicluster-reference-tap-values-build-sample.html) in the Tanzu Application Platform product documentation. + For more information, see [Build Profile](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/multicluster-reference-tap-values-build-sample.html) in the Tanzu Application Platform product documentation. ```bash set -e @@ -281,7 +281,7 @@ Provide the following user inputs to set environments variables into commands an >**Note** Contour settings in tap-values-run.yaml must be modified if you are not using AWS. - For more information, see [Run Profile](https://docs.vmware.com/en/VMware-Tanzu-Application-Platform/1.1/tap/GUID-multicluster-reference-tap-values-run-sample.html) in the Tanzu Application Platform product documentation. + For more information, see [Run Profile](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/multicluster-reference-tap-values-run-sample.html) in the Tanzu Application Platform product documentation. ```bash set -e @@ -355,7 +355,7 @@ Provide following user inputs to set environments variables into commands and ex See this [example](https://github.com/sendjainabhi/tap/blob/main/catalog-info.yaml) * `TAP_RUN_CLUSTER_NAME` - Run cluster name - See [View Profile](https://docs.vmware.com/en/VMware-Tanzu-Application-Platform/1.1/tap/GUID-multicluster-reference-tap-values-view-sample.html) for more details. + See [View Profile](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/multicluster-reference-tap-values-view-sample.html) for more details. @@ -559,7 +559,7 @@ Perform the steps outlined in [Configure developer namespaces to use installed p ### Deploy Sample Application See the steps to deploy and test the [sample application](#tap-sample-app). -For more information, also see [Getting started with the Tanzu Application Platform](https://docs.vmware.com/en/Tanzu-Application-Platform/1.1/tap/GUID-getting-started.html). +For more information, also see [Getting started with the Tanzu Application Platform](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/getting-started.html). ## Set Up Tanzu Application Platform Iterate Cluster @@ -752,12 +752,12 @@ kubectl get ksvc In the event of failure, use the following command to obtain failure details: `kubectl get packageinstall/ -n tap-install -o yaml`. -See [Troubleshooting Tanzu Application Platform Tips](https://docs.vmware.com/en/Tanzu-Application-Platform/1.1/tap/GUID-troubleshooting.html) for additional details. +See [Troubleshooting Tanzu Application Platform Tips](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/troubleshooting.html) for additional details. ### Service Bindings for Kubernetes -See [Service Bindings for Kubernetes](https://docs.vmware.com/en/Tanzu-Application-Platform/1.1/tap/GUID-service-bindings-about.html) for additional details. +See [Service Bindings for Kubernetes](https://techdocs.broadcom.com/us/en/vmware-tanzu/platform/tanzu-platform-hub/saas/tanzu-platform/spaces-concepts-about-services.html#service-bindings) for additional details. ### Tanzu Application Platform GUI Auth Provider diff --git a/src/deployment-guides/tkg-data-protection.md b/src/deployment-guides/tkg-data-protection.md index a936d1d6..938c9769 100644 --- a/src/deployment-guides/tkg-data-protection.md +++ b/src/deployment-guides/tkg-data-protection.md @@ -9,11 +9,11 @@ Before you enable Data Protection on a workload cluster, ensure the following pr - The workload cluster that you want to protect is registered or attached with Tanzu Mission Control. -- You have created a credential for Data Protection as per instructions provided in the Tanzu Mission Control [documentation](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-4F349EE4-9C64-4243-84FF-D287F497A3D0.html). +- You have created a credential for Data Protection as per instructions provided in the Tanzu Mission Control [documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-4F349EE4-9C64-4243-84FF-D287F497A3D0.html). -- You have created a Target Location for Data Protection as per instructions provided in the Tanzu Mission Control [documentation](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-867683CE-8AF0-4DC7-9121-81AD507EDB3B.html). +- You have created a Target Location for Data Protection as per instructions provided in the Tanzu Mission Control [documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-867683CE-8AF0-4DC7-9121-81AD507EDB3B.html). -For more information about protecting the data resources in your Kubernetes clusters, see Data Protection in [VMware Tanzu Mission Control Concepts](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-concepts/GUID-C16557BC-EB1B-4414-8E63-28AD92E0CAE5.html). +For more information about protecting the data resources in your Kubernetes clusters, see Data Protection in [VMware Tanzu Mission Control Concepts](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-concepts-GUID-C16557BC-EB1B-4414-8E63-28AD92E0CAE5.html). ## Enable Data Protection on Workload Cluster diff --git a/src/deployment-guides/tkg-nsxt-airgap.md b/src/deployment-guides/tkg-nsxt-airgap.md index 6396f3ec..b400a243 100644 --- a/src/deployment-guides/tkg-nsxt-airgap.md +++ b/src/deployment-guides/tkg-nsxt-airgap.md @@ -34,7 +34,7 @@ Before deploying Tanzu Kubernetes Grid in the your VMware NSX environment, ensur - A vCenter with NSX backed environment. - Ensure that the following NSX configurations are complete: - > **Note** The following configurations provide only a high-level overview of the required NSX configuration. For more information, see [NSX Data Center Installation Guide](https://docs.vmware.com/en/VMware-NSX/4.1/installation/GUID-3E0C4CEC-D593-4395-84C4-150CD6285963.html) and [NSX Data Center Product Documentation](https://docs.vmware.com/en/VMware-NSX/index.html). + > **Note** The following configurations provide only a high-level overview of the required NSX configuration. For more information, see [NSX Data Center Installation Guide](https://techdocs.broadcom.com/us/en/vmware-cis/nsx/vmware-nsx/4-2/installation-guide/nsx-transformers-installation-guide.html) and [NSX Data Center Product Documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx.html). - NSX manager instance is deployed and configured with Advanced or higher license. - vCenter Server that is associated with the NSX Data Center is configured as Compute Manager. @@ -54,17 +54,17 @@ Before deploying Tanzu Kubernetes Grid in the your VMware NSX environment, ensur - A datastore with sufficient capacity for the control plane and worker node VM files. - Network time protocol (NTP) service is running on all hosts and vCenter. - A host, server, or VM based on Linux, macOS, or Windows which acts as your bootstrap machine which has docker installed. For this deployment, a virtual machine based on Photon OS will be used. - - Depending on the OS flavor of the bootstrap VM, download and configure the following packages from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). To configure required packages on the Cent OS machine, see [Deploy and Configure Bootstrap Machine](#configurebootstrap): + - Depending on the OS flavor of the bootstrap VM, download and configure the following packages from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid). To configure required packages on the Cent OS machine, see [Deploy and Configure Bootstrap Machine](#configurebootstrap): - Tanzu CLI 2.3.0 - Kubectl cluster CLI 1.26.5 - - A vSphere account with permissions as described in [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). + - A vSphere account with permissions as described in [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html). - Download and import NSX Advanced Load Balancer 22.1.3 OVA to Content Library. - - Download the following OVA files from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x) and import to vCenter. Convert the imported VMs to templates: + - Download the following OVA files from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid) and import to vCenter. Convert the imported VMs to templates: - Photon v3 Kubernetes v1.26.5 OVA and/or - Ubuntu 2004 Kubernetes v1.26.5 OVA -> **Note** You can also download supported older versions of Kubernetes from [VMware Customer Connect](https://customerconnect.vmware.com/en/downloads/details?downloadGroup=TKG-160&productId=988&rPId=93384) and import them to deploy workload clusters on the intended Kubernetes versions.

-> **Note** In Tanzu Kubernetes Grid nodes, it is recommended not to use hostnames with ".local" domain suffix. For more information, see [KB article](https://kb.vmware.com/s/article/83623). +> **Note** You can also download supported older versions of Kubernetes from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid) and import them to deploy workload clusters on the intended Kubernetes versions.

+> **Note** In Tanzu Kubernetes Grid nodes, it is recommended not to use hostnames with ".local" domain suffix. For more information, see [KB article](https://knowledge.broadcom.com/external/article?legacyId=83623). ### Resource Pools and VM Folders @@ -116,7 +116,7 @@ Here are the high-level steps for deploying Tanzu Kubernetes Grid on NSX network ## Configure T1 Gateway and Logical Segments in NSX-T Data Center -As a prerequisite, an NSX-T backed vSphere environment must be configured with at least one tier-0 gateway. A tier-0 gateway performs the functions of a tier-0 logical router. It processes traffic between the logical and physical networks. For more information about creating and configuring a tier-0 gateway, see [NSX documentation](https://docs.vmware.com/en/VMware-NSX/4.1/administration/GUID-E9E62E02-C226-457D-B3A6-FE71E45628F7.html). +As a prerequisite, an NSX-T backed vSphere environment must be configured with at least one tier-0 gateway. A tier-0 gateway performs the functions of a tier-0 logical router. It processes traffic between the logical and physical networks. For more information about creating and configuring a tier-0 gateway, see [NSX documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx/vmware-nsx/4-2/administration-guide/tier-0-gateways.html). This procedure comprises the following tasks: @@ -125,7 +125,7 @@ This procedure comprises the following tasks: ### Add a Tier-1 Gateway -The tier-1 logical router must be connected to the tier-0 logical router to get the northbound physical router access. The following procedure provides the minimum required configuration to create a tier-1 gateway, which is adequate to successfully deploy the Tanzu for Kubernetes Operations stack. For a more advanced configuration, see the [NSX documentation](https://docs.vmware.com/en/VMware-NSX/index.html). +The tier-1 logical router must be connected to the tier-0 logical router to get the northbound physical router access. The following procedure provides the minimum required configuration to create a tier-1 gateway, which is adequate to successfully deploy the Tanzu for Kubernetes Operations stack. For a more advanced configuration, see the [NSX documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx.html). 1. With admin privileges, log in to NSX Manager. 1. Select **Networking** > **Tier-1 Gateways**. @@ -215,7 +215,7 @@ Repeat steps 1-7 to create all other required overlay-backed segments. Once comp ![List of created segments](img/tkg-airgap-nsxt/T1-gateway-07.png) -Additionally, you can create the required inventory groups and firewall rules. For more information, see the [NSX Data Center Product Documentation](https://docs.vmware.com/en/VMware-NSX/index.html). +Additionally, you can create the required inventory groups and firewall rules. For more information, see the [NSX Data Center Product Documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx.html). ## Deploy and Configure NSX Advanced Load Balancer NSX Advanced Load Balancer (ALB) is an enterprise-grade integrated load balancer that provides L4- L7 load balancer support. @@ -704,9 +704,9 @@ To install Harbor, deploy an operating system of your choice with the following - Memory: 8 GB - Storage (HDD): 160 GB -Follow the instructions provided in [Deploy an Offline Harbor Registry on vSphere](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-harbor.html) to deploy and configure Harbor. +Follow the instructions provided in [Deploy an Offline Harbor Registry on vSphere](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-harbor.html) to deploy and configure Harbor. ->**Note:** This VM-based harbor deployment is only supported for hosting TKG system images in an internet-restricted or air-gapped environment. To deploy a scalable and highly-available Harbor that can manage large numbers of images for hosted apps in a production environment, deploy the Harbor package to TKG clusters as described in [Install Harbor for Service Registry](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html) in Creating and Managing TKG 2.3 Workload Clusters with the Tanzu CLI. +>**Note:** This VM-based harbor deployment is only supported for hosting TKG system images in an internet-restricted or air-gapped environment. To deploy a scalable and highly-available Harbor that can manage large numbers of images for hosted apps in a production environment, deploy the Harbor package to TKG clusters as described in [Install Harbor for Service Registry](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor.html) in Creating and Managing TKG 2.3 Workload Clusters with the Tanzu CLI. ## Deploy and Configure Bootstrap Machine @@ -973,7 +973,7 @@ Before you proceed with the management cluster creation, ensure that the base im - For the management cluster, this must be either Photon or Ubuntu based Kubernetes v1.26.5 OVA. - > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-byoi-index.html). + > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-byoi-index.html). - For workload clusters, OVA can have any supported combination of OS and Kubernetes version, as packaged in a Tanzu Kubernetes release. > **Note** Ensure that you download the most recent OVA base image templates in the event of security patch releases. You can find updated base image templates that include security patches on the Tanzu Kubernetes Grid product download page. @@ -990,7 +990,7 @@ Before you proceed with the management cluster creation, ensure that the base im 1. **If using non administrator SSO account**: In the VMs and Templates view, right-click the new template, select **Add Permission**, and assign the **tkg-user** to the template with the **TKG role**. -For more information about creating the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). +For more information about creating the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). ### Management Cluster Configuration Template @@ -1143,7 +1143,7 @@ To create the Management Cluster, run the following command: tanzu management-cluster create --file config.yaml ``` -- For a full list of configurable values and to know more about the fields present in the template file, see [Create a Management Cluster Configuration File](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-deploy-file.html). +- For a full list of configurable values and to know more about the fields present in the template file, see [Create a Management Cluster Configuration File](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-config-vsphere.html#file). - Create a file using the values provided in the template and save the file with the `.yaml` extension. A sample yaml file used for management cluster deployment is provided in the [Appendix section](#supplemental-information) for your reference. @@ -1682,8 +1682,7 @@ You can see that the workload cluster is successfully deployed and the AKO pod i User-managed packages are installed after workload cluster creation. These packages extend the core functionality of Kubernetes clusters created by Tanzu Kubernetes Grid. -Tanzu Kubernetes Grid includes the following user-managed packages. These packages provide in-cluster and shared services to the Kubernetes clusters that are running in your Tanzu Kubernetes Grid environment.

[Installing and Managing Packages with the Tanzu CLI -](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-index.html) +Tanzu Kubernetes Grid includes the following user-managed packages. These packages provide in-cluster and shared services to the Kubernetes clusters that are running in your Tanzu Kubernetes Grid environment.

[Installing and Managing Packages with the Tanzu CLI](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-index.html) |**Function**|**Package**|**Location**| | --- | --- | --- | @@ -1938,7 +1937,7 @@ Follow this procedure to deploy Harbor into a workload cluster or a shared servi - harborAdminPassword - secretKey - You can also change the values for other parameters to meet the requirements for your deployment. For the full list of the user-configurable values, see [Deploy Harbor into a Cluster](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html). + You can also change the values for other parameters to meet the requirements for your deployment. For the full list of the user-configurable values, see [https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor-mc.html#deploy). 1. Remove the comments in the `harbor-data-values.yaml` file. diff --git a/src/deployment-guides/tkg-package-install.md b/src/deployment-guides/tkg-package-install.md index 523a2490..d91b72d4 100644 --- a/src/deployment-guides/tkg-package-install.md +++ b/src/deployment-guides/tkg-package-install.md @@ -4,7 +4,7 @@ The user-managed packages extend the core functionality of the Kubernetes cluste For example, you can install the Contour package to implement ingress control, the Harbor package to configure a private container registry, or the Fluent Bit, Grafana, and Prometheus packages to collect logs and metrics from your clusters. -You can install Tanzu packages via the CLI by invoking the `tanzu package install` command or directly from Tanzu Mission Control by utilizing the [**TMC Catalog**](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-EF35646D-8762-41F1-95E5-D2F35ED71BA1.html) feature. +You can install Tanzu packages via the CLI by invoking the `tanzu package install` command or directly from Tanzu Mission Control by utilizing the [**TMC Catalog**](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-EF35646D-8762-41F1-95E5-D2F35ED71BA1.html) feature. ## General Instructions for Installing a Package from Tanzu Mission Control @@ -176,7 +176,7 @@ After installing Grafana, ensure that the installation status for the Grafana pa You can use Fluent Bit to gather logs from management clusters or Tanzu Kubernetes clusters running in vSphere, Amazon EC2, and Azure. You can then forward them to a log storage provider such as [Elastic Search](https://www.elastic.co/), [Kafka](https://www.confluent.io/confluent-operator/), [Splunk](https://www.splunk.com/), or an HTTP endpoint. -The example shown in this document uses an HTTP endpoint [VMware Aria Operations for Logs](https://docs.vmware.com/en/VMware-vRealize-Log-Insight-Cloud/index.html) for forwarding logs from Tanzu Kubernetes clusters. +The example shown in this document uses an HTTP endpoint [VMware Aria Operations for Logs](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/vmware-cis/aria/aria-operations-for-logs/SaaS/using-vmware-aria-operations-for-logs-cloud.html) for forwarding logs from Tanzu Kubernetes clusters. A sample YAML file for configuring an http endpoint with Fluent Bit is provided as a reference here. For a full list of user-configurable values, see the [Fluent Bit documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-fluentbit.html). diff --git a/src/deployment-guides/tkg-vsphere-vds-airgap.md b/src/deployment-guides/tkg-vsphere-vds-airgap.md index e834f850..d7ec51f7 100644 --- a/src/deployment-guides/tkg-vsphere-vds-airgap.md +++ b/src/deployment-guides/tkg-vsphere-vds-airgap.md @@ -129,7 +129,7 @@ You must ensure that the following options are available: 3. Download the NSX Advanced Load Balancer OVA from [VMware Customer Connect portal](https://customerconnect.vmware.com/downloads/info/slug/networking_security/vmware_nsx_advanced_load_balancer/22_1_x). -4. Download Tanzu CLI, Kubectl, and the Kubernetes OVA images from the [Tanzu Kubernetes Grid product download page](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). Tanzu CLI and its plug-ins need to be installed on the bastion host and the bootstrap machine. Starting with TKG 2.3.0, [Tanzu Core CLI](https://customerconnect.vmware.com/downloads/details?downloadGroup=TCLI-0901&productId=1431) is now distributed separately from Tanzu Kubernetes Grid. For more infromation about installing the Tanzu CLI for using with Tanzu Kubernetes Grid, see [Install the Tanzu CLI](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/install-cli.html). +4. Download Tanzu CLI, Kubectl, and the Kubernetes OVA images from the [Tanzu Kubernetes Grid product download page](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). Tanzu CLI and its plug-ins need to be installed on the bastion host and the bootstrap machine. Starting with TKG 2.3.0, [Tanzu Core CLI](https://customerconnect.vmware.com/downloads/details?downloadGroup=TCLI-0901&productId=1431) is now distributed separately from Tanzu Kubernetes Grid. For more infromation about installing the Tanzu CLI for using with Tanzu Kubernetes Grid, see [Install the Tanzu CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). 5. Download the [yq](https://github.com/mikefarah/yq) installation binary from the [mikefarah / yq](https://github.com/mikefarah/yq/releases/tag/v4.25.2) GitHub repository. @@ -209,7 +209,7 @@ You must ensure that the following options are available: Install Harbor only if you don’t have any existing image repository in your environment. - For more information about deploying and configuring Harbor, see [Deploy an Offline Harbor Registry on vSphere](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-harbor.html). + For more information about deploying and configuring Harbor, see [Deploy an Offline Harbor Registry on vSphere](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-harbor.html). >**Note** This VM-based harbor deployment is only supported for hosting the TKG system images in an internet-restricted or air-gapped environment. To deploy a scalable and highly-available Harbor that can manage large numbers of images for hosted apps in a production environment, deploy the Harbor package to TKG clusters as described in [Install Harbor for Service Registry](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html) in Creating and Managing TKG 2.3 Workload Clusters with the Tanzu CLI. @@ -219,7 +219,7 @@ The deployment of the Tanzu Kubernetes Grid management and workload clusters is The bootstrap machine runs a local `kind` cluster when Tanzu Kubernetes Grid management cluster deployment is started. Once the `kind` cluster is fully initialized, the configuration is used to deploy the actual management cluster on the backend infrastructure. After the management cluster is fully configured, the local `kind` cluster is deleted and future configurations are performed with the Tanzu CLI. -For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For more information about how configuring a macOS or a Windows machine, see [Install the Tanzu CLI and Other Tools](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/install-cli.html). +For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For more information about how configuring a macOS or a Windows machine, see [Install the Tanzu CLI and Other Tools](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). The bootstrap machine must meet the following prerequisites: @@ -275,7 +275,7 @@ To install Tanzu CLI, Tanzu Plug-ins, and Kubectl utility on the bootstrap machi Login Succeeded ``` - > **Note** If your private registry uses a self-signed certificate, save the CA certificate of the registry in `/etc/docker/certs.d/registry.example.com/ca.crt` and add certificate verification process by following the instructions in [Adding Certificate Configuration for the Custom Registry](https://docs.vmware.com/en/VMware-Tanzu-CLI/0.90.0/tanzu-cli/index.html#registry-certificate). + > **Note** If your private registry uses a self-signed certificate, save the CA certificate of the registry in `/etc/docker/certs.d/registry.example.com/ca.crt` and add certificate verification process by following the instructions in [Adding Certificate Configuration for the Custom Registry](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-cli/1-5/cli/index.html#registry-certificate). 1. Upload the images to the private registry: @@ -475,7 +475,7 @@ Before you proceed with the management cluster creation, ensure that the base im For the management cluster, download either a Photon or Ubuntu based Kubernetes v1.26.5 OVA. - > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-byoi-index.html). + > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-byoi-index.html). For workload clusters, OVA can have any supported combination of OS and Kubernetes version, as packaged in a Tanzu Kubernetes release. @@ -497,9 +497,9 @@ For information about how to create the user and role for Tanzu Kubernetes Grid, ### Import NSX Advanced Load Balancer in Content Library -Create a content library following the instructions provided in [Create a Library](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-A58AF4FD-6CBE-4210-9E67-27EFBDCC1EF2.html) in VMware vSphere documentation. You will store the NSX Advanced Load Balancer OVA in the library. +Create a content library following the instructions provided in [Create a Library](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-virtual-machine-administration-guide-8-0/using-content-libraries/create-and-edit-a-content-library.html#GUID-A58AF4FD-6CBE-4210-9E67-27EFBDCC1EF2-en) in VMware vSphere documentation. You will store the NSX Advanced Load Balancer OVA in the library. -To import the OVA into the content library, see [Import Items to a Content Library](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-B413FBAE-8FCB-4598-A3C2-8B6DDA772D5C.html). +To import the OVA into the content library, see [Import Items to a Content Library](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-virtual-machine-administration-guide-8-0/using-content-libraries/how-to-populate-libraries-with-content.html#GUID-B413FBAE-8FCB-4598-A3C2-8B6DDA772D5C-en). ## Deploy and Configure NSX Advanced Load Balancer @@ -966,7 +966,7 @@ IDENTITY_MANAGEMENT_TYPE: "none" # LDAP_ROOT_CA_DATA_B64: ``` -For a full list of configurable values and to learn more about the fields present in the template file, see [Tanzu Configuration File Variable Reference](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-deploy-config-ref.html). +For a full list of configurable values and to learn more about the fields present in the template file, see [Tanzu Configuration File Variable Reference](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/config-ref.html). Create a file using the values provided in the template and save the file with a `.yaml` extension. For more information about a sample YAML file to use for deploying a management cluster, see [Appendix Section](#supplemental-information). @@ -1630,7 +1630,7 @@ You can see that the workload cluster is successfully deployed and the AKO pod i User-managed packages are installed after workload cluster creation. These packages extend the core functionality of Kubernetes clusters created by Tanzu Kubernetes Grid. Tanzu Kubernetes Grid includes the following user-managed packages. These packages provide in-cluster and shared services to the Kubernetes clusters that are running in your Tanzu Kubernetes Grid environment. For more information, see [Installing and Managing Packages with the Tanzu CLI -](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-index.html). +](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-packages-index.html). With TKG v2.3, the Tanzu Standard package repository is versioned and distributed separately from TKG, and its versioning is based on a date stamp. For TKG v2.3, the latest compatible Tanzu Standard repository version is v2023.7.13 diff --git a/src/deployment-guides/tko-aws.md b/src/deployment-guides/tko-aws.md index fcfbcfb0..05852d14 100644 --- a/src/deployment-guides/tko-aws.md +++ b/src/deployment-guides/tko-aws.md @@ -8,7 +8,7 @@ You can use VMware Service Installer for VMware Tanzu to automate this deploymen VMware Service Installer for Tanzu automates the deployment of the reference designs for Tanzu for Kubernetes Operations. It uses best practices for deploying and configuring the required Tanzu for Kubernetes Operations components. -To use Service Installer to automate this deployment, see [Deploying Tanzu for Kubernetes Operations on Non Air-gapped AWS VPC Using Service Installer for VMware Tanzu](https://docs.vmware.com/en/Service-Installer-for-VMware-Tanzu/1.3/service-installer/GUID-AWS%20-%20Non%20Airgap-AWSNonAirgap-DeploymentGuide.html). +To use Service Installer to automate this deployment, see [Deploying Tanzu for Kubernetes Operations on Non Air-gapped AWS VPC Using Service Installer for VMware Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/service-installer-for-vmware-tanzu/2-4-0/tnz-sivt/release-AWS-Non-Airgap-AWSNonAirgap-DeploymentGuide.html). Alternatively, if you decide to manually deploy each component, follow the steps provided in this document. @@ -27,7 +27,7 @@ See [Tanzu Kubernetes Grid resources in AWS account](https://docs.vmware.com/en/ * **Bootstrap Machine with AWS CLI Installed**: The bootstrap machine can be a local device such as a laptop, or a virtual machine running in, for example, VMware Workstation or Fusion. Install the AWS CLI on the bootstrap machine. You can get the AWS CLI through a package manager such as Homebrew, apt-get, or by downloading the CLI from [AWS CLI](https://aws.amazon.com/cli/). You will use the bootstrap machine to create the AWS VPC and jumpbox. -* **VMware Cloud**: Access to [VMware Cloud]( https://customerconnect.vmware.com/login ) to download Tanzu CLI. +* **VMware Cloud**: Access to [Broadcom Support](https://support.broadcom.com) to download Tanzu CLI. For additional information about preparing to deploy Tanzu Kubernetes Grid on AWS, see [Prepare to Deploy Management Clusters to Amazon EC2](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-aws.html). @@ -304,7 +304,7 @@ After doing the network configuration, complete the steps described in this sect - For more information about ytt cluster overlays, see [ytt Overlays](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-tanzu-k8s-clusters-config-plans.html). + For more information about ytt cluster overlays, see [ytt Overlays](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-clusters-ytt.html#examples). ## Prepare an External Identity Management Tanzu Kubernetes Grid implements user authentication with Pinniped. Pinniped allows you to plug external OpenID Connect (OIDC) or LDAP identity providers (IDP) into Tanzu Kubernetes clusters, so that you can control user access to those clusters. @@ -313,7 +313,7 @@ Pinniped is an open-source authentication service for Kubernetes clusters. If yo You enable identity management during management cluster deployment. Therefore, ensure that you have an IDP/LDAP server setup before you do the Tanzu Kubernetes Grid management cluster installation. -If you don't have identity management configured, see [Configure Identity Management](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-deploy-ui.html) for a sample IDP setup. Also see [Pinniped Docs](https://pinniped.dev/docs/) for information on Pinniped integration into Tanzu Kubernetes Grid with various OIDC providers and LDAPs. +If you don't have identity management configured, see [Configure Identity Management](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html) for a sample IDP setup. Also see [Pinniped Docs](https://pinniped.dev/docs/) for information on Pinniped integration into Tanzu Kubernetes Grid with various OIDC providers and LDAPs. ## Deploy a Tanzu Kubernetes Grid Management Cluster @@ -379,13 +379,13 @@ To deploy a management cluster from the Tanzu Kubernetes Grid installer interfac 8. For **Kubernetes Network**, enter the Network CNI settings and click **Next**. - Optionally, if you already have a proxy server set up and want to send outgoing HTTP(S) traffic from the management cluster to a proxy, toggle **Enable Proxy Settings**. For more information on how to configure proxy settings, see [Configure the Kubernetes Network and Proxies](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-deploy-ui.html#configure-the-kubernetes-network-and-proxies-15). + Optionally, if you already have a proxy server set up and want to send outgoing HTTP(S) traffic from the management cluster to a proxy, toggle **Enable Proxy Settings**. For more information on how to configure proxy settings, see [Configure the Kubernetes Network and Proxies](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-ui.html#network). ![CNI settings for Kubernetes cluster](./img/tko-aws/aws-ui-5.png) 9. For **Identity Management**, toggle **Enable Identity Management Settings** to configure your IDP and click **Next**. - For more information about configuring the identity management settings, see [Configure Identity Management](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-iam-configure-id-mgmt.html). + For more information about configuring the identity management settings, see [Configure Identity Management](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html). ![identity management settings](./img/tko-aws/aws-ui-6.png) @@ -394,7 +394,7 @@ To deploy a management cluster from the Tanzu Kubernetes Grid installer interfac 111. For **Register with Tanzu Mission Control**, you can follow these steps to register your Tanzu Kubernetes Grid Management cluster with Tanzu Mission Control and generate the Tanzu Mission Control url to enter into the url section. -* [Register a Management Cluster with Tanzu Mission Control](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-register_tmc.html) +* [Register a Management Cluster with Tanzu Mission Control](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-post-deploy.html#tmc) 12. For **CEIP Agreement**, select the check box to opt in to the VMware Customer Experience Improvement Program (CEIP), and click **Next**. @@ -416,7 +416,7 @@ Before creating a management cluster using the Tanzu CLI, define the base config > **Note** To avoid creating a public-facing load balancer you can set AWS_LOAD_BALANCER_SCHEME_INTERNAL to true in the cluster configuration file `AWS_LOAD_BALANCER_SCHEME_INTERNAL: true`. This setting customizes the management cluster’s load balancer to use an internal scheme, which means that its Kubernetes API server will not be accessible and routed over the Internet. -For **Register with Tanzu Mission Control**, you can [Register a Management Cluster with Tanzu Mission Control](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-register_tmc.html) to generate Tanzu Mission Control url and set into `TMC_REGISTRATION_URL: ` +For **Register with Tanzu Mission Control**, you can [Register a Management Cluster with Tanzu Mission Control](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-post-deploy.html#tmc) to generate Tanzu Mission Control url and set into `TMC_REGISTRATION_URL: ` To create a new Tanzu Kubernetes Grid management cluster, run the following command: @@ -489,7 +489,7 @@ If you had previously deployed a management cluster, the `~/.config/tanzu/tkg/cl To use the configuration file from a previous deployment, make a copy of the configuration file with a new name, open it in a text editor, and update the configuration. VMware recommends using a dedicated configuration file for each management cluster, with the configuration settings specific to a single infrastructure. -For more information about deploying a management cluster from a configuration file, see [Deploy Management Clusters from a Configuration File](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-deploy-cli.html). +For more information about deploying a management cluster from a configuration file, see [Deploy Management Clusters from a Configuration File](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-config-vsphere.html). ## Examine the Management Cluster Deployment @@ -529,17 +529,17 @@ For tips to help you to troubleshoot common problems that you might encounter wh ## Install and Configure Packages into Workload Clusters -A package in Tanzu Kubernetes Grid is a collection of related software that supports or extends the core functionality of the Kubernetes cluster in which the package is installed. Tanzu Kubernetes Grid includes two types of packages, auto-managed packages and CLI-managed packages. For more information about packages in Tanzu Kubernetes Grid, see [Install and Configure Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-index.html). +A package in Tanzu Kubernetes Grid is a collection of related software that supports or extends the core functionality of the Kubernetes cluster in which the package is installed. Tanzu Kubernetes Grid includes two types of packages, auto-managed packages and CLI-managed packages. For more information about packages in Tanzu Kubernetes Grid, see [Install and Configure Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-packages-index.html). ### Auto-Managed Packages -Tanzu Kubernetes Grid automatically installs the auto-managed packages during cluster creation. For more information about auto-managed packages, see [Auto-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-core-index.html). +Tanzu Kubernetes Grid automatically installs the auto-managed packages during cluster creation. For more information about auto-managed packages, see [Auto-Managed Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/about-tkg-packages-index.html#auto). ### CLI-Managed Packages A CLI-managed package is an optional component of a Kubernetes cluster that you can install and manage with the Tanzu CLI. These packages are installed after cluster creation. CLI-managed packages are grouped into package repositories in the Tanzu CLI. If a package repository that contains CLI-managed packages is available in the target cluster, you can use the Tanzu CLI to install and manage any of the packages from that repository. -Using the Tanzu CLI, you can install CLI-managed packages from the built-in `tanzu-standard` package repository or from package repositories that you add to your target cluster. From the `tanzu-standard` package repository, you can install the Cert Manager, Contour, External DNS, Fluent Bit, Grafana, Harbor, Multus CNI, and Prometheus packages. For more information about CLI-managed packages, see [CLI-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-user-managed-index.html). +Using the Tanzu CLI, you can install CLI-managed packages from the built-in `tanzu-standard` package repository or from package repositories that you add to your target cluster. From the `tanzu-standard` package repository, you can install the Cert Manager, Contour, External DNS, Fluent Bit, Grafana, Harbor, Multus CNI, and Prometheus packages. For more information about CLI-managed packages, see [CLI-Managed Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/about-tkg-packages-index.html#cli). The following provide more information on installing VMware recommended CLI-managed packages: @@ -557,7 +557,7 @@ The following provide more information on installing VMware recommended CLI-mana * [Deploy Harbor Registry as a Shared Service](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-harbor-registry.html) -If you want to deploy Harbor into a shared services cluster, create a shared services cluster if it is not already created. For instructions, see [Create a Shared Services Cluster](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-user-managed-index.html#shared). Also, make sure you add `INFRASTRUCTURE_PROVIDER: aws` +If you want to deploy Harbor into a shared services cluster, create a shared services cluster if it is not already created. For instructions, see [Create a Shared Services Cluster](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-clusters-deploy.html#shared). Also, make sure you add `INFRASTRUCTURE_PROVIDER: aws` into shared service workload cluster config file. ## Configure SaaS Services @@ -608,4 +608,4 @@ tanzu cluster delete ## Logs and Troubleshooting -For information about how to find the Tanzu Kubernetes Grid logs, how to troubleshoot frequently encountered Tanzu Kubernetes Grid issues, and how to use the Crash Recovery and Diagnostics tool, see [Logs and Troubleshooting](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-troubleshooting-tkg-index.html). \ No newline at end of file +For information about how to find the Tanzu Kubernetes Grid logs, how to troubleshoot frequently encountered Tanzu Kubernetes Grid issues, and how to use the Crash Recovery and Diagnostics tool, see [Logs and Troubleshooting](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-index.html). \ No newline at end of file From da88de906fdf137958416dd59168308fe4e2eca3 Mon Sep 17 00:00:00 2001 From: shanrajad23 Date: Thu, 7 Nov 2024 11:22:55 +0530 Subject: [PATCH 2/3] checking the second batch of doc changes Signed-off-by: shanrajad23 --- src/deployment-guides/tko-aws-airgap.md | 50 ++++++++----------- src/deployment-guides/tko-in-vmc-aws.md | 20 ++++---- src/deployment-guides/tko-on-azure.md | 28 +++++------ src/deployment-guides/tko-on-vsphere-nsxt.md | 36 ++++++------- .../tko-on-vsphere-with-tanzu.md | 43 ++++++++-------- src/deployment-guides/tko-on-vsphere.md | 38 +++++++------- src/deployment-guides/tko-saas-services.md | 2 +- 7 files changed, 105 insertions(+), 112 deletions(-) diff --git a/src/deployment-guides/tko-aws-airgap.md b/src/deployment-guides/tko-aws-airgap.md index c226ebb6..ac21c765 100644 --- a/src/deployment-guides/tko-aws-airgap.md +++ b/src/deployment-guides/tko-aws-airgap.md @@ -8,7 +8,7 @@ You can use VMware Service Installer for VMware Tanzu to automate this deploymen VMware Service Installer for Tanzu automates the deployment of the reference designs for Tanzu for Kubernetes Operations. It uses best practices for deploying and configuring the required Tanzu for Kubernetes Operations components. -To use Service Installer to automate this deployment, see [Deploying Tanzu Kubernetes Grid on Federal Air-gapped AWS VPC Using Service Installer for VMware Tanzu](https://docs.vmware.com/en/Service-Installer-for-VMware-Tanzu/2.1/service-installer/GUID-AWS%20-%20Federal%20Airgap-AWSFederalAirgap-DeploymentGuide.html). +To use Service Installer to automate this deployment, see [Deploying Tanzu Kubernetes Grid on Federal Air-gapped AWS VPC Using Service Installer for VMware Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/service-installer-for-vmware-tanzu/2-4-0/tnz-sivt/release-AWS-Federal-Airgap-AWSFederalAirgap-DeploymentGuide.html). Alternatively, if you decide to manually deploy each component, follow the steps provided in this document. @@ -18,24 +18,20 @@ Before deploying VMware Tanzu for Kubernetes Operations in an AWS air-gapped env * **AWS Account**: An IAM user account with **administrative privileges**. * **AWS Resource Quotas**: Sufficient quotas to support both the management cluster and the workload clusters in your deployment. Otherwise, the cluster deployments will fail. Depending on the number of workload clusters you plan to deploy, you may need to increase the AWS services quotas from their default values. You will need to increase the quota in every region in which you deploy Tanzu Kubernetes Grid. - For more information, follow these links: - - * [Tanzu Kubernetes Grid resources in AWS account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-prep-aws.html#aws-resources). + * [AWS service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) in the AWS. * **An Internet-connected Linux bootstrap machine** The bootstrap machine can be a local device such as a laptop or a virtual machine running in, for example, VMware Workstation or Fusion. You will use the bootstrap machine to create the AWS VPC and jumpbox. The bootstrap machine: * Is not inside the Internet-restricted environment or is able to access the domains listed in Proxy Server Allowlist. * Has the Docker client app installed. - * Has [imgpkg](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/install-cli.html) installed. + * Has [imgpkg](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html) installed. * Has the latest version of yq installed. * Has the latest version of jq installed. * Has AWS CLI installed. - * Has the [Carvel Tools](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/install-cli.html) installed, if you intend to install one or more of the optional packages provided by Tanzu Kubernetes Grid, such as Harbor. + * Has the [Carvel Tools](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html) installed, if you intend to install one or more of the optional packages provided by Tanzu Kubernetes Grid, such as Harbor. * **VMware Cloud**: Access to [VMware Cloud](https://customerconnect.vmware.com/login) to download Tanzu CLI. -For additional information about preparing to deploy Tanzu Kubernetes Grid on AWS, see [Prepare to Deploy Management Clusters to Amazon EC2](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-prep-aws.html). - ## Overview of the Deployment Steps The main steps to deploy Tanzu for Kubernetes Operations on AWS EC2 are as follows. Each step links to more detailed instructions. @@ -231,13 +227,13 @@ Copy the container images required to deploy Tanzu Kubernetes Grid on AWS to a p * Copy the images from the Tanzu Kubernetes Grid public registry and save them locally in tar format on an offline jumpbox. * Extract the images from the tar files and copy them to a private registry. -See [Copy the container images required to deploy Tanzu Kubernetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-prep-offline.html) for more detailed instructions. +See [Copy the container images required to deploy Tanzu Kubernetes Grid](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-offline.html) for more detailed instructions. ### Tanzu Kubernetes Grid Build Machine Image -If you have a requirement to build custom images, follow the steps in [Tanzu Kubernetes Grid Build Machine Images](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-byoi-index.html). +If you have a requirement to build custom images, follow the steps in [Tanzu Kubernetes Grid Build Machine Images](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-byoi-index.html). -For compliance and security requirements VMware has published security overview whitepaper. Refer to [Tanzu Kubernetes Grid security overview whitepaper](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-security-overview.html) for more information. +For compliance and security requirements VMware has published security overview whitepaper. Refer to [Tanzu Kubernetes Grid security overview whitepaper](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-security-overview.html) for more information. ## Prepare an Internet-Restricted Environment @@ -247,7 +243,7 @@ Set the IP address or FQDN of your local private registry as an environment vari `export TKG_CUSTOM_IMAGE_REPOSITORY="PRIVATE-REGISTRY"` Where PRIVATE-REGISTRY is the IP address or FQDN of your private registry and the name of the project. For example, `custom-image-repository.io/yourproject`. -Follow the instructions in [Prepare an Internet-Restricted Environment](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-prep-offline.html). +Follow the instructions in [Prepare an Internet-Restricted Environment](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-offline.html). ## Deploy a Tanzu Kubernetes Grid Management Cluster @@ -274,7 +270,7 @@ For more information about deploying a management cluster from a configuration f When the management cluster is deployed, either from the installer interface or from a configuration file using Tanzu CLI, Tanzu Kubernetes Grid uses a Kubernetes in Docker kind cluster on the jumpbox to create a temporary management cluster. kind is a tool for running Kubernetes clusters locally using Docker containers as Kubernetes nodes. -Tanzu Kubernetes Grid uses the temporary management cluster to provision the final management cluster on AWS. For information about how to examine and verify your Tanzu Kubernetes Grid management cluster deployment, see [Examine the Management Cluster Deployment](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-deploy-file.html). +Tanzu Kubernetes Grid uses the temporary management cluster to provision the final management cluster on AWS. For information about how to examine and verify your Tanzu Kubernetes Grid management cluster deployment, see [Examine the Management Cluster Deployment](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-post-deploy.html). ## Deploy Workload Clusters @@ -296,41 +292,41 @@ tanzu cluster create --plan=prod --worker-machine-count 3 --d After the workload cluster is created, the current context changes to the new workload cluster. -For more information on cluster lifecycle and management, see [Manage Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-index.html). +For more information on cluster lifecycle and management, see [Manage Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-index.html). ### Troubleshooting Tips for Tanzu Kubernetes Grid -For tips to help you to troubleshoot common problems that you might encounter when installing Tanzu Kubernetes Grid and deploying Tanzu Kubernetes clusters, see [Troubleshooting Tips for Tanzu Kubernetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-troubleshoot-mgmt-clusters.html). +For tips to help you to troubleshoot common problems that you might encounter when installing Tanzu Kubernetes Grid and deploying Tanzu Kubernetes clusters, see [Troubleshooting Tips for Tanzu Kubernetes Grid](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-mgmt-clusters.html). ## Install and Configure Packages into Workload Clusters -A package in Tanzu Kubernetes Grid is a collection of related software that supports or extends the core functionality of the Kubernetes cluster in which the package is installed. Tanzu Kubernetes Grid includes two types of packages, auto-managed packages and CLI-managed packages. For more information about packages in Tanzu Kubernetes Grid, see [Install and Configure Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-index.html). +A package in Tanzu Kubernetes Grid is a collection of related software that supports or extends the core functionality of the Kubernetes cluster in which the package is installed. Tanzu Kubernetes Grid includes two types of packages, auto-managed packages and CLI-managed packages. For more information about packages in Tanzu Kubernetes Grid, see [Install and Configure Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-packages-index.html). ### Auto-Managed Packages -Tanzu Kubernetes Grid automatically installs the auto-managed packages during cluster creation. For more information about auto-managed packages, see [Auto-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2/about-tkg/packages-index.html#auto). +Tanzu Kubernetes Grid automatically installs the auto-managed packages during cluster creation. For more information about auto-managed packages, see [Auto-Managed Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/about-tkg-packages-index.html#auto). ### CLI-Managed Packages A CLI-managed packages package is an optional component of a Kubernetes cluster that you can install and manage with the Tanzu CLI. These packages are installed after cluster creation. CLI-managed packages are grouped into package repositories in the Tanzu CLI. If a package repository that contains CLI-managed packages is available in the target cluster, you can use the Tanzu CLI to install and manage any of the packages from that repository. -Using the Tanzu CLI, you can install cli-managed packages from the built-in `tanzu-standard` package repository or from package repositories that you add to your target cluster. From the `tanzu-standard` package repository, you can install the Cert Manager, Contour, Fluent Bit, Grafana, Harbor, and Prometheus packages. See [CLI-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-ref.html) for more information. +Using the Tanzu CLI, you can install cli-managed packages from the built-in `tanzu-standard` package repository or from package repositories that you add to your target cluster. From the `tanzu-standard` package repository, you can install the Cert Manager, Contour, Fluent Bit, Grafana, Harbor, and Prometheus packages. See [CLI-Managed Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/about-tkg-packages-index.html#cli) for more information. **Recommended packages:** -* **Cert Manager** for automating the management and issuance of TLS certificates. See [Installing Cert Manager](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-cert-mgr.html). +* **Cert Manager** for automating the management and issuance of TLS certificates. See [Installing Cert Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-cert-mgr.html). -* **Contour** for ingress control. See [Implementing Ingress Control with Contour](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-contour.html). +* **Contour** for ingress control. See [Implementing Ingress Control with Contour](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-contour.html). For use a private load balancer, set `service.beta.kubernetes.io/aws-load-balancer-internal: "true"` in the annotations for the service. This setting also applies to the Contour ingress and controls. -* **Fluent Bit** for log processing and forwarding. See [Implementing Log Forwarding with Fluent Bit](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-fluentbit.html) +* **Fluent Bit** for log processing and forwarding. See [Implementing Log Forwarding with Fluent Bit](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-fluentbit.html) -* **Prometheus** and **Grafana** for monitoring. See [Implementing Monitoring with Prometheus and Grafana](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-monitoring.html) +* **Prometheus** and **Grafana** for monitoring. See [Implementing Monitoring with Prometheus and Grafana](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html) -* **Multus** for multi networking. [Implementing Multiple Pod Network Interfaces with Multus](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-multus.html) +* **Multus** for multi networking. [Implementing Multiple Pod Network Interfaces with Multus](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-cni.html) ## Logs and Troubleshooting -For information about how to find the Tanzu Kubernetes Grid logs, how to troubleshoot frequently encountered Tanzu Kubernetes Grid issues, and how to use the Crash Recovery and Diagnostics tool, see [Logs and Troubleshooting](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-troubleshoot-index.html). +For information about how to find the Tanzu Kubernetes Grid logs, how to troubleshoot frequently encountered Tanzu Kubernetes Grid issues, and how to use the Crash Recovery and Diagnostics tool, see [Logs and Troubleshooting](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-index.html). ## Delete Clusters @@ -362,11 +358,7 @@ Run the following command to delete the management cluster and related objects: tanzu cluster delete ``` -## Air-Gapped STIG/FIPS Deployment on AWS - -For how to deploy a STIG-hardened management/FIPS cluster to an air-gapped AWS environment, see [Deploy a STIG-Hardened Management Cluster to an Air-gapped AWS VPC](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.4/vmware-tanzu-kubernetes-grid-14/GUID-security-airgap-stig-aws.html). - ## Tanzu Kubernetes Grid Upgrade -For information about how to upgrade to Tanzu Kubernetes Grid 2.1, see [Tanzu Kubernetes Grid Upgrade](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-upgrade-index.html). +For information about how to upgrade to Tanzu Kubernetes Grid 2.1, see [Tanzu Kubernetes Grid Upgrade](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-upgrade-index.html).   diff --git a/src/deployment-guides/tko-in-vmc-aws.md b/src/deployment-guides/tko-in-vmc-aws.md index bba09c53..e339e7ae 100644 --- a/src/deployment-guides/tko-in-vmc-aws.md +++ b/src/deployment-guides/tko-in-vmc-aws.md @@ -10,7 +10,7 @@ You can use VMware Service Installer for VMware Tanzu to automate this deploymen VMware Service Installer for Tanzu automates the deployment of the reference designs for Tanzu for Kubernetes Operations. It uses best practices for deploying and configuring the required Tanzu for Kubernetes Operations components. -To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on VMware Cloud on AWS Using Service Installer for VMware Tanzu](https://docs.vmware.com/en/Service-Installer-for-VMware-Tanzu/2.1/service-installer/GUID-index.html). +To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on VMware Cloud on AWS Using Service Installer for VMware Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/service-installer-for-vmware-tanzu/2-4-0/tnz-sivt/release-VMware-Cloud-on-AWS-VMC-TKOonVMConAWS.html). Alternatively, if you decide to manually deploy each component, follow the steps provided in this document. @@ -58,7 +58,7 @@ Your environment should meet the following general requirements: * Tanzu CLI 2.1.x * kubectl cluster CLI 1.24.9 -* A vSphere account with the permissions described in [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-prep-vsphere.html). +* A vSphere account with the permissions described in [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). * Download and import NSX Advanced Load Balancer 22.1.2 OVA to Content Library. * Download the following OVA from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x) and import to vCenter. Convert the imported VMs to templates. @@ -533,7 +533,7 @@ The deployment of the Tanzu Kubernetes Grid management and workload clusters is The bootstrap machine runs a local `kind` cluster when Tanzu Kubernetes Grid management cluster deployment is started. Once the `kind` cluster is fully initialized, the configuration is used to deploy the actual management cluster on the backend infrastructure. After the management cluster is fully configured, the local `kind` cluster is deleted and future configurations are performed with the Tanzu CLI. -For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For information on how to configure for a macOS or Windows machine, see [Install the Tanzu CLI and Other Tools](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/install-cli.html). +For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For information on how to configure for a macOS or Windows machine, see [Install the Tanzu CLI and Other Tools](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). The bootstrap machine must meet the following prerequisites: @@ -703,7 +703,7 @@ Before you proceed with the management cluster creation, ensure that the base im * For the management cluster, this must be either Photon or Ubuntu based Kubernetes v1.24.9 OVA. - > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-byoi-index.html). + > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-byoi-index.html). * For workload clusters, OVA can have any supported combination of OS and Kubernetes version, as packaged in a Tanzu Kubernetes release. > **Note** Make sure you download the most recent OVA base image templates in the event of security patch releases. You can find updated base image templates that include security patches on the Tanzu Kubernetes Grid product download page. @@ -720,7 +720,7 @@ Before you proceed with the management cluster creation, ensure that the base im 1. **If using non administrator SSO account**: In the VMs and Templates view, right-click the new template, select **Add Permission**, and assign the **tkg-user** to the template with the **TKG role**. -For information about how to create the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-prep-vsphere.html). +For information about how to create the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). ## Deploy Tanzu Kubernetes Grid Management Cluster @@ -768,7 +768,7 @@ The Tanzu Kubernetes Grid installer wizard is an easy way to deploy the cluster. - **Control Plane Endpoint:** This is an optional field. If left blank, NSX Advanced Load Balancer assigns an IP address from the pool `sfo01-w01-vds01-tkgclustervip` which is configured in NSX Advanced Load Balancer. If you need to provide an IP address, pick an unused IP address from the `sfo01-w01-vds01-tkgclustervip` static IP pool. - **Deployment Type:** Development (recommended for Dev or POC environments)/ Production (recommended for Production environments). - **Machine Health Checks:** Enable - - **Enable Audit Logging:** Enables audit logging for Kubernetes API server and node VMs, choose as per environmental needs. For more information, see [Audit Logging](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-security-audit-log.html). + - **Enable Audit Logging:** Enables audit logging for Kubernetes API server and node VMs, choose as per environmental needs. For more information, see [Audit Logging](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-audit-logging.html). ![Management Cluster Settings](img/tko-in-vmc-aws/deploy-tko-vmc-49.jpg) @@ -803,7 +803,7 @@ The Tanzu Kubernetes Grid installer wizard is an easy way to deploy the cluster. ![Cluster labels](img/tko-in-vmc-aws/deploy-tko-vmc-51.jpg) - > **Note** With the above configuration, all the Tanzu workload clusters use `sfo01-w01-vds01-tkgclustervip` for control plane VIP network and `sfo01-w01-vds01-tkgclustervip` for data plane network by default. If you would like to configure separate VIP networks for workload control plane or data networks, create a custom AKO Deployment Config (ADC) and provide the respective `NSXALB_LABELS` in the workload cluster configuration file. For more information on network separation and custom ADC creation, see [Configure Separate VIP Networks and Service Engine Groups in Different Workload Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-reqs-network-nsx-alb-cp-endpoint.html). + > **Note** With the above configuration, all the Tanzu workload clusters use `sfo01-w01-vds01-tkgclustervip` for control plane VIP network and `sfo01-w01-vds01-tkgclustervip` for data plane network by default. If you would like to configure separate VIP networks for workload control plane or data networks, create a custom AKO Deployment Config (ADC) and provide the respective `NSXALB_LABELS` in the workload cluster configuration file. For more information on network separation and custom ADC creation, see [Configure Separate VIP Networks and Service Engine Groups in Different Workload Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-network-nsx-alb-cp-endpoint.html). 11. On the **Metadata** page, you can specify location and labels. @@ -819,7 +819,7 @@ The Tanzu Kubernetes Grid installer wizard is an easy way to deploy the cluster. ![Kubernetes Network](img/tko-in-vmc-aws/deploy-tko-vmc-54.jpg) -14. If LDAP is configured in your environment, see [Configure Identity Management](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-iam-configure-id-mgmt.html) for instructions on how to integrate an identity management system with Tanzu Kubernetes Grid. +14. If LDAP is configured in your environment, see [Configure Identity Management](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html) for instructions on how to integrate an identity management system with Tanzu Kubernetes Grid. In this example, identity management integration is deactivated. @@ -867,7 +867,7 @@ The Tanzu Kubernetes Grid installer wizard is an easy way to deploy the cluster. ![Cluster status report](img/tko-in-vmc-aws/deploy-tko-vmc-61.jpg) - See [Examine the Management Cluster Deployment](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/tkg-deploy-mc-21/mgmt-deploy-post-deploy.html) to perform additional health checks. + See [Examine the Management Cluster Deployment](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-post-deploy.html) to perform additional health checks. 21. When deployment is completed successfully, run the following command to install the additional Tanzu plugins: @@ -1158,7 +1158,7 @@ The procedure for deploying a shared service cluster is essentially the same as Shared services cluster use the custom ADC tanzu-ako-for-shared created earlier to apply the network settings similar to management cluster. This is enforced by applying the NSXALB_LABEL `type:shared` while deploying the shared services cluster.

-> **Note** The scope of this document doesn't cover the use of a proxy for Tanzu Kubernetes Grid deployment. If your environment uses a proxy server to connect to the internet, ensure that the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Management Cluster in the **No proxy list**, as described in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). +> **Note** The scope of this document doesn't cover the use of a proxy for Tanzu Kubernetes Grid deployment. If your environment uses a proxy server to connect to the internet, ensure that the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Management Cluster in the **No proxy list**, as described in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). 1. To deploy a shared services cluster, navigate to the **Clusters** tab and click **Create Cluster**. diff --git a/src/deployment-guides/tko-on-azure.md b/src/deployment-guides/tko-on-azure.md index b1e18c7c..82019ac2 100644 --- a/src/deployment-guides/tko-on-azure.md +++ b/src/deployment-guides/tko-on-azure.md @@ -26,7 +26,7 @@ Ensure that you have: - Contributor role in Microsoft Azure. - Resource group in Microsoft Azure. - An SSH key and the Base 64 encoded value of the public key. You will configure the Base 64 encoded value for the AZURE_SSH_PUBLIC_KEY_B64 parameter of the configuration file for deploying Tanzu Kubernetes Grid. How you generate the SSH key and how you encode the entire public key is up to you. However, you will need to encode the public key before storing it in the Tanzu Kubernetes Grid deployment configuration file. -* Access to Customer Connect and the available downloads for Tanzu Kubernetes Grid. To verify that you have access, go to [VMware Tanzu Kubernetes Grid Download Product](https://customerconnect.vmware.com/en/downloads/details?downloadGroup=TKG-154&productId=988&rPId=73652). +* Access to Broadcom Support and the available downloads for Tanzu Kubernetes Grid. To verify that you have access, go to [VMware Tanzu Kubernetes Grid Download Product](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid). ## Overview of the Deployment steps 1. [Set up your Microsoft Azure environment](#azure-environment) @@ -197,8 +197,8 @@ You will use the bootstrap VM to deploy the Tanzu Kubernetes Grid management and You will set up the bootstrap VM with the following: -- Authentication and access to VMware Customer Connect
- You will download the required Tanzu components from VMware Customer Connect. +- Authentication and access to Broadcom Support
+ You will download the required Tanzu components from the Broadcom Support portal. - Azure Tenant, subscription, and client IDs
The IDs are for the Azure subscription on which you created resources using the ARM template. - Docker @@ -211,7 +211,7 @@ To set up the bootstrap VM: 1. Verify that the VM is up and running. 1. Connect to the VM through a standard SSH connection. 1. Run the following Shell commands to set up the bootstrap VM. - Replace the variables with the VMware account information needed to access VMware Customer Connect and Azure IDs for the Azure subscription on which you created resources using the ARM template and Application Registration/Service Principal. + Replace the variables with the VMware account information needed to access Broadcom Support and Azure IDs for the Azure subscription on which you created resources using the ARM template and Application Registration/Service Principal. ```bash # Variables @@ -308,7 +308,7 @@ You will use Tanzu CLI to deploy a management cluster and workload cluster. tanzu cluster create –file config.yaml -v 0-9 ``` -For additional product documentation on how to create the YAML configuration file and what each value corresponds to in Azure, see [Management Cluster Configuration for Microsoft Azure](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.4/vmware-tanzu-kubernetes-grid-14/GUID-mgmt-clusters-config-azure.html). +Tanzu Kubernetes Grid v2.5.x does not support the creation of standalone TKG management clusters and TKG workload clusters on AWS and Azure. Use Tanzu Mission Control to create native AWS EKS and Azure AKS clusters on AWS and Azure. For information about how to create native AWS EKS and Azure AKS clusters with Tanzu Mission Control, see [Managing the Lifecycle of AWS EKS Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-98D0A4F8-508A-4D75-94E2-C1A646276F16.html) and [Managing the Lifecycle of Azure AKS Clusters in the Tanzu Mission Control](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-2CA6A21A-1D33-4852-B8F2-86BB3A1337E4.html) documentation. ## Configure SaaS Services The following VMware SaaS services provide additional Kubernetes lifecycle management, observability, and service mesh features. @@ -328,28 +328,28 @@ Tanzu Kubernetes Grid includes two types of packages, auto-managed packages and ### Auto-Managed Packages -Tanzu Kubernetes Grid automatically installs the auto-managed packages during cluster creation. For more information about auto-managed packages, see [Auto-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-core-index.html). +Tanzu Kubernetes Grid automatically installs the auto-managed packages during cluster creation. For more information about auto-managed packages, see [Auto-Managed Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/about-tkg-packages-index.html#auto). ### CLI-Managed Packages A CLI-managed package is an optional component of a Kubernetes cluster that you can install and manage with the Tanzu CLI. These packages are installed after cluster creation. CLI-managed packages are grouped into package repositories in the Tanzu CLI. If a package repository that contains CLI-managed packages is available in the target cluster, you can use the Tanzu CLI to install and manage any of the packages from that repository. -Using the Tanzu CLI, you can install CLI-managed packages from the built-in `tanzu-standard` package repository or from package repositories that you add to your target cluster. From the `tanzu-standard` package repository, you can install the Cert Manager, Contour, External DNS, Fluent Bit, Grafana, Harbor, Multus CNI, and Prometheus packages. For more information about CLI-managed packages, see [CLI-Managed Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-user-managed-index.html). +Using the Tanzu CLI, you can install CLI-managed packages from the built-in `tanzu-standard` package repository or from package repositories that you add to your target cluster. From the `tanzu-standard` package repository, you can install the Cert Manager, Contour, External DNS, Fluent Bit, Grafana, Harbor, Multus CNI, and Prometheus packages. For more information about CLI-managed packages, see [CLI-Managed Packages](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/about-tkg-packages-index.html#cli). The following provide more information on installing VMware recommended CLI-managed packages: -* [Install Cert Manager](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-cert-manager.html) +* [Install Cert Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-cert-mgr.html) -* [Implement Ingress Control with Contour](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-ingress-contour.html) +* [Implement Ingress Control with Contour](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-contour.html) -* [Implement Log Forwarding with Fluent Bit](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-logging-fluentbit.html) +* [Implement Log Forwarding with Fluent Bit](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-fluentbit.html) -* [Implement Monitoring with Prometheus and Grafana](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-monitoring.html) +* [Implement Monitoring with Prometheus and Grafana](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html) -* [Implement Multiple Pod Network Interfaces with Multus](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-cni-multus.html) +* [Implement Multiple Pod Network Interfaces with Multus](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-cni.html) -* [Implement Service Discovery with ExternalDNS](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-external-dns.html) +* [Implement Service Discovery with ExternalDNS](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-externaldns.html) -* [Deploy Harbor Registry as a Shared Service](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-harbor-registry.html) +* [Deploy Harbor Registry as a Shared Service](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor-mc.html) If your deployment requires Harbor to take on a heavy load and store large images in the registry, you can install Harbor into a separate workload cluster. diff --git a/src/deployment-guides/tko-on-vsphere-nsxt.md b/src/deployment-guides/tko-on-vsphere-nsxt.md index 13680331..f813e15d 100644 --- a/src/deployment-guides/tko-on-vsphere-nsxt.md +++ b/src/deployment-guides/tko-on-vsphere-nsxt.md @@ -10,7 +10,7 @@ You can use VMware Service Installer for VMware Tanzu to automate this deploymen VMware Service Installer for Tanzu automates the deployment of the reference designs for Tanzu for Kubernetes Operations. It uses best practices for deploying and configuring the required Tanzu for Kubernetes Operations components. -To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on vSphere with NSX-T Using Service Installer for VMware Tanzu](https://docs.vmware.com/en/Service-Installer-for-VMware-Tanzu/2.3.0/service-installer/GUID-index.html). +To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on vSphere with NSX-T Using Service Installer for VMware Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/service-installer-for-vmware-tanzu/2-4-0/tnz-sivt/release-vSphere-Backed-by-NSX-T-tkoVsphereNSXT.html). Alternatively, if you decide to manually deploy each component, follow the steps provided in this document. @@ -41,7 +41,7 @@ Before deploying Tanzu for Kubernetes Operations on vSphere, ensure that your en - A vCenter with NSX backed environment. - Ensure to complete the following NSX configurations: - > **Note** The following provides only a high-level overview of the required NSX configuration. For more information, see [NSX Data Center Installation Guide](https://docs.vmware.com/en/VMware-NSX/4.1/installation/GUID-3E0C4CEC-D593-4395-84C4-150CD6285963.html) and [NSX Data Center Product Documentation](https://docs.vmware.com/en/VMware-NSX/index.html). + > **Note** The following provides only a high-level overview of the required NSX configuration. For more information, see [NSX Data Center Installation Guide](https://techdocs.broadcom.com/us/en/vmware-cis/nsx/vmware-nsx/4-2/installation-guide/nsx-transformers-installation-guide.html) and [NSX Data Center Product Documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx.html). - NSX manager instance is deployed and configured with Advanced or higher license. - vCenter Server that is associated with the NSX Data Center is configured as Compute Manager. @@ -61,16 +61,16 @@ Before deploying Tanzu for Kubernetes Operations on vSphere, ensure that your en - A datastore with sufficient capacity for the control plane and worker node VM files. - Network time protocol (NTP) service is running on all hosts and vCenter. - A host, server, or VM based on Linux, macOS, or Windows which acts as your bootstrap machine which has docker installed. For this deployment, a virtual machine based on Photon OS will be used. - - Depending on the OS flavor of the bootstrap VM, download and configure the following packages from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). To configure required packages on the Cent OS machine, see [Deploy and Configure Bootstrap Machine](#configurebootstrap)." + - Depending on the OS flavor of the bootstrap VM, download and configure the following packages from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid). To configure required packages on the Cent OS machine, see [Deploy and Configure Bootstrap Machine](#configurebootstrap)." - Tanzu CLI 2.3.0 - Kubectl cluster CLI 1.26.5 - - A vSphere account with permissions as described in [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). + - A vSphere account with permissions as described in [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). - Download and import NSX Advanced Load Balancer 22.1.3 OVA to Content Library. - - Download the following OVA files from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x) and import to vCenter. Convert the imported VMs to templates." + - Download the following OVA files from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid) and import to vCenter. Convert the imported VMs to templates." - Photon v3 Kubernetes v1.26.5 OVA and/or - Ubuntu 2004 Kubernetes v1.26.5 OVA -> **Note** You can also download supported older versions of Kubernetes from [VMware Customer Connect](https://customerconnect.vmware.com/en/downloads/details?downloadGroup=TKG-160&productId=988&rPId=93384) and import them to deploy workload clusters on the intended Kubernetes versions.

+> **Note** You can also download supported older versions of Kubernetes from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid) and import them to deploy workload clusters on the intended Kubernetes versions.

> **Note** In Tanzu Kubernetes Grid nodes, it is recommended to not use hostnames with ".local" domain suffix. For more information, see [KB article](https://kb.vmware.com/s/article/83623). **Resource Pools and VM Folders:** @@ -121,7 +121,7 @@ The steps for deploying Tanzu for Kubernetes Operations on vSphere backed by NSX ## Configure T1 Gateway and Logical Segments in NSX-T Data Center -As a prerequisite, an NSX backed vSphere environment must be configured with at least one tier-0 gateway. A tier-0 gateway performs the functions of a tier-0 logical router. It processes traffic between the logical and physical networks. For more information about creating and configuring a tier-0 gateway, see [NSX documentation](https://docs.vmware.com/en/VMware-NSX/4.1/administration/GUID-E9E62E02-C226-457D-B3A6-FE71E45628F7.html). +As a prerequisite, an NSX backed vSphere environment must be configured with at least one tier-0 gateway. A tier-0 gateway performs the functions of a tier-0 logical router. It processes traffic between the logical and physical networks. For more information about creating and configuring a tier-0 gateway, see [NSX documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx/vmware-nsx/4-2/administration-guide/tier-0-gateways.html). This procedure comprises the following tasks: @@ -130,7 +130,7 @@ This procedure comprises the following tasks: ### Add a Tier-1 Gateway -The tier-1 logical router must be connected to the tier-0 logical router to get the northbound physical router access. The following procedure provides the minimum required configuration to create a tier-1 gateway, which is adequate to successfully deploy the Tanzu for Kubernetes Operations stack. For a more advanced configuration, see [NSX documentation](https://docs.vmware.com/en/VMware-NSX/index.html). +The tier-1 logical router must be connected to the tier-0 logical router to get the northbound physical router access. The following procedure provides the minimum required configuration to create a tier-1 gateway, which is adequate to successfully deploy the Tanzu for Kubernetes Operations stack. For a more advanced configuration, see [NSX documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx.html). 1. With admin privileges, log in to NSX Manager. 1. Select **Networking** > **Tier-1 Gateways**. @@ -221,7 +221,7 @@ Repeat steps 1-7 to create all other required overlay-backed segments. Once comp ![List of created segments](img/tko-on-vsphere-nsxt/T1-gateway-07.png) -Additionally, you can create the required inventory groups and firewall rules. For more information, see [NSX Data Center Product Documentation](https://docs.vmware.com/en/VMware-NSX/index.html). +Additionally, you can create the required inventory groups and firewall rules. For more information, see [NSX Data Center Product Documentation](https://techdocs.broadcom.com/us/en/vmware-cis/nsx.html). ## Deploy and Configure NSX Advanced Load Balancer @@ -586,7 +586,7 @@ The deployment of the Tanzu Kubernetes Grid management and workload clusters is The bootstrap machine runs a local `kind` cluster when Tanzu Kubernetes Grid management cluster deployment is started. Once the `kind` cluster is fully initialized, the configuration is used to deploy the actual management cluster on the backend infrastructure. After the management cluster is fully configured, the local `kind` cluster is deleted and future configurations are performed with the Tanzu CLI. -For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For more information about configuring for a macOS or Windows machine, see [Install the Tanzu CLI and Other Tools](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/install-cli.html). +For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For more information about configuring for a macOS or Windows machine, see [Install the Tanzu CLI and Other Tools](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). The bootstrap machine must meet the following prerequisites: @@ -763,7 +763,7 @@ Before you proceed with the management cluster creation, ensure that the base im * For the management cluster, this must be either Photon or Ubuntu based Kubernetes v1.24.9 OVA. - > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-byoi-index.html). + > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-byoi-index.html). * For workload clusters, OVA can have any supported combination of OS and Kubernetes version, as packaged in a Tanzu Kubernetes release. > **Note** Make sure you download the most recent OVA base image templates in the event of security patch releases. You can find updated base image templates that include security patches on the Tanzu Kubernetes Grid product download page. @@ -780,7 +780,7 @@ Before you proceed with the management cluster creation, ensure that the base im 1. **If using non administrator SSO account**: In the VMs and Templates view, right-click the new template, select **Add Permission**, and assign the **tkg-user** to the template with the **TKG role**. -For more information about creating the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). +For more information about creating the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). ## Deploy Tanzu Kubernetes Grid Management Cluster @@ -839,7 +839,7 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G * Control Plane Endpoint: This is an optional field. If left blank, NSX Advanced Load Balancer will assign an IP address from the pool defined for the network "sfo01-w01-vds01-tkgclustervip". If you need to provide an IP address, pick an IP address from “sfo01-w01-vds01-tkgclustervip”  static IP pools configured in AVI and ensure that the IP address is unused. * Machine Health Checks: Enable - * Enable Audit Logging: Enable for audit logging for Kubernetes API server and node VMs. Choose as per your environment needs. For more information, see [Audit Logging](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-troubleshoot-audit-logging.html). + * Enable Audit Logging: Enable for audit logging for Kubernetes API server and node VMs. Choose as per your environment needs. For more information, see [Audit Logging](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-audit-logging.html). ![Management cluster settings](img/tko-on-vsphere-nsxt/tkg-installer-05.png) @@ -866,7 +866,7 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G ![NSX ALB settings for management cluster - verify credentials](img/tko-on-vsphere-nsxt/tkg-installer-07.png) - > **Note** With the above configuration, all the Tanzu workload clusters use `sfo01-w01-vds01-tkgclustervip` for control plane VIP network and `sfo01-w01-vds01-tkgworkloadvip` for data plane network by default. If you would like to configure separate VIP networks for workload control plane/data networks, create a custom AKO Deployment Config (ADC) and provide the respective NSX `ALB_LABELS` in the workload cluster config file. For more information on network separation and custom ADC creation, see [Configure Separate VIP Networks and Service Engine Groups in Different Workload Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-network-nsx-alb-cp-endpoint.html). + > **Note** With the above configuration, all the Tanzu workload clusters use `sfo01-w01-vds01-tkgclustervip` for control plane VIP network and `sfo01-w01-vds01-tkgworkloadvip` for data plane network by default. If you would like to configure separate VIP networks for workload control plane/data networks, create a custom AKO Deployment Config (ADC) and provide the respective NSX `ALB_LABELS` in the workload cluster config file. For more information on network separation and custom ADC creation, see [Configure Separate VIP Networks and Service Engine Groups in Different Workload Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-network-nsx-alb-cp-endpoint.html).                  1. (Optional) On the Metadata page, you can specify location and labels and click **Next**. @@ -891,13 +891,13 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G 1. (Optional) Specify identity management with OIDC or LDAP. For the purpose of this document, identity management integration is deactivated. - If you would like to enable identity management, see **Enable and Configure Identity Management During Management Cluster Deployment** section in the [Tanzu Kubernetes Grid Integration with Pinniped Deployment Guide](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-iam-configure-id-mgmt.html). + If you would like to enable identity management, see **Enable and Configure Identity Management During Management Cluster Deployment** section in the [Tanzu Kubernetes Grid Integration with Pinniped Deployment Guide](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html). ![Identity management for management cluster](img/tko-on-vsphere-nsxt/tkg-installer-11.png) 1. Select the OS image that will be used for the management cluster deployment. - > **Note** This list appears empty if you don’t have a compatible template present in your environment. Refer steps provided in [Import Base Image template for TKG Cluster deployment](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html). + > **Note** This list appears empty if you don’t have a compatible template present in your environment. Refer steps provided in [Import Base Image template for TKG Cluster deployment](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#import-base). ![OS image for management cluster](img/tko-on-vsphere-nsxt/tkg-installer-12.png) @@ -1303,7 +1303,7 @@ Shared services cluster uses the custom ADC `tanzu-ako-for-shared` created earli After the management cluster is registered with Tanzu Mission Control, the deployment of the Tanzu Kubernetes clusters can be done in just a few clicks. The procedure for creating Tanzu Kubernetes clusters is as follows. -> **Note** The scope of this document doesn't cover the use of a proxy for Tanzu Kubernetes Grid deployment. If your environment uses a proxy server to connect to the internet, ensure that the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Management Cluster in the **No proxy list**, as described in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). +> **Note** The scope of this document doesn't cover the use of a proxy for Tanzu Kubernetes Grid deployment. If your environment uses a proxy server to connect to the internet, ensure that the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Management Cluster in the **No proxy list**, as described in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). 1. Navigate to the Clusters tab and click **Create Cluster**. @@ -1415,7 +1415,7 @@ After the management cluster is registered with Tanzu Mission Control, the deplo ``` -Now that the shared services cluster is successfully created, you may proceed with deploying the Harbor package. For more information, see [Install Harbor in Deploy User-Managed Packages in Workload Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html). +Now that the shared services cluster is successfully created, you may proceed with deploying the Harbor package. For more information, see [Install Harbor in Deploy User-Managed Packages in Workload Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor.html). ### Deploy Tanzu Kubernetes Grid Workload Cluster diff --git a/src/deployment-guides/tko-on-vsphere-with-tanzu.md b/src/deployment-guides/tko-on-vsphere-with-tanzu.md index 8c23eb1e..754dd749 100644 --- a/src/deployment-guides/tko-on-vsphere-with-tanzu.md +++ b/src/deployment-guides/tko-on-vsphere-with-tanzu.md @@ -10,7 +10,7 @@ You can use VMware Service Installer for VMware Tanzu to automate this deploymen VMware Service Installer for Tanzu automates the deployment of the reference designs for Tanzu for Kubernetes Operations. It uses best practices for deploying and configuring the required Tanzu for Kubernetes Operations components. -To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on vSphere with Tanzu and vSphere Distributed Switch Using Service Installer for VMware Tanzu](https://docs.vmware.com/en/Service-Installer-for-VMware-Tanzu/2.1/service-installer/GUID-index.html). +To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on vSphere with Tanzu and vSphere Distributed Switch Using Service Installer for VMware Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/service-installer-for-vmware-tanzu/2-4-0/tnz-sivt/release-vSphere-Backed-by-VDS-TKGm-TKOonVsphereVDStkg.html). Alternatively, if you decide to manually deploy each component, follow the steps provided in this document. @@ -36,11 +36,11 @@ Ensure that your environment meets the following general requirements: - A shared datastore with sufficient capacity for the control plane and worker node VM files. - Network Time Protocol (NTP) service running on all hosts and vCenter. - A user account with **Modify cluster-wide configuration** permissions. -- NSX Advanced Load Balancer 22.1.2 OVA downloaded from [customer connect](https://customerconnect.vmware.com/) portal and readily available for deployment. +- NSX Advanced Load Balancer 22.1.2 OVA downloaded from [Broadcom Support](https://support.broadcom.com) portal and readily available for deployment. > **Note** Tanzu Kubernetes Grid nodes will unable to resolve hostname with the “.local” domain suffix. For more information, see [KB article](https://kb.vmware.com/s/article/83623). -For additional information on general prerequisites, see [vSphere with Tanzu product documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-concepts-planning/GUID-7FF30A74-DDDD-4231-AAAE-0A92828B93CD.html). +For additional information on general prerequisites, see [vSphere with Tanzu product documentation](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/vsphere-iaas-control-plane-concepts-and-planning-8-0/requirements-for-enabling-a-single-cluster-supervisor/requirements-for-cluster-supervisor-deployment-with-nsx-advanced-load-balancer-and-vds-networking.html). ### Network Requirements @@ -88,7 +88,7 @@ Here are the high-level steps for deploying Tanzu Kubernetes operations on vSphe 8. [Deploy User-Managed Packages on Tanzu Kubernetes Grid Clusters](#deploy-user-managed-packages) > **Note** Starting with vSphere 8, when you enable vSphere with Tanzu, you can configure either one-zone Supervisor mapped to one vSphere cluster or three-zone Supervisor mapped to three vSphere clusters. -This document covers One-Zone supervisor deployment with VDS Networking and NSX Advanced Load Balancer. [Requirements for Cluster Supervisor Deployment with NSX Advanced Load Balancer and VDS Networking](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-concepts-planning/GUID-7FF30A74-DDDD-4231-AAAE-0A92828B93CD.html). +This document covers One-Zone supervisor deployment with VDS Networking and NSX Advanced Load Balancer. [Requirements for Cluster Supervisor Deployment with NSX Advanced Load Balancer and VDS Networking](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/vsphere-iaas-control-plane-concepts-and-planning-8-0/requirements-for-enabling-a-single-cluster-supervisor/requirements-for-cluster-supervisor-deployment-with-nsx-advanced-load-balancer-and-vds-networking.html). ## Deploy and Configure NSX Advanced Load Balancer @@ -125,7 +125,7 @@ Do the following to deploy NSX Advanced Load Balancer controller node: Complete the configuration and deploy NSX Advanced Load Balancer controller node. - For more information, see the product documentation [Deploy the Controller](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-CBA041AB-DC1D-4EEC-8047-184F2CF2FE0F.html). + For more information, see the product documentation [Deploy the Controller](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/deploy-the-nsx-advanced-load-balancer-controller.html#GUID-CBA041AB-DC1D-4EEC-8047-184F2CF2FE0F-en). ### Configure the Controller Node for your vSphere with Tanzu Environment @@ -261,7 +261,7 @@ The first controller of the cluster receives the "Leader" role. The second and t After the controller cluster is deployed, use the controller cluster IP address for doing any additional configuration. Do not use the individual controller node IP address. - For additional product documentation, see [Deploy a Controller Cluster](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-CBA041AB-DC1D-4EEC-8047-184F2CF2FE0F.html). + For additional product documentation, see [Deploy a Controller Cluster](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/deploy-the-nsx-advanced-load-balancer-controller.html#GUID-CBA041AB-DC1D-4EEC-8047-184F2CF2FE0F-en). ### Change NSX Advanced Load Balancer Portal Default Certificate @@ -311,7 +311,7 @@ To add a self-signed certificate: ![Screenshot of the New Certificate (SSL/TLS) window](img/tko-on-vsphere-with-tanzu/TKO-VWT22.png) -For additional product documentation, see [Assign a Certificate to the Controller](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-CBA041AB-DC1D-4EEC-8047-184F2CF2FE0F.html). +For additional product documentation, see [Assign a Certificate to the Controller](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/deploy-the-nsx-advanced-load-balancer-controller.html#GUID-CBA041AB-DC1D-4EEC-8047-184F2CF2FE0F-en). ### Export NSX Advanced Load Balancer Certificate @@ -329,7 +329,7 @@ Optionally, you can reconfigure the Default-Group to define the placement and nu This document uses the Default Service Engine Group without modification. -For more information, see the product documentation [Configure a Service Engine Group](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D.html). +For more information, see the product documentation [Configure a Service Engine Group](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/configure-a-service-engine-group.html#GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D-en). ### Configure a Virtual IP Subnet for the Data Network @@ -355,7 +355,7 @@ To configure the VIP network: 6. Click **Save** to close the VIP network configuration wizard. -For more information, see the product documentation [Configure a Virtual IP Network](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D.html). +For more information, see the product documentation [Configure a Virtual IP Network](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/configure-a-service-engine-group.html#GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D-en). ### Configure Default Gateway @@ -379,7 +379,7 @@ To configure the default gateway: ![Screenshot of Edit Static Route screen](img/tko-on-vsphere-with-tanzu/TKO-VWT25.png) -For additional product documentation, see [Configure Default Gateway](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D.html) +For additional product documentation, see [Configure Default Gateway](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/configure-a-service-engine-group.html#GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D-en) ### Configure IPAM and DNS Profile @@ -425,7 +425,7 @@ IPAM is required to allocate virtual IP addresses when virtual services get crea 8. Verify that the status of the Default-Cloud configuration is green. -For additional product documentation, see [Configure IPAM](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D.html). +For additional product documentation, see [Configure IPAM](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/networking-for-vsphere-with-tanzu/install-and-configure-the-nsx-advanced-load-balancer/configure-a-service-engine-group.html#GUID-14A98969-3115-45AC-9F0D-AA5A8EA6E16D-en). ## Deploy Tanzu Kubernetes Grid Supervisor Cluster @@ -438,8 +438,8 @@ Before deploying the Supervisor Cluster, ensure the following: * The vSphere cluster has HA & DRS enabled and DRS is configured in the fully-automated mode. * The required port groups have been created on the distributed switch to provide networking to the Supervisor and workload clusters. * Your vSphere cluster is licensed for Supervisor Cluster deployment. -* You have created a [Subscribed Content Library](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-254B2CE8-20A8-43F0-90E8-3F6776C2C896.html) to automatically pull the latest Tanzu Kubernetes releases from the VMware repository. -* You have created a [storage policy](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-544286A2-A403-4CA5-9C73-8EFF261545E7.html) that will determine the datastore placement of the Kubernetes control plane VMs, containers, and images. +* You have created a [Subscribed Content Library](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere/8-0/vsphere-virtual-machine-administration-guide-8-0/using-content-libraries.html) to automatically pull the latest Tanzu Kubernetes releases from the VMware repository. +* You have created a [storage policy](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/create-storage-policies-for-vsphere-iaas-control-plane.html) that will determine the datastore placement of the Kubernetes control plane VMs, containers, and images. * A user account with **Modify cluster-wide configuration** permissions is available. * NSX Advanced Load Balancer is deployed and configured as per instructions provided earlier. @@ -511,7 +511,8 @@ The Supervisor Cluster gets an IP address from the VIP network that you configur In the backend, three supervisor Control Plane VMs are deployed in the vSphere namespace. A Virtual Service is created in the NSX Advanced Load Balancer with three Supervisor Control Plane nodes that are deployed in the process. -For additional product documentation, see [Enable Workload Management with vSphere Networking](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-8D7D292B-43E9-4CB8-9E20-E4039B80BF9B.html). +For additional product documentation, see [Enable Workload Management with vSphere Networking](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/deploy-a-one-zone-supervisor/deploy-a-supervisor-with-vds-networking.html +). ### Download and Install the Kubernetes CLI Tools for vSphere @@ -523,7 +524,7 @@ To download the Kubernetes CLI tool, connect to the URL https://<_control-plane- ![Screenshot of the download page for Kubernetes CLI Tools](img/tko-on-vsphere-with-tanzu/TKO-VWT38-1.png) -For additional product documentation, see [Download and Install the Kubernetes CLI Tools for vSphere](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-0F6E45C4-3CB1-4562-9370-686668519FCA.html). +For additional product documentation, see [Download and Install the Kubernetes CLI Tools for vSphere](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/connecting-to-vsphere-with-tanzu-clusters/download-and-install-the-kubernetes-cli-tools-for-vsphere.html). ### Connect to the Supervisor Cluster @@ -547,7 +548,7 @@ where the `` is the IP address of the control plane VIP A vSphere Namespace is a tenancy boundary within vSphere with Tanzu and allows for sharing vSphere resources (computer, networking, storage) and enforcing resources limits with the underlying objects such as Tanzu Kubernetes Clusters. It also allows you to attach policies and permissions. -Every workload cluster that you deploy runs in a Supervisor namespace. To learn more about namespaces, see the [vSphere with Tanzu documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-concepts-planning/GUID-28B0AEA2-2947-4FDD-AA71-51E46E24BF53.html) +Every workload cluster that you deploy runs in a Supervisor namespace. To learn more about namespaces, see the [vSphere with Tanzu documentation](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/vsphere-iaas-control-plane-concepts-and-planning-8-0.html) To create a new Supervisor namespace: @@ -569,7 +570,7 @@ To create a new Supervisor namespace: ![Screenshot of the Create Namespace screen](img/tko-on-vsphere-with-tanzu/TKO-VWT40.png) -For additional product documentation, see [Create and Configure a vSphere Namespace](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-services-workloads/GUID-177C23C4-ED81-4ADD-89A2-61654C18201B.html). +For additional product documentation, see [Create and Configure a vSphere Namespace](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/vsphere-iaas-control-plane-services-and-workloads-8-0/configuring-and-managing-vsphere-namespaces/create-and-configure-a-vsphere-namespace.html). ### Configure Permissions for the Namespace @@ -609,7 +610,7 @@ The VM class is a VM specification that can be used to request a set of resource vSphere with Tanzu includes several default VM classes and each class has two editions: guaranteed and best effort. A guaranteed edition fully reserves the resources that a VM specification requests. A best-effort class edition does not and allows resources to be overcommitted. -More than one VM Class can be associated with a namespace. To learn more about VM classes, see the [vSphere with Tanzu documentation](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-tkg/GUID-5AC24EB3-30B2-4C9B-8AA5-9918665AD451.html). +More than one VM Class can be associated with a namespace. To learn more about VM classes, see the [vSphere with Tanzu documentation](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/using-tkg-service-with-vsphere-iaas-control-plane-8-0/configuring-vsphere-namespaces-for-hosting-tkg-service-clusters/using-vm-classes-with-tkg-service-clusters.html). To add a VM class to a namespace, @@ -631,7 +632,7 @@ The namespace is fully configured now. You are ready to register your supervisor Tanzu Mission Control is a centralized management platform for consistently operating and securing your Kubernetes infrastructure and modern applications across multiple teams and clouds. -By integrating Supervisor Cluster with Tanzu Mission Control (TMC) you are provided a centralized administrative interface that enables you to manage your global portfolio of Kubernetes clusters. It also allows you to deploy Tanzu Kubernetes clusters directly from Tanzu Mission Control portal and install user-managed packages leveraging the [TMC Catalog](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-EF35646D-8762-41F1-95E5-D2F35ED71BA1.html) feature. +By integrating Supervisor Cluster with Tanzu Mission Control (TMC) you are provided a centralized administrative interface that enables you to manage your global portfolio of Kubernetes clusters. It also allows you to deploy Tanzu Kubernetes clusters directly from Tanzu Mission Control portal and install user-managed packages leveraging the [TMC Catalog](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-EF35646D-8762-41F1-95E5-D2F35ED71BA1.html) feature. > **Note** This section uses the terms **Supervisor Cluster** and **management cluster** interchangeably. @@ -688,7 +689,7 @@ Do the following to register the Supervisor cluster with Tanzu Mission Control: After installing the agent, you can use the Tanzu Mission Control web interface to provision and manage Tanzu Kubernetes clusters. -For additional product documentation, see [Integrate the Tanzu Kubernetes Grid Service on the Supervisor Cluster with Tanzu Mission Control](https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-with-tanzu-installation-configuration/GUID-ED4417DC-592C-454A-8292-97F93BD76957.html). +For additional product documentation, see [Integrate the Tanzu Kubernetes Grid Service on the Supervisor Cluster with Tanzu Mission Control](https://techdocs.broadcom.com/us/en/vmware-cis/vsphere/vsphere-supervisor/8-0/installing-and-configuring-vsphere-iaas-control-plane-8-0/configuring-and-managing-a-supervisor-cluster/integrate-the-tanzu-kubernetes-grid-service-on-the-supvervisor-cluster-with-tanzu-mission-control.html). ## Deploy Tanzu Kubernetes Clusters (Workload Cluster) @@ -716,7 +717,7 @@ After Supervisor Cluster is registered with Tanzu Mission Control, deployment of ![Screenshot of Step 2: Name and Assign](img/tko-on-vsphere-with-tanzu/TKO-VWT59-a.png) - > **Note** This document doesn't cover the use of a proxy for vSphere with Tanzu. If your environment uses a proxy server to connect to the Internet, ensure the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Supervisor Cluster in the **No proxy list**, as explained in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster Running in vSphere with Tanzu](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html#GUID-B4760775-388A-45B5-A707-2191E9E4F41F). + > **Note** This document doesn't cover the use of a proxy for vSphere with Tanzu. If your environment uses a proxy server to connect to the Internet, ensure the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Supervisor Cluster in the **No proxy list**, as explained in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster Running in vSphere with Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). 7. Configure the Cluster network setting diff --git a/src/deployment-guides/tko-on-vsphere.md b/src/deployment-guides/tko-on-vsphere.md index 9608979f..379f348a 100644 --- a/src/deployment-guides/tko-on-vsphere.md +++ b/src/deployment-guides/tko-on-vsphere.md @@ -10,7 +10,7 @@ You can use VMware Service Installer for VMware Tanzu to automate this deploymen VMware Service Installer for Tanzu automates the deployment of the reference designs for Tanzu for Kubernetes Operations. It uses best practices for deploying and configuring the required Tanzu for Kubernetes Operations components. -To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on vSphere with vSphere Distributed Switch Using Service Installer for VMware Tanzu](https://docs.vmware.com/en/Service-Installer-for-VMware-Tanzu/2.3.0/service-installer/GUID-index.html). +To use Service Installer to automate this deployment, see [Deploying VMware Tanzu for Kubernetes Operations on vSphere with vSphere Distributed Switch Using Service Installer for VMware Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/service-installer-for-vmware-tanzu/2-4-0/tnz-sivt/release-vSphere-Backed-by-VDS-TKGm-TKOonVsphereVDStkg.html). Alternatively, if you decide to manually deploy each component, follow the steps provided in this document. @@ -48,19 +48,19 @@ The general requirements for deploying Tanzu for Kubernetes Operations on vSpher * A datastore with sufficient capacity for the control plane and worker node VM files. * Network Time Protocol (NTP) service running on all hosts and vCenter. * A host, server, or VM based on Linux, MacOS, or Windows that acts as your bootstrap machine, and that has docker installed. For this deployment, a virtual machine based on Photon OS is used. -* Depending on the OS flavor of the bootstrap VM, download and configure the **kubectl cluster CLI 1.26.5** from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). As part of this documentation, refer to the section to configure required packages on the Photon OS machine. +* Depending on the OS flavor of the bootstrap VM, download and configure the **kubectl cluster CLI 1.26.5** from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20CLI). As part of this documentation, refer to the section to configure required packages on the Photon OS machine. -* Download **Tanzu CLI v0.90.1** from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/details?downloadGroup=TCLI-0901&productId=1431). Starting with TKG 2.3.0, [Tanzu Core CLI](https://customerconnect.vmware.com/downloads/details?downloadGroup=TCLI-0901&productId=1431) is now distributed separately from Tanzu Kubernetes Grid. For instructions on how to install the Tanzu CLI for use with Tanzu Kubernetes Grid, refer [Install the Tanzu CLI](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/install-cli.html). +* Download **Tanzu CLI v0.90.1** from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20CLI). Starting with TKG 2.3.0, [Tanzu Core CLI](https://customerconnect.vmware.com/downloads/details?downloadGroup=TCLI-0901&productId=1431) is now distributed separately from Tanzu Kubernetes Grid. For instructions on how to install the Tanzu CLI for use with Tanzu Kubernetes Grid, refer [Install the Tanzu CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). -* A vSphere account with the permissions described in [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). +* A vSphere account with the permissions described in [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). * Download and import NSX Advanced Load Balancer 22.1.3 OVA to Content Library. -* Download the following OVA from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x) and import to vCenter. Convert the imported VMs to templates. +* Download the following OVA from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid) and import to vCenter. Convert the imported VMs to templates. * Photon v3 Kubernetes v1.26.5 OVA * Ubuntu 2004 Kubernetes v1.26.5 OVA   -> **Note** You can also download supported older versions of Kubernetes from [VMware Customer Connect](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x), and import them to deploy workload clusters on the intended Kubernetes versions. +> **Note** You can also download supported older versions of Kubernetes from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid), and import them to deploy workload clusters on the intended Kubernetes versions. > **Note** In Tanzu Kubernetes Grid nodes, it is recommended to not use hostnames with ".local" domain suffix. For more information, see [KB article](https://kb.vmware.com/s/article/83623). @@ -77,11 +77,11 @@ The sample entries of the resource pools and folders that need to be created are ### Network Requirements -Create port groups on vSphere DVSwitch for deploying Tanzu for Kubernetes Operations components as per [Network Requirements](https://docs.vmware.com/en/VMware-Tanzu-for-Kubernetes-Operations/2.1/tko-reference-architecture/GUID-reference-designs-tko-on-vsphere.html#network-requirements-8) defined in the reference architecture. +Create port groups on vSphere DVSwitch for deploying Tanzu for Kubernetes Operations components as per [Network Requirements](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/tanzu-for-kubernetes-operations-reference-architecture/2-3/tko-ref-arch/reference-designs-tko-on-vsphere.html#network-requirements-8) defined in the reference architecture. ### Firewall Requirements -Ensure that the firewall is set up as described in [Firewall Requirements](https://docs.vmware.com/en/VMware-Tanzu/services/tanzu-reference-architecture/GUID-reference-designs-tko-on-vsphere.html#firewall-recommendations-4). +Ensure that the firewall is set up as described in [Firewall Requirements](https://techdocs.broadcom.com/us/en/vmware-tanzu/reference-architectures/tanzu-for-kubernetes-operations-reference-architecture/2-3/tko-ref-arch/reference-designs-tko-on-vsphere.html#firewall-requirements). ## Subnet and CIDR Examples @@ -424,7 +424,7 @@ The deployment of the Tanzu Kubernetes Grid management and workload clusters is The bootstrap machine runs a local `kind` cluster when Tanzu Kubernetes Grid management cluster deployment is started. Once the `kind` cluster is fully initialized, the configuration is used to deploy the actual management cluster on the backend infrastructure. After the management cluster is fully configured, the local `kind` cluster is deleted and future configurations are performed with the Tanzu CLI. -For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For information on how to configure for a macOS or Windows machine, see [Install the Tanzu CLI and Other Tools](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/install-cli.html). +For this deployment, a Photon-based virtual machine is used as the bootstrap machine. For information on how to configure for a macOS or Windows machine, see [Install the Tanzu CLI and Other Tools](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). The bootstrap machine must meet the following prerequisites: @@ -590,7 +590,7 @@ Before you proceed with the management cluster creation, ensure that the base im * For the management cluster, this must be either Photon or Ubuntu based Kubernetes v1.26.5 OVA. - > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-byoi-index.html). + > **Note** Custom OVA with a custom Tanzu Kubernetes release (TKr) is also supported, as described in [Build Machine Images](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-byoi-index.html). * For workload clusters, OVA can have any supported combination of OS and Kubernetes version, as packaged in a Tanzu Kubernetes release. > **Note** Make sure you download the most recent OVA base image templates in the event of security patch releases. You can find updated base image templates that include security patches on the Tanzu Kubernetes Grid product download page. @@ -607,7 +607,7 @@ Before you proceed with the management cluster creation, ensure that the base im 1. **If using non administrator SSO account**: In the VMs and Templates view, right-click the new template, select **Add Permission**, and assign the **tkg-user** to the template with the **TKG role**. -For information about how to create the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). +For information about how to create the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). ## Deploy Tanzu Kubernetes Grid (TKG) Management Cluster @@ -642,7 +642,7 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G 1. In the IaaS Provider section, enter the IP/FQDN and credentials of the vCenter server where the Tanzu Kubernetes Grid management cluster is deployed. - > **Note** Do not provide a vSphere administrator account to Tanzu Kubernetes Grid. Instead, create a custom role and user account with the required permissions specified in [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions).

+ > **Note** Do not provide a vSphere administrator account to Tanzu Kubernetes Grid. Instead, create a custom role and user account with the required permissions specified in [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions).

![IaaS provider details](img/tko-on-vsphere/37-Mgmt-cluster-2.png) @@ -676,9 +676,9 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G * Control Plane Endpoint Provider: Select NSX Advanced Load Balancer for Control Plane HA. * Control Plane Endpoint: This is an optional field. If left blank, NSX Advanced Load Balancer will assign an IP address from the pool “sfo01-w01-vds01-tkgclustervip” created earlier. If you need to provide an IP address, pick an IP address from “sfo01-w01-vds01-tkgclustervip”  static IP pools configured in NSX_ALB and ensure that the IP address is unused. - * Machine Health Checks: Enable. You can activate or deactivate MachineHealthCheck on clusters after deployment by using the CLI. For instructions, see [Configure Machine Health Checks for Workload Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-clusters-mhc.html). + * Machine Health Checks: Enable. You can activate or deactivate MachineHealthCheck on clusters after deployment by using the CLI. For instructions, see [Configure Machine Health Checks for Workload Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-clusters-mhc.html). - * Enable Audit Logging: Enable for audit logging for Kubernetes API server and node VMs. Choose as per your environment needs. For more information, see [Audit Logging](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-troubleshoot-audit-logging.html). + * Enable Audit Logging: Enable for audit logging for Kubernetes API server and node VMs. Choose as per your environment needs. For more information, see [Audit Logging](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-audit-logging.html). ![Management cluster settings](img/tko-on-vsphere/40-Mgmt-cluster-5.png) @@ -709,7 +709,7 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G ![NSX Advanced Load Balancer settings for management cluster](img/tko-on-vsphere/41-Mgmt-cluster-6.png) - > **Note** With the above configuration, all the Tanzu workload clusters use `sfo01-w01-vds01-tkgclustervip` for control plane VIP network and `sfo01-w01-vds01-tkgworkloadvip` for data plane network by default. If you would like to configure separate VIP networks for workload control plane/data networks, create a custom AKO Deployment Config (ADC) and provide the respective `AVI_LABELS` in the workload cluster config file. For more information on network separation and custom ADC creation, see [Configure Separate VIP Networks and Service Engine Groups in Different Workload Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-network-nsx-alb-cp-endpoint.html). + > **Note** With the above configuration, all the Tanzu workload clusters use `sfo01-w01-vds01-tkgclustervip` for control plane VIP network and `sfo01-w01-vds01-tkgworkloadvip` for data plane network by default. If you would like to configure separate VIP networks for workload control plane/data networks, create a custom AKO Deployment Config (ADC) and provide the respective `AVI_LABELS` in the workload cluster config file. For more information on network separation and custom ADC creation, see [Configure Separate VIP Networks and Service Engine Groups in Different Workload Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-network-nsx-alb-cp-endpoint.html). 1. (Optional) On the Metadata page, you can specify location and labels and click **Next**. @@ -739,13 +739,13 @@ The following procedure provides the required steps to deploy Tanzu Kubernetes G 1. (Optional) Specify identity management with OIDC or LDAP. For this deployment, identity management is not enabled. - If you would like to enable identity management, see [Enable and Configure Identity Management During Management Cluster Deployment](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-iam-configure-id-mgmt.html). + If you would like to enable identity management, see [Enable and Configure Identity Management During Management Cluster Deployment](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html). ![Identity management for management cluster](img/tko-on-vsphere/45-Mgmt-cluster-10.png) 1. Select the OS image to use for deploying the management cluster - > **Note** This list appears empty if you don’t have a compatible template present in your environment. See the steps provided in [Import Base Image Template into vSphere](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#import-base). + > **Note** This list appears empty if you don’t have a compatible template present in your environment. See the steps provided in [Import Base Image Template into vSphere](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#import-base). ![OS image for management cluster](img/tko-on-vsphere/46-Mgmt-cluster-11.png) @@ -1075,7 +1075,7 @@ Shared services cluster uses the custom ADC `tanzu-ako-for-shared` created earli After the management cluster is registered with Tanzu Mission Control, the deployment of the Tanzu Kubernetes clusters can be done in just a few clicks. The procedure for creating Tanzu Kubernetes clusters is as follows. -> **Note** The scope of this document doesn't cover the use of a proxy for Tanzu Kubernetes Grid deployment. If your environment uses a proxy server to connect to the internet, ensure that the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Management Cluster in the **No proxy list**, as described in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster Running in vSphere with Tanzu](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tanzumc-using/GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). +> **Note** The scope of this document doesn't cover the use of a proxy for Tanzu Kubernetes Grid deployment. If your environment uses a proxy server to connect to the internet, ensure that the proxy configuration object includes the CIDRs for the pod, ingress, and egress from the workload network of the Management Cluster in the **No proxy list**, as described in [Create a Proxy Configuration Object for a Tanzu Kubernetes Grid Service Cluster Running in vSphere with Tanzu](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-using-GUID-B4760775-388A-45B5-A707-2191E9E4F41F.html). 1. Navigate to the Clusters tab and click **Create Cluster** and select **Create Tanzu Kubernetes Grid cluster**. @@ -1186,7 +1186,7 @@ Now that the shared services cluster is successfully created, you may proceed wi ``` -Now that the shared services cluster is successfully created, you may proceed with deploying the Harbor package. For more information, see [Install Harbor for Service Registry](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html). +Now that the shared services cluster is successfully created, you may proceed with deploying the Harbor package. For more information, see [Install Harbor for Service Registry](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor.html). ## Deploy Tanzu Kubernetes Grid Workload Clusters diff --git a/src/deployment-guides/tko-saas-services.md b/src/deployment-guides/tko-saas-services.md index 5777af15..a020bd1d 100644 --- a/src/deployment-guides/tko-saas-services.md +++ b/src/deployment-guides/tko-saas-services.md @@ -27,7 +27,7 @@ Managing Tanzu Kubernetes Clusters lifecycle from Tanzu Mission Control involves Before managing Tanzu Kubernetes Grid clusters lifecycle from Tanzu Mission Control, complete the following: -* Review [About Getting Started with VMware Tanzu Mission Control](https://docs.vmware.com/en/VMware-Tanzu-Mission-Control/services/tmc-getting-started/index-gs.html) for information about setting up and using VMware Tanzu Mission Control. +* Review [About Getting Started with VMware Tanzu Mission Control](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-mission-control/saas/tanzu-mission-control-documentation/tanzumc-getting-started-index-gs.html) for information about setting up and using VMware Tanzu Mission Control. * Ensure you have a subscription to Tanzu Mission Control. * Create a cluster group in Tanzu Mission Control. * Create a workspace in the Tanzu Mission Control. From 082dbc7d2b8f2e6f47659427f0f0af62c6a021f7 Mon Sep 17 00:00:00 2001 From: shanrajad23 Date: Thu, 7 Nov 2024 12:00:01 +0530 Subject: [PATCH 3/3] Updating additional links Signed-off-by: shanrajad23 --- src/deployment-guides/pinniped-with-tkg.md | 4 +-- src/deployment-guides/tap.md | 7 ++--- src/deployment-guides/tkg-nsxt-airgap.md | 12 ++++----- src/deployment-guides/tkg-package-install.md | 10 +++---- .../tkg-vsphere-vds-airgap.md | 18 ++++++------- src/deployment-guides/tko-aws.md | 26 ++++++++----------- 6 files changed, 37 insertions(+), 40 deletions(-) diff --git a/src/deployment-guides/pinniped-with-tkg.md b/src/deployment-guides/pinniped-with-tkg.md index a4457ef2..9bae134b 100644 --- a/src/deployment-guides/pinniped-with-tkg.md +++ b/src/deployment-guides/pinniped-with-tkg.md @@ -287,7 +287,7 @@ This procedure configures the Pinniped add-on and deploys the authentication com ``` - >**Note** If the Pinniped app reconcile fails, see [Troubleshooting Core Add-on Configuration](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-packages-update-addons.html#troubleshooting). + >**Note** If the Pinniped app reconcile fails, see [Troubleshooting Core Add-on Configuration](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-clusters-config-auto.html#troubleshoot). ## Complete the Identity Management Configuration on Management Cluster @@ -576,7 +576,7 @@ For more information on how to configure role-based access control (RBAC) in Tan ### Generate and Test a Non-Administrator `kubeconfig` File for the Tanzu Clusters -This procedure allows you to test the login step of the authentication process if a browser is present on the machine on which you are running tanzu and kubectl commands. If the machine does not have a browser, see [Authenticate Users on a Machine Without a Browser](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.5/vmware-tanzu-kubernetes-grid-15/GUID-iam-configure-id-mgmt.html#no-browser). +This procedure allows you to test the login step of the authentication process if a browser is present on the machine on which you are running tanzu and kubectl commands. If the machine does not have a browser, see [Authenticate Users on a Machine Without a Browser](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-iam-configure-id-mgmt.html#no-browser). 1. Export the regular `kubeconfig` for the management cluster to a local file, for example, /tmp/id_mgmt_test_kubeconfig. Note that the command does not include the --admin option, so the `kubeconfig` that is exported is the regular `kubeconfig`, not the admin version. diff --git a/src/deployment-guides/tap.md b/src/deployment-guides/tap.md index 63a715c8..c5e19153 100644 --- a/src/deployment-guides/tap.md +++ b/src/deployment-guides/tap.md @@ -106,7 +106,8 @@ yq --version ### Step 2: Add the Tanzu Application Platform Package Repository -To install kapp-controller on workload clusters that are deployed on vSphere with Tanzu (TKGS) using YAML files and Tanzu Kubernetes Grid API, see [Prepare a Tanzu Kubernetes Cluster Created by Using vSphere with Tanzu to Run Packages](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.4/vmware-tanzu-kubernetes-grid-14/GUID-packages-prep-tkgs-kapp.html). +Install kapp-controller on workload clusters that are deployed on vSphere with Tanzu (TKGS) using YAML files and Tanzu Kubernetes Grid API. + After installing `kapp-controller`, install [carvel-secretgen-controller](https://github.com/vmware-tanzu/carvel-secretgen-controller). Use the following command: @@ -586,7 +587,7 @@ Provide the following user inputs to set environment variables into commands and * `INSTALL_REGISTRY_PASSWORD` - tanzu net password * `TAP_ITERATE_CNRS_DOMAIN` - tap iterate cluster cnrs domain -For more information, see [Full Profile](https://docs.vmware.com/en/Tanzu-Application-Platform/1.1/tap/GUID-install.html#full-profile) in the Tanzu Application Platform product documentation. +For more information, see [Full Profile](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/install-online-profile.html) in the Tanzu Application Platform product documentation. ```bash set -e @@ -762,4 +763,4 @@ See [Service Bindings for Kubernetes](https://techdocs.broadcom.com/us/en/vmware ### Tanzu Application Platform GUI Auth Provider -See [Setting up a Tanzu Application Platform GUI authentication provider](https://docs.vmware.com/en/Tanzu-Application-Platform/1.1/tap/GUID-tap-gui-auth.html) for additional details. +See [Setting up a Tanzu Application Platform GUI authentication provider](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-application-platform/1-12/tap/tap-gui-auth.html) for additional details. diff --git a/src/deployment-guides/tkg-nsxt-airgap.md b/src/deployment-guides/tkg-nsxt-airgap.md index b400a243..d2292b60 100644 --- a/src/deployment-guides/tkg-nsxt-airgap.md +++ b/src/deployment-guides/tkg-nsxt-airgap.md @@ -616,9 +616,9 @@ The bastion host needs to be deployed with the following hardware configuration: ![Docker installation binaries](img/tkg-airgap-nsxt/docker-installation-binaries.jpg) -2. Download Harbor OVA from the [Customer Connect](https://customerconnect.vmware.com/en/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). +2. Download Harbor OVA from the [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid). -3. Download the NSX Advanced Load Balancer OVA from [VMware Customer Connect portal](https://customerconnect.vmware.com/downloads/info/slug/networking_security/vmware_nsx_advanced_load_balancer/22_1_x). +3. Download the NSX Advanced Load Balancer OVA from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20NSX-T%20Container%20Plug-in). 4. Download Tanzu CLI, Kubectl, and the Kubernetes OVA images from the [Tanzu Kubernetes Grid product download page](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). Tanzu CLI and plug-ins need to be installed on the bastion host and the bootstrap machine. @@ -1682,7 +1682,7 @@ You can see that the workload cluster is successfully deployed and the AKO pod i User-managed packages are installed after workload cluster creation. These packages extend the core functionality of Kubernetes clusters created by Tanzu Kubernetes Grid. -Tanzu Kubernetes Grid includes the following user-managed packages. These packages provide in-cluster and shared services to the Kubernetes clusters that are running in your Tanzu Kubernetes Grid environment.

[Installing and Managing Packages with the Tanzu CLI](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-index.html) +Tanzu Kubernetes Grid includes the following user-managed packages. These packages provide in-cluster and shared services to the Kubernetes clusters that are running in your Tanzu Kubernetes Grid environment.

[Installing and Managing Packages with the Tanzu CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/index.html) |**Function**|**Package**|**Location**| | --- | --- | --- | @@ -1833,7 +1833,7 @@ certificates: renewBefore: 360h ``` -For a full list of user-configurable values, see [Configure the Contour Extension](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-contour.html). +For a full list of user-configurable values, see [Configure the Contour Extension](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-contour.html). 1. Capture the available Contour package versions. @@ -2029,7 +2029,7 @@ Do the following to deploy Prometheus into a workload cluster: |ingress.enabled|false|true| |ingress.virtual_host_fqdn|prometheus.system.tanzu|prometheus.your-domain| - To see a full list of user configurable configuration parameters, see [Prometheus Package Configuration Parameters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-prometheus.html). + To see a full list of user configurable configuration parameters, see [Prometheus Package Configuration Parameters](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html). 1. After you make any changes needed to the `prometheus-data-values.yaml` file, remove all comments in the file: @@ -2107,7 +2107,7 @@ Do the following to deploy Prometheus into a workload cluster: cp /tmp/grafana-package-9.5.1+vmware.2-tkg.1/config/values.yaml grafana-data-values.yaml ``` - This creates a configuration file named `grafana-data-values.yaml` that you can modify. For a full list of user-configurable values, see [Grafana Package Configuration Parameters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-grafana.html). + This creates a configuration file named `grafana-data-values.yaml` that you can modify. For a full list of user-configurable values, see [Grafana Package Configuration Parameters](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html). 4. Edit grafana-data-values.yaml and replace the following with your custom values. diff --git a/src/deployment-guides/tkg-package-install.md b/src/deployment-guides/tkg-package-install.md index d91b72d4..48b7cfc8 100644 --- a/src/deployment-guides/tkg-package-install.md +++ b/src/deployment-guides/tkg-package-install.md @@ -70,7 +70,7 @@ envoy: pspNames: "vmware-system-privileged" ``` -For a full list of user-configurable values, see the [Contour documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-contour.html). +For a full list of user-configurable values, see the [Contour documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-contour.html). > **Note** You can leave the default settings blank if you don’t want to customize the package installation. @@ -108,7 +108,7 @@ trivy: enabled: true ``` -For a full list of user-configurable values, see the [Harbor documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html). +For a full list of user-configurable values, see the [Harbor documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor.html). Below is a screenshot of the Harbor installation page showing a YAML file for customizing Harbor installation: @@ -134,7 +134,7 @@ ingress: alertmanagerServicePort: 80 ``` -For a full list of user-configurable values, see the [Prometheus documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-prometheus.html). +For a full list of user-configurable values, see the [Prometheus documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html). Below is a sample screenshot of a customized Prometheus installation: @@ -160,7 +160,7 @@ ingress: virtual_host_fqdn: "grafana.sfo01.rainpole.vmw" ``` -For a full list of user-configurable values, see the [Grafana documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-grafana.html). +For a full list of user-configurable values, see the [Grafana documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html). Below is a sample screenshot for customizing your Grafana installation: @@ -178,7 +178,7 @@ You can use Fluent Bit to gather logs from management clusters or Tanzu Kubernet The example shown in this document uses an HTTP endpoint [VMware Aria Operations for Logs](https://techdocs.broadcom.com/content/broadcom/techdocs/us/en/vmware-cis/aria/aria-operations-for-logs/SaaS/using-vmware-aria-operations-for-logs-cloud.html) for forwarding logs from Tanzu Kubernetes clusters. -A sample YAML file for configuring an http endpoint with Fluent Bit is provided as a reference here. For a full list of user-configurable values, see the [Fluent Bit documentation](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-fluentbit.html). +A sample YAML file for configuring an http endpoint with Fluent Bit is provided as a reference here. For a full list of user-configurable values, see the [Fluent Bit documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-fluentbit.html). ```yaml diff --git a/src/deployment-guides/tkg-vsphere-vds-airgap.md b/src/deployment-guides/tkg-vsphere-vds-airgap.md index d7ec51f7..c85e19c4 100644 --- a/src/deployment-guides/tkg-vsphere-vds-airgap.md +++ b/src/deployment-guides/tkg-vsphere-vds-airgap.md @@ -39,7 +39,7 @@ Before deploying Tanzu Kubernetes Grid in vSphere environment, ensure that your - Network Time Protocol (NTP) service is running on all ESXi hosts and vCenter, and time is synchronized from the centralized NTP servers. - A host/server/VM based on Linux that acts as your **bastion host** and is located **outside the Internet-restricted environment (i.e. connected to the Internet)**. The installation binaries for Tanzu Kubernetes Grid and NSX Advanced Load Balancer will be downloaded on this machine. You will need to transfer files from this bastion host to your Internet-restricted environment (proxy connection, shared drive, USB drive, sneakernet, and so on). - A host/server/VM **inside your Internet-restricted environment** based on Linux/Windows, which acts as your bootstrap machine and has Tanzu CLI, Kubectl and docker installed. This document uses a virtual machine based on CentOS. An internal Harbor registry will be installed on the same machine. -- vSphere account with permissions as described in [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). +- vSphere account with permissions as described in [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). > **Note** You can download and import supported older versions of Kubernetes in order to deploy workload clusters on the intended Kubernetes versions. > **Note** In Tanzu Kubernetes Grid nodes, it is recommended to not use hostnames with ".local" domain suffix. For more information, see [KB article](https://kb.vmware.com/s/article/83623) @@ -125,9 +125,9 @@ You must ensure that the following options are available: ![code screen captures displaying the binaries](img/tkg-airgap-vsphere-deploy/docker-installation-binaries.jpg) -2. Download Harbor OVA from [VMware Customer Connect portal](https://customerconnect.vmware.com/en/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). +2. Download Harbor OVA from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20Tanzu%20Kubernetes%20Grid). -3. Download the NSX Advanced Load Balancer OVA from [VMware Customer Connect portal](https://customerconnect.vmware.com/downloads/info/slug/networking_security/vmware_nsx_advanced_load_balancer/22_1_x). +3. Download the NSX Advanced Load Balancer OVA from [Broadcom Support](https://support.broadcom.com/group/ecx/productdownloads?subfamily=VMware%20NSX-T%20Container%20Plug-in). 4. Download Tanzu CLI, Kubectl, and the Kubernetes OVA images from the [Tanzu Kubernetes Grid product download page](https://customerconnect.vmware.com/downloads/info/slug/infrastructure_operations_management/vmware_tanzu_kubernetes_grid/2_x). Tanzu CLI and its plug-ins need to be installed on the bastion host and the bootstrap machine. Starting with TKG 2.3.0, [Tanzu Core CLI](https://customerconnect.vmware.com/downloads/details?downloadGroup=TCLI-0901&productId=1431) is now distributed separately from Tanzu Kubernetes Grid. For more infromation about installing the Tanzu CLI for using with Tanzu Kubernetes Grid, see [Install the Tanzu CLI](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/install-cli.html). @@ -211,7 +211,7 @@ Install Harbor only if you don’t have any existing image repository in your en For more information about deploying and configuring Harbor, see [Deploy an Offline Harbor Registry on vSphere](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-harbor.html). - >**Note** This VM-based harbor deployment is only supported for hosting the TKG system images in an internet-restricted or air-gapped environment. To deploy a scalable and highly-available Harbor that can manage large numbers of images for hosted apps in a production environment, deploy the Harbor package to TKG clusters as described in [Install Harbor for Service Registry](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html) in Creating and Managing TKG 2.3 Workload Clusters with the Tanzu CLI. + >**Note** This VM-based harbor deployment is only supported for hosting the TKG system images in an internet-restricted or air-gapped environment. To deploy a scalable and highly-available Harbor that can manage large numbers of images for hosted apps in a production environment, deploy the Harbor package to TKG clusters as described in [Install Harbor for Service Registry](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor.html) in Creating and Managing TKG 2.3 Workload Clusters with the Tanzu CLI. ## Deploy and Configure Bootstrap VM @@ -493,7 +493,7 @@ Before you proceed with the management cluster creation, ensure that the base im 1. **If using non administrator SSO account**: In the VMs and Templates view, right-click the new template, select **Add Permission**, and assign the **tkg-user** to the template with the **TKG role**. -For information about how to create the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/tkg-deploy-mc/mgmt-reqs-prep-vsphere.html#vsphere-permissions). +For information about how to create the user and role for Tanzu Kubernetes Grid, see [Required Permissions for the vSphere Account](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-reqs-prep-vsphere.html#vsphere-permissions). ### Import NSX Advanced Load Balancer in Content Library @@ -1786,7 +1786,7 @@ certificates: renewBefore: 360h ``` -For a full list of user-configurable values, see [Configure the Contour Extension](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.1/using-tkg-21/workload-packages-contour.html). +For a full list of user-configurable values, see [Configure the Contour Extension](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-contour.html). 1. Capture the available Contour package versions. @@ -1893,7 +1893,7 @@ Perform the following procedure to deploy Harbor into a workload cluster or a sh - harborAdminPassword - secretKey - You can also change the values for other parameters to meet the requirements for your deployment. For the full list of the user-configurable values, see [Deploy Harbor into a Cluster](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-harbor.html). + You can also change the values for other parameters to meet the requirements for your deployment. For the full list of the user-configurable values, see [Deploy Harbor into a Cluster](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor.html). 1. Remove the comments in the `harbor-data-values.yaml` file. @@ -1985,7 +1985,7 @@ Do the following to deploy Prometheus into a workload cluster: |ingress.enabled|false|true| |ingress.virtual_host_fqdn|prometheus.system.tanzu|prometheus.your-domain| - To see a full list of user configurable configuration parameters, see [Prometheus Package Configuration Parameters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-prometheus.html). + To see a full list of user configurable configuration parameters, see [Prometheus Package Configuration Parameters](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html#params-prometheus-mc). 1. After you make the necessary changes to your `prometheus-data-values.yaml` file, remove all comments in the file: @@ -2063,7 +2063,7 @@ Do the following to deploy Prometheus into a workload cluster: cp /tmp/grafana-package-9.5.1+vmware.2-tkg.1/config/values.yaml grafana-data-values.yaml ``` - This creates a configuration file named `grafana-data-values.yaml` that you can modify. For a full list of user-configurable values, see [Grafana Package Configuration Parameters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/2.3/using-tkg/workload-packages-grafana.html). + This creates a configuration file named `grafana-data-values.yaml` that you can modify. For a full list of user-configurable values, see [Grafana Package Configuration Parameters](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html#params-grafana-mc). 4. Edit grafana-data-values.yaml and replace the following with your custom values. diff --git a/src/deployment-guides/tko-aws.md b/src/deployment-guides/tko-aws.md index 05852d14..43c7a8ce 100644 --- a/src/deployment-guides/tko-aws.md +++ b/src/deployment-guides/tko-aws.md @@ -21,15 +21,12 @@ Choose an AWS region where the Tanzu Kubernetes Grid (TKG) AMIs exist. * **AWS Resource Quotas**: Sufficient quotas to support both the management cluster and the workload clusters in your deployment. Otherwise, the cluster deployments will fail. Depending on the number of workload clusters you plan to deploy, you may need to increase the AWS services quotas from their default values. You will need to increase the quota in every region in which you deploy Tanzu Kubernetes Grid. For more information on AWS default service quotas, see [AWS service quotas](https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html) in the AWS documentation. -See [Tanzu Kubernetes Grid resources in AWS account](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-aws.html#aws-resources) for more details. - > **Note** The number of VPCs will depend on the VPC architecture you have selected. * **Bootstrap Machine with AWS CLI Installed**: The bootstrap machine can be a local device such as a laptop, or a virtual machine running in, for example, VMware Workstation or Fusion. Install the AWS CLI on the bootstrap machine. You can get the AWS CLI through a package manager such as Homebrew, apt-get, or by downloading the CLI from [AWS CLI](https://aws.amazon.com/cli/). You will use the bootstrap machine to create the AWS VPC and jumpbox. * **VMware Cloud**: Access to [Broadcom Support](https://support.broadcom.com) to download Tanzu CLI. -For additional information about preparing to deploy Tanzu Kubernetes Grid on AWS, see [Prepare to Deploy Management Clusters to Amazon EC2](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-aws.html). ## Overview of the Deployment Steps @@ -369,8 +366,7 @@ To deploy a management cluster from the Tanzu Kubernetes Grid installer interfac - **Bastion Host**: Select Enable. - **Machine Health Checks**: Select Enable. - **AWS CloudFormation Stack**: Select this if this is the first time that you are - deploying a management cluster to this AWS account, see - [Permissions Set by Tanzu Kubernetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.4/vmware-tanzu-kubernetes-grid-14/GUID-mgmt-clusters-aws.html#iam-permissions) for more details. + deploying a management cluster to this AWS account. - **Availability Zone**: Select the three availability zones for your region. - **VPC Public and Private Subnets**: Select the existing subnets on the VPC for each AZ. - **Worker Node Instance Type**: Select the configuration for the worker node VMs. @@ -495,7 +491,7 @@ For more information about deploying a management cluster from a configuration f During the deployment of the management cluster, either from the installer interface or from a configuration file using Tanzu CLI, Tanzu Kubernetes Grid creates a temporary management cluster using a Kubernetes in Docker, `kind`, cluster on the jumpbox. -Tanzu Kubernetes Grid uses the temporary management cluster to provision the final management cluster on AWS. For information about how to examine and verify your Tanzu Kubernetes Grid management cluster deployment, see [Examine the Management Cluster Deployment](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-mgmt-clusters-verify-deployment.html). +Tanzu Kubernetes Grid uses the temporary management cluster to provision the final management cluster on AWS. For information about how to examine and verify your Tanzu Kubernetes Grid management cluster deployment, see [Examine the Management Cluster Deployment](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-deploy-post-deploy.html). ## Deploy Workload Clusters @@ -521,11 +517,11 @@ tanzu cluster create --plan=prod --worker-machine-count 3 --d After the workload cluster is created, the current context changes to the new workload cluster. -For more information on cluster lifecycle and management, see [Manage Clusters](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-cluster-lifecycle-index.html). +For more information on cluster lifecycle and management, see [Manage Clusters](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-clusters-manage-index.html). ### Troubleshooting Tips for Tanzu Kubernetes Grid -For tips to help you to troubleshoot common problems that you might encounter when installing Tanzu Kubernetes Grid and deploying Tanzu Kubernetes clusters, see [Troubleshooting Tips for Tanzu Kubernetes Grid](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-troubleshooting-tkg-tips.html). +For tips to help you to troubleshoot common problems that you might encounter when installing Tanzu Kubernetes Grid and deploying Tanzu Kubernetes clusters, see [Troubleshooting Tips for Tanzu Kubernetes Grid](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/mgmt-troubleshoot-mgmt-clusters.html). ## Install and Configure Packages into Workload Clusters @@ -543,19 +539,19 @@ Using the Tanzu CLI, you can install CLI-managed packages from the built-in `tan The following provide more information on installing VMware recommended CLI-managed packages: -* [Install Cert Manager](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-cert-manager.html) +* [Install Cert Manager](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-cert-mgr.html) -* [Implement Ingress Control with Contour](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-ingress-contour.html) +* [Implement Ingress Control with Contour](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-contour.html) -* [Implement Log Forwarding with Fluent Bit](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-logging-fluentbit.html) +* [Implement Log Forwarding with Fluent Bit](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-fluentbit.html) -* [Implement Monitoring with Prometheus and Grafana](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-monitoring.html) +* [Implement Monitoring with Prometheus and Grafana](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-monitoring.html) -* [Implement Multiple Pod Network Interfaces with Multus](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-cni-multus.html) +* [Implement Multiple Pod Network Interfaces with Multus](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-cni.html) -* [Implement Service Discovery with ExternalDNS](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-external-dns.html) +* [Implement Service Discovery with ExternalDNS](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-externaldns.html) -* [Deploy Harbor Registry as a Shared Service](https://docs.vmware.com/en/VMware-Tanzu-Kubernetes-Grid/1.6/vmware-tanzu-kubernetes-grid-16/GUID-packages-harbor-registry.html) +* [Deploy Harbor Registry as a Shared Service](https://techdocs.broadcom.com/us/en/vmware-tanzu/cli/tanzu-packages/latest/tnz-packages/packages-harbor-mc.html) If you want to deploy Harbor into a shared services cluster, create a shared services cluster if it is not already created. For instructions, see [Create a Shared Services Cluster](https://techdocs.broadcom.com/us/en/vmware-tanzu/standalone-components/tanzu-kubernetes-grid/2-5/tkg/workload-clusters-deploy.html#shared). Also, make sure you add `INFRASTRUCTURE_PROVIDER: aws` into shared service workload cluster config file.