Skip to content

Commit

Permalink
docs: fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
caroldelwing committed Sep 24, 2024
1 parent e77b5ad commit 1ab9281
Show file tree
Hide file tree
Showing 17 changed files with 42 additions and 54 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,7 @@ topology your deployments face.
## Resources

To learn more about Palette Edge, review the [Edge](../../clusters/edge/edge.md) section to learn more about Edge and
its features. Then, follow the [Deploy an Edge Cluster on VMware](../../tutorials/edge/deploy-cluster.md) tutorial to
learn how to build Edge artifacts, prepare VMware VMs as Edge hosts using the Edge installer ISO, create a cluster
profile referencing a provider image, and deploy a cluster.
its features.

Check out the following video for a quick overview of how you can provision and manage thousands of edge Kubernetes
clusters with Palette.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ in self-hosted, airgapped, and in our SaaS environments. Learn more on the

## Resources

To learn more about Palette VMO, review the [Get Started With VM Orchestrator](../../vm-management/vm-management.md#get-started-with-vm-orchestrator) page to learn about the
components involved in enabling VMO for your infrastructure. Then, review the
[Create a VMO Profile](../../vm-management/create-vmo-profile.md) guide to prepare everything you need to deploy your
first cluster with VMO.
To learn more about Palette VMO, review the
[Get Started With VM Orchestrator](../../vm-management/vm-management.md#get-started-with-vm-orchestrator) page to learn
about the components involved in enabling VMO for your infrastructure.

Check out the following video for a tour of Palette's Virtual Machine Orchestrator (VMO) capability. It shows how you
can model, deploy, and manage VM workloads alongside containers in your clusters.
Expand Down
10 changes: 4 additions & 6 deletions docs/docs-content/getting-started/aws/create-cluster-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ choose the desired Operating System (OS), Kubernetes, Container Network Interfac
types, refer to [Cluster Profiles](../introduction.md#cluster-profiles).

In this tutorial, you create a full profile directly from the Palette dashboard. Then, you add a layer to your cluster
profile by using a community pack to deploy a web application. The concepts you
learn about in the Getting Started section are centered around a fictional case study company, Spacetastic Ltd.
profile by using a community pack to deploy a web application. The concepts you learn about in the Getting Started
section are centered around a fictional case study company, Spacetastic Ltd.

## 🧑‍🚀 Back at Spacetastic HQ

Expand All @@ -26,10 +26,8 @@ learn about in the Getting Started section are centered around a fictional case

- Follow the steps described in the [Set up Palette with AWS](./setup.md) guide to authenticate Palette for use with
your AWS cloud account.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries/registries.md#default-registries)
is available in your Palette environment. Refer to the
[Add OCI Packs Registry](../../registries-and-packs/registries/oci-registry/add-oci-packs.md) guide for additional
guidance.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries-and-packs.md#default-registry) is
available in your Palette environment.

## Create a Full Cluster Profile

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -627,8 +627,8 @@ Once the changes have been completed, Palette marks the cluster layers with a gr

![Image that shows the cluster with Kubecost](/getting-started/aws/getting-started_deploy-manage-k8s-cluster_profile-with-kubecost.webp)

Next, download the kubeconfig file for your cluster from the Palette
UI. This file enables you and other users to issue `kubectl` commands against the host cluster.
Next, download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
`kubectl` commands against the host cluster.

![Image that shows the cluster's kubeconfig file location](/getting-started/aws/getting-started_deploy-manage-k8s-cluster_kubeconfig.webp)

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/getting-started/aws/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ will be successfully deployed.

![Image that shows completed cluster profile updates](/getting-started/aws/getting-started_update-k8s-cluster_completed-cluster-updates.webp)

Download the [kubeconfig](../../clusters/cluster-management/kubeconfig.md) file for your cluster from the Palette UI.
This file enables you and other users to issue kubectl commands against the host cluster.
Download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
kubectl commands against the host cluster.

![Image that the kubeconfig file](/getting-started/aws/getting-started_update-k8s-cluster_download-kubeconfig.webp)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ choose the desired Operating System (OS), Kubernetes, Container Network Interfac
types, refer to [Cluster Profiles](../introduction.md#cluster-profiles).

In this tutorial, you create a full profile directly from the Palette dashboard. Then, you add a layer to your cluster
profile by using a community pack to deploy a web application. The concepts you
learn about in the Getting Started section are centered around a fictional case study company, Spacetastic Ltd.
profile by using a community pack to deploy a web application. The concepts you learn about in the Getting Started
section are centered around a fictional case study company, Spacetastic Ltd.

## 🧑‍🚀 Back at Spacetastic HQ

Expand All @@ -26,10 +26,8 @@ learn about in the Getting Started section are centered around a fictional case

- Follow the steps described in the [Set up Palette with Azure](./setup.md) guide to authenticate Palette for use with
your Azure cloud account.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries/registries.md#default-registries)
is available in your Palette environment. Refer to the
[Add OCI Packs Registry](../../registries-and-packs/registries/oci-registry/add-oci-packs.md) guide for additional
guidance.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries-and-packs.md#default-registry) is
available in your Palette environment.

## Create a Full Cluster Profile

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -631,8 +631,8 @@ Once the changes have been completed, Palette marks the cluster layers with a gr

![Image that shows the cluster with Kubecost](/getting-started/azure/getting-started_deploy-manage-k8s-cluster_profile-with-kubecost.webp)

Next, download the kubeconfig file for your cluster from the Palette
UI. This file enables you and other users to issue `kubectl` commands against the host cluster.
Next, download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
`kubectl` commands against the host cluster.

![Image that shows the cluster's kubeconfig file location](/getting-started/azure/getting-started_deploy-manage-k8s-cluster_kubeconfig.webp)

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/getting-started/azure/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ will be successfully deployed.

![Image that shows completed cluster profile updates](/getting-started/azure/getting-started_update-k8s-cluster_completed-cluster-updates.webp)

Download the [kubeconfig](../../clusters/cluster-management/kubeconfig.md) file for your cluster from the Palette UI.
This file enables you and other users to issue kubectl commands against the host cluster.
Download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
kubectl commands against the host cluster.

![Image that the kubeconfig file](/getting-started/azure/getting-started_update-k8s-cluster_download-kubeconfig.webp)

Expand Down
10 changes: 4 additions & 6 deletions docs/docs-content/getting-started/gcp/create-cluster-profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ choose the desired Operating System (OS), Kubernetes, Container Network Interfac
types, refer to [Cluster Profiles](../introduction.md#cluster-profiles).

In this tutorial, you create a full profile directly from the Palette dashboard. Then, you add a layer to your cluster
profile by using a community pack to deploy a web application. The concepts you
learn about in the Getting Started section are centered around a fictional case study company, Spacetastic Ltd.
profile by using a community pack to deploy a web application. The concepts you learn about in the Getting Started
section are centered around a fictional case study company, Spacetastic Ltd.

## 🧑‍🚀 Back at Spacetastic HQ

Expand All @@ -26,10 +26,8 @@ learn about in the Getting Started section are centered around a fictional case

- Follow the steps described in the [Set up Palette with GCP](./setup.md) guide to authenticate Palette for use with
your GCP cloud account.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries/registries.md#default-registries)
is available in your Palette environment. Refer to the
[Add OCI Packs Registry](../../registries-and-packs/registries/oci-registry/add-oci-packs.md) guide for additional
guidance.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries-and-packs.md#default-registry) is
available in your Palette environment.

## Create a Full Cluster Profile

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -620,8 +620,8 @@ Once the changes have been completed, Palette marks the cluster layers with a gr

![Image that shows the cluster with Kubecost](/getting-started/gcp/getting-started_deploy-manage-k8s-cluster_profile-with-kubecost.webp)

Next, download the kubeconfig file for your cluster from the Palette
UI. This file enables you and other users to issue `kubectl` commands against the host cluster.
Next, download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
`kubectl` commands against the host cluster.

![Image that shows the cluster's kubeconfig file location](/getting-started/gcp/getting-started_deploy-manage-k8s-cluster_kubeconfig.webp)

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/getting-started/gcp/update-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ will be successfully deployed.

![Image that shows completed cluster profile updates](/getting-started/gcp/getting-started_update-k8s-cluster_completed-cluster-updates.webp)

Download the [kubeconfig](../../clusters/cluster-management/kubeconfig.md) file for your cluster from the Palette UI.
This file enables you and other users to issue kubectl commands against the host cluster.
Download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
kubectl commands against the host cluster.

![Image that the kubeconfig file](/getting-started/gcp/getting-started_update-k8s-cluster_download-kubeconfig.webp)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ choose the desired Operating System (OS), Kubernetes, Container Network Interfac
types, refer to [Cluster Profiles](../introduction.md#cluster-profiles).

In this tutorial, you create a full profile directly from the Palette dashboard. Then, you add a layer to your cluster
profile by using a community pack to deploy a web application. The concepts you
learn about in the Getting Started section are centered around a fictional case study company, Spacetastic Ltd.
profile by using a community pack to deploy a web application. The concepts you learn about in the Getting Started
section are centered around a fictional case study company, Spacetastic Ltd.

## 🧑‍🚀 Back at Spacetastic HQ

Expand All @@ -28,10 +28,8 @@ learn about in the Getting Started section are centered around a fictional case
your VMware user account.
- Refer to the [Deploy a PCG with Palette CLI](./deploy-pcg.md) guide to create the required infrastructure that enables
communication with your cluster.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries/registries.md#default-registries)
is available in your Palette environment. Refer to the
[Add OCI Packs Registry](../../registries-and-packs/registries/oci-registry/add-oci-packs.md) guide for additional
guidance.
- Ensure that the [Palette Community Registry](../../registries-and-packs/registries-and-packs.md#default-registry) is
available in your Palette environment.

## Create a Full Cluster Profile

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -502,9 +502,8 @@ ssh_key_private = ""
:::info

If you deployed the PCG using static IP placement, you must create an
[IPAM pool](../../clusters/cluster-management/node-pool.md) before deploying clusters. Set the
`deploy-vmware-static` variable to true and provide the required values for the variables under the **Static IP Pool
Variables** section.
[IPAM pool](../../clusters/cluster-management/node-pool.md) before deploying clusters. Set the `deploy-vmware-static`
variable to true and provide the required values for the variables under the **Static IP Pool Variables** section.

:::

Expand Down Expand Up @@ -675,8 +674,8 @@ Once the changes have been completed, Palette marks the cluster layers with a gr

![Image that shows the cluster with Kubecost](/getting-started/vmware/getting-started_deploy-manage-k8s-cluster_profile-with-kubecost.webp)

Next, download the kubeconfig file for your cluster from the Palette
UI. This file enables you and other users to issue `kubectl` commands against the host cluster.
Next, download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
`kubectl` commands against the host cluster.

![Image that shows the cluster's kubeconfig file location](/getting-started/vmware/getting-started_deploy-manage-k8s-cluster_kubeconfig.webp)

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/getting-started/vmware/deploy-pcg.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ either deploy or delete Kubernetes clusters within the environment. This connect
that is encrypted using the Transport Layer Security (TLS) protocol. Once a cluster is deployed, the PCG is no longer
involved in the communication between Palette and the deployed cluster. The cluster then communicates directly with
Palette through the Palette agent available within each cluster, which originates all network requests outbound toward
Palette.
Palette.

In this tutorial, you will deploy a VMware PCG using Palette CLI.

Expand All @@ -34,7 +34,7 @@ You will need a Linux x86-64 machine with access to a terminal and Internet, as
VMware vSphere.

- The following IP address requirements must be met in your VMware vSphere environment:
- One IP address available for the single-node PCG deployment. Refer to the [PCG Sizing](../../clusters/pcg/manage-pcg/scale-pcg-nodes.md) section for more information on sizing.
- One IP address available for the single-node PCG deployment.
- One IP address reserved for cluster repave operations.
- One IP address for the Virtual IP (VIP).
- DNS must be able to resolve the domain `api.spectrocloud.com`.
Expand Down
3 changes: 1 addition & 2 deletions docs/docs-content/getting-started/vmware/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ section are centered around a fictional case study company, Spacetastic Ltd.

- A Palette account with [tenant admin](../../tenant-settings/tenant-settings.md) access.

- A [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) user account with the
required permissions.
- A [VMware vSphere](https://docs.vmware.com/en/VMware-vSphere/index.html) user account with the required permissions.

## Enablement

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ will be successfully deployed.

![Image that shows completed cluster profile updates](/getting-started/vmware/getting-started_update-k8s-cluster_completed-cluster-updates.webp)

Download the [kubeconfig](../../clusters/cluster-management/kubeconfig.md) file for your cluster from the Palette UI.
This file enables you and other users to issue kubectl commands against the host cluster.
Download the kubeconfig file for your cluster from the Palette UI. This file enables you and other users to issue
kubectl commands against the host cluster.

![Image that the kubeconfig file](/getting-started/vmware/getting-started_update-k8s-cluster_download-kubeconfig.webp)

Expand Down
1 change: 1 addition & 0 deletions docs/docs-content/integrations/edge-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -1056,6 +1056,7 @@ a role. To learn more, review <VersionedLink text="Use RBAC with OIDC" url="/int

- **Custom**: This is the default setting and does not require OIDC configuration. However, if desired, it allows you to
specify a third-party OIDC provider by configuring OIDC statements in the YAML file as described in

<VersionedLink text="Configure Custom OIDC" url="/integrations/packs/?pack=edge-k8s#configure-custom-oidc" />. This
setting displays in the YAML file as `none`.

Expand Down

0 comments on commit 1ab9281

Please sign in to comment.