From d7c9b67aefd00f6605ccda1cc8f0e23cbc57107e Mon Sep 17 00:00:00 2001 From: addetz <43963729+addetz@users.noreply.github.com> Date: Fri, 13 Dec 2024 20:54:36 +0000 Subject: [PATCH] docs: add links to requirements in install guides --- _partials/self-hosted/_kubernetes_palette_versions.mdx | 1 - _partials/self-hosted/_setup-steps.mdx | 7 +++++-- docs/docs-content/clusters/pcg/deploy-pcg-k8s.md | 3 +++ .../install-on-kubernetes/airgap-install/install.md | 4 +++- .../install-palette/install-on-kubernetes/install.md | 4 +++- .../airgap-install/environment-setup/env-setup-vm.md | 9 ++++++--- .../vmware-vsphere-airgap-instructions.md | 3 ++- .../install-palette/install-on-vmware/install.md | 10 ++++------ .../enterprise-version/upgrade/upgrade-k8s/airgap.md | 4 ++++ .../upgrade/upgrade-k8s/non-airgap.md | 4 ++++ .../upgrade/upgrade-vmware/airgap.md | 4 ++++ .../upgrade/upgrade-vmware/non-airgap.md | 3 +++ .../install-on-kubernetes/airgap-install/install.md | 4 +++- .../install-on-kubernetes/install.md | 4 +++- .../environment-setup/env-setup-vm-vertex.md | 9 ++++++--- .../vmware-vsphere-airgap-instructions.md | 5 +++-- .../install-on-vmware/install.md | 10 ++++------ 17 files changed, 60 insertions(+), 28 deletions(-) diff --git a/_partials/self-hosted/_kubernetes_palette_versions.mdx b/_partials/self-hosted/_kubernetes_palette_versions.mdx index c74035c98e..5c7794b1f6 100644 --- a/_partials/self-hosted/_kubernetes_palette_versions.mdx +++ b/_partials/self-hosted/_kubernetes_palette_versions.mdx @@ -5,7 +5,6 @@ partial_name: kubernetes-palette-versions | **Palette Version** | **Kubernetes Version** | **OVA Download URL** | **FIPS OVA Download URL** | | ------------------- | ---------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| 4.5.15 | 1.29.9 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova` | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova` | | 4.5.11 | 1.29.9 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova` | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova` | | 4.5.10 | 1.29.9 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova` | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova` | | 4.5.8 | 1.29.9 | `https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-1299-0.ova` | `https://vmwaregoldenimage.s3.amazonaws.com/u-2004-0-k-1299-fips.ova` | diff --git a/_partials/self-hosted/_setup-steps.mdx b/_partials/self-hosted/_setup-steps.mdx index 2de5320e35..5387c5a3d9 100644 --- a/_partials/self-hosted/_setup-steps.mdx +++ b/_partials/self-hosted/_setup-steps.mdx @@ -51,9 +51,12 @@ partial_name: setup-steps 3. Right-click on your cluster or resource group and select **Deploy OVF Template**. 4. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes - distribution OVA required for the {props.edition} nodes creation. Contact your {props.edition} support representative to learn if - the version of {props.edition} you are using requires a new OS and Kubernetes OVA. + distribution OVA required for the {props.edition} nodes creation. Refer to the + section to learn if the version of + {props.edition} you are installing requires a new OS and Kubernetes OVA. + {props.requirementsURL} + diff --git a/docs/docs-content/clusters/pcg/deploy-pcg-k8s.md b/docs/docs-content/clusters/pcg/deploy-pcg-k8s.md index f585ed8e38..6f9b4704ab 100644 --- a/docs/docs-content/clusters/pcg/deploy-pcg-k8s.md +++ b/docs/docs-content/clusters/pcg/deploy-pcg-k8s.md @@ -71,6 +71,9 @@ development and testing environments. to the [PCG Sizing](#pcg-sizing) section for more information. - A Container Network Interface plugin installed. - A Container Storage Interface plugin installed. + - The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your PCG version. Refer to + the [Kubernetes Requirements](./pcg.md#kubernetes-requirements) section to find the version required for your + Palette installation - PCG IP address requirements: diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md index 8ad04ba333..a67467cb63 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/airgap-install/install.md @@ -34,7 +34,9 @@ Complete the [Environment Setup](./kubernetes-airgap-instructions.md) steps befo - Ensure `unzip` or a similar extraction utility is installed on your system. -- The Kubernetes cluster must be set up on a supported version of Kubernetes, which includes versions v1.28 to v1.29. +- The Kubernetes cluster must be set up on a supported version of Kubernetes. Refer to the + [Kubernetes Requirements](../../install-palette.md#kubernetes-requirements) section to find the version required for + your Palette installation. - Ensure the Kubernetes cluster does not have Cert Manager installed. Palette requires a unique Cert Manager configuration to be installed as part of the installation process. If Cert Manager is already installed, you must diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md index cbe88d86af..3d176c495e 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/install.md @@ -23,7 +23,9 @@ You can use the Palette Helm Chart to install Palette in a multi-node Kubernetes - Ensure `unzip` or a similar extraction utility is installed on your system. -- The Kubernetes cluster must be set up on a supported version of Kubernetes, which includes versions v1.28 to v1.29. +- The Kubernetes cluster must be set up on a supported version of Kubernetes. Refer to the + [Kubernetes Requirements](../install-palette.md#kubernetes-requirements) section to find the version required for your + Palette installation. - Ensure the Kubernetes cluster does not have Cert Manager installed. Palette requires a unique Cert Manager configuration to be installed as part of the installation process. If Cert Manager is already installed, you must diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md index 2ddaaf85c9..4583907ca2 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/env-setup-vm.md @@ -26,6 +26,9 @@ This guide is for preparing your airgap environment only. For instructions on in - Currently, `9.4` is the only supported RHEL version. -import SetupSteps from "../../../../../../../_partials/self-hosted/_setup-steps.mdx"; - - + diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md index b17556f0d9..d6fe3b6801 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md @@ -365,7 +365,8 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock 23. Right-click on your cluster or resource group and select **Deploy OVF Template**. 24. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes - distribution OVA required for the installation. Contact your support representative to learn if the version of + distribution OVA required for the installation. Refer to the + [Kubernetes Requirements](../../../install-palette.md#kubernetes-requirements) section to learn if the version of Palette you are installing requires a new OS and Kubernetes OVA. Consider the following example for reference. diff --git a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md index ecf6171ca7..b85936cec7 100644 --- a/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md +++ b/docs/docs-content/enterprise-version/install-palette/install-on-vmware/install.md @@ -97,12 +97,10 @@ Use the following steps to install Palette. 2. Create a vSphere VM and Template folder with the name `spectro-templates`. Ensure this folder is accessible by the user account you will use to deploy the Palette installation. -3. Use the URL below to import the Operating System and Kubernetes distribution OVA required for the install. Place the - OVA in the `spectro-templates` folder. - - ```url - https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12813-0.ova - ``` +3. Find the OVA download URL corresponding to your Palette version in the + [Kubernetes Requirements](../install-palette.md#kubernetes-requirements) section. Use the identified URL to import + the Operating System and Kubernetes distribution OVA required for the install. Place the OVA in the + `spectro-templates` folder. 4. Append an `r_` prefix to the OVA name and remove the `.ova` suffix after the import. For example, the final output should look like `r_u-2204-0-k-12813-0`. This naming convention is required for the install process to identify the diff --git a/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md b/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md index 82aaa58353..7efa6cbe45 100644 --- a/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md +++ b/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/airgap.md @@ -45,6 +45,10 @@ Palette upgrade. - Access to the latest Palette Helm Chart. Refer to [Access Palette](/enterprise-version/#access-palette) for more details. +- The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your upgraded version. Refer to + the [Kubernetes Requirements](../../install-palette/install-palette.md#kubernetes-requirements) section to find the + version required for your Palette installation. + ## Upgrade 1. Log in to the Linux environment from which you can access your self-hosted airgap Palette instance. diff --git a/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/non-airgap.md b/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/non-airgap.md index 7df02a932e..0948a2605f 100644 --- a/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/non-airgap.md +++ b/docs/docs-content/enterprise-version/upgrade/upgrade-k8s/non-airgap.md @@ -36,6 +36,10 @@ Palette upgrade. - Access to the latest Palette Helm Chart. Refer to [Access Palette](/enterprise-version/#access-palette) for more details. +- The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your upgraded version. Refer to + the [Kubernetes Requirements](../../install-palette/install-palette.md#kubernetes-requirements) section to find the + version required for your Palette installation. + ## Upgrade :::info diff --git a/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md b/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md index b16d257b91..24bcfd06d2 100644 --- a/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md +++ b/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/airgap.md @@ -39,6 +39,10 @@ Palette upgrade. - A diff or text comparison tool of your choice. +- The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your upgraded version. Refer to + the [Kubernetes Requirements](../../install-palette/install-palette.md#kubernetes-requirements) section to find the + version required for your Palette installation. + ## Upgrade :::info diff --git a/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/non-airgap.md b/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/non-airgap.md index 3f7c70e2a2..141bfd044b 100644 --- a/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/non-airgap.md +++ b/docs/docs-content/enterprise-version/upgrade/upgrade-vmware/non-airgap.md @@ -28,6 +28,9 @@ Palette upgrade. - Access to the Palette system console. - A diff or text comparison tool of your choice. +- The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your upgraded version. Refer to + the [Kubernetes Requirements](../../install-palette/install-palette.md#kubernetes-requirements) section to find the + version required for your Palette installation. ## Upgrade diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md index fbd5779dec..c3a33975fb 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/airgap-install/install.md @@ -34,7 +34,9 @@ Complete the [Environment Setup](./kubernetes-airgap-instructions.md) steps befo - Ensure `unzip` or a similar extraction utility is installed on your system. -- The Kubernetes cluster must be set up on a supported version of Kubernetes, which includes versions v1.28 to v1.29. +- The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your upgraded version. Refer to + the [Kubernetes Requirements](../../install-palette-vertex.md#kubernetes-requirements) section to find the version + required for your Palette installation. - Ensure the Kubernetes cluster does not have Cert Manager installed. VerteX requires a unique Cert Manager configuration to be installed as part of the installation process. If Cert Manager is already installed, you must diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md index 44802b0990..b2da50fed5 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-kubernetes/install.md @@ -28,7 +28,9 @@ has the necessary network connectivity for VerteX to operate successfully. - Ensure `unzip` or a similar extraction utility is installed on your system. -- The Kubernetes cluster must be set up on a supported version of Kubernetes, which includes versions v1.28 to v1.29. +- The Kubernetes cluster must be set up on a version of Kubernetes that is compatible to your upgraded version. Refer to + the [Kubernetes Requirements](../install-palette-vertex.md#kubernetes-requirements) section to find the version + required for your Palette installation. - Ensure the Kubernetes cluster does not have Cert Manager installed. VerteX requires a unique Cert Manager configuration to be installed as part of the installation process. If Cert Manager is already installed, you must diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md index 88b492bb61..86cee85649 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/env-setup-vm-vertex.md @@ -26,6 +26,9 @@ This guide is for preparing your airgap environment only. For instructions on in - Currently, `9.4` is the only supported RHEL version. -import SetupSteps from "../../../../../../../_partials/self-hosted/_setup-steps.mdx"; - - + diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md index bb350eefcb..ee11c41030 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/airgap-install/environment-setup/vmware-vsphere-airgap-instructions.md @@ -371,8 +371,9 @@ The default container runtime for OVAs is [Podman](https://podman.io/), not Dock 23. Next, right-click on your cluster or resource group and select **Deploy OVF Template**. 24. In the **Deploy OVF Template** wizard, enter the following URL to import the Operating System (OS) and Kubernetes - distribution OVA required for the installation. Contact your support representative to learn if the version of - VerteX you are installing requires a new OS and Kubernetes OVA. + distribution OVA required for the installation. Refer to the + [Kubernetes Requirements](../../../install-palette-vertex.md#kubernetes-requirements) section to learn if the + version of Palette you are installing requires a new OS and Kubernetes OVA. Consider the following example for reference. diff --git a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md index efa2f4f12c..30497a14d1 100644 --- a/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md +++ b/docs/docs-content/vertex/install-palette-vertex/install-on-vmware/install.md @@ -121,15 +121,13 @@ Use the following steps to install Palette VerteX. 2. Create a vSphere VM and Template folder with the name `spectro-templates`. Ensure this folder is accessible by the user account you will use to deploy the VerteX installation. -3. Use the URL below to import the Operating System and Kubernetes distribution OVA required for the install. Place the - OVA in the `spectro-templates` folder. Refer to the +3. Find the OVA download URL corresponding to your Palette VerteX version in the + [Kubernetes Requirements](../install-palette-vertex.md#kubernetes-requirements) section. Use the identified URL to + import the Operating System and Kubernetes distribution OVA required for the install. Place the OVA in the + `spectro-templates` folder. Refer to the [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?hWord=N4IghgNiBcIJYFsAOB7ATgFwAQYKbIjDwGcQBfIA) guide for information about importing an OVA in vCenter. - ```url - https://vmwaregoldenimage.s3.amazonaws.com/u-2204-0-k-12813-0.ova - ``` - 4. Append an `r_` prefix to the OVA name and remove the `.ova` suffix after the import. For example, the final output should look like `r_u-2204-0-k-12813-0`. This naming convention is required for the install process to identify the OVA. Refer to the [Supplement Packs](../airgap/supplemental-packs.md#additional-ovas) page for a list of additional