Skip to content

Commit

Permalink
fixing vmware and other doc links (#506)
Browse files Browse the repository at this point in the history
* fixing vmware and other doc links

Signed-off-by: shanrajad23 <[email protected]>

* checking the second batch of doc changes

Signed-off-by: shanrajad23 <[email protected]>

* Updating additional links

Signed-off-by: shanrajad23 <[email protected]>

---------

Signed-off-by: shanrajad23 <[email protected]>
  • Loading branch information
shanrajad23 authored Nov 7, 2024
1 parent c3f3c20 commit 8b60973
Show file tree
Hide file tree
Showing 14 changed files with 198 additions and 209 deletions.
16 changes: 8 additions & 8 deletions src/deployment-guides/pinniped-with-tkg.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**.
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -287,7 +287,7 @@ This procedure configures the Pinniped add-on and deploys the authentication com
```
<!-- /* cSpell:enable */ -->

>**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

Expand All @@ -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

Expand Down Expand Up @@ -572,11 +572,11 @@ 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

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.

Expand Down
21 changes: 11 additions & 10 deletions src/deployment-guides/tap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -106,7 +106,8 @@ yq --version

### <a id=tap-package-repo> </a>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.

<!-- /* cSpell:disable */ -->
After installing `kapp-controller`, install [carvel-secretgen-controller](https://github.com/vmware-tanzu/carvel-secretgen-controller). Use the following command:
<!-- /* cSpell:enable */ -->
Expand Down Expand Up @@ -149,7 +150,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
Expand Down Expand Up @@ -281,7 +282,7 @@ Provide the following user inputs to set environments variables into commands an
<!-- /* cSpell:enable */ -->
>**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
Expand Down Expand Up @@ -355,7 +356,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.



Expand Down Expand Up @@ -559,7 +560,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).


## <a id=tap-full> </a> Set Up Tanzu Application Platform Iterate Cluster
Expand All @@ -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
Expand Down Expand Up @@ -752,14 +753,14 @@ kubectl get ksvc
In the event of failure, use the following command to obtain failure details:
`kubectl get packageinstall/<package> -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
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.
6 changes: 3 additions & 3 deletions src/deployment-guides/tkg-data-protection.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading

0 comments on commit 8b60973

Please sign in to comment.