-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…1645) * docs: refactor for self-hosted Palette DOC-465 (#1597) * docs: refactor for self-hosted Palette DOC-465 * docs: updated palette content * docs: added VMware install docs * docs: image updates and deprecation * chore: gitleaks and FRPS clean-up * docs: refactor and condensed pages * docs: updated headings * chore: rebased * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * Optimised images with calibre/image-actions * docs: feedback incoporated * docs: minor language touchup * docs: touche dup the system requirements document * docs: fixed bold * docs: updated VerteX permissions page * docs: updated VerteX * chore: addresses DOC-886 * docs: feedback incorporated * docs: fixed a sentence * Apply suggestions from code review Co-authored-by: Rita Watson <[email protected]> * docs: updated vertex page * ci: reverted to the default runner --------- Co-authored-by: Rita Watson <[email protected]> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> (cherry picked from commit 6b4d07a) * chore: gitleaks fix --------- Co-authored-by: Karl Cardenas <[email protected]>
- Loading branch information
1 parent
117f7c0
commit 8c0a958
Showing
50 changed files
with
4,087 additions
and
289 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 161 | ||
| } |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| --- | ||
| sidebar_label: "Self-Hosted Installation" | ||
| title: "Self-Hosted Installation" | ||
| description: "Understanding, installing and operating Spectro Cloud's Enterprise Self-Hosted variant." | ||
| hide_table_of_contents: false | ||
| sidebar_custom_props: | ||
| icon: "cat" | ||
| tags: ["self-hosted", "enterprise"] | ||
| --- | ||
|
|
||
|
|
||
| Palette is available as a self-hosted platform offering. You can install the self-hosted version of Palette in your data centers or public cloud providers to manage Kubernetes clusters. | ||
|
|
||
|
|
||
| ## VMware Quick Start | ||
|
|
||
| A single-node Palette installation that is ideal for Proof of Concept (PoC) environments. Refer to the [Quick Start Installation](deploying-the-platform-installer.md) guide for more details. | ||
|
|
||
| ## VMware Enterprise | ||
|
|
||
| A highly available multi-node Palette installation that is typically used for production purposes. Check out the [Enterprise Mode](deploying-an-enterprise-cluster.md) guide to get started. | ||
|
|
||
| ## Kubernetes Install Helm Chart | ||
|
|
||
| Install Palette onto a Kubernetes cluster using a Helm Chart. Review the [Helm Chart Mode](deploying-palette-with-helm.md) guide to learn more. | ||
|
|
||
|
|
||
| ## Airgap Install | ||
|
|
||
| Palette can be installed in a VMware environment without internet access, known as an air gap installation, which requires advance download of the following: | ||
| - Platform manifests | ||
| - Required platform packages | ||
| - Container images for core components | ||
| - Third-party dependencies | ||
| - Palette packs | ||
|
|
||
| ## Download Palette Installer | ||
|
|
||
| To request the Palette self-hosted installer image, contact our Support team by sending an email to [email protected]. Kindly provide the following information in your email: | ||
|
|
||
| - Your full name | ||
| - Organization name (if applicable) | ||
| - Email address | ||
| - Phone number (optional) | ||
| - A brief description of your intended use for the Palette Self-host installer image. | ||
|
|
||
| Our dedicated support team will promptly get in touch with you to provide the necessary assistance and share the installer image. | ||
|
|
||
| If you have any questions or concerns, please feel free to contact [email protected]. | ||
|
|
||
|
|
||
| ## Upgrade Notes | ||
|
|
||
| Review the [Upgrade Notes](upgrade.md) before attempting to upgrade Palette. | ||
|
|
||
|
|
||
|
|
||
| ## Resources | ||
|
|
||
|
|
||
| * [System Requirements](on-prem-system-requirements.md) | ||
|
|
||
|
|
||
| * [Quick Start Mode](deploying-the-platform-installer.md) | ||
|
|
||
|
|
||
| * [Enterprise Mode](deploying-an-enterprise-cluster.md) | ||
|
|
||
|
|
||
| * [Helm Chart Mode](deploying-palette-with-helm.md) | ||
|
|
||
|
|
||
| * [System Console Dashboard](system-console-dashboard.md) | ||
|
|
||
|
|
||
| * [Creating a VMware Cloud Gateway](../clusters/data-center/vmware.md#install-pcg) | ||
|
|
||
|
|
||
| * [Create VMware Cloud Account](../clusters/data-center/vmware.md#create-vmware-cloud-gateway) | ||
|
|
||
|
|
||
| * [Deploy a VMware Cluster](../clusters/data-center/vmware#deploy-a-vmware-cluster) | ||
|
|
||
|
|
||
| * [PCG Troubleshooting](../troubleshooting/pcg.md) | ||
|
|
||
|
|
||
| * [Upgrade Notes](upgrade.md) | ||
|
|
||
|
|
||
|
|
||
|
|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| --- | ||
| sidebar_label: "Upgrade Notes" | ||
| title: "Upgrade Notes" | ||
| description: "Spectro Cloud upgrade notes for specific Palette versions." | ||
| icon: "" | ||
| hide_table_of_contents: false | ||
| sidebar_position: 100 | ||
| --- | ||
|
|
||
| This page is a reference resource to help you better prepare for a Palette upgrade. Review each version's upgrade notes for more information about required actions and other important messages to be aware of. If you have questions or concerns, reach out to our support team by opening up a ticket through our [support page](http://support.spectrocloud.io/). | ||
|
|
||
| ## Palette 4.0 | ||
|
|
||
| Palette 4.0 includes the following major enhancements that require user intervention to facilitate the upgrade process. | ||
|
|
||
| - **Enhanced security for Palette microservices** - To enhance security, all microservices within Palette now use `insecure-skip-tls-verify` set to `false`. When upgrading to Palette 4.0, you must provide a valid SSL certificate in the system console. | ||
|
|
||
| If you already have an SSL certificate, key, and Certificate Authority (CA) certificate, you can use them when upgrading to Palette 4.0.0. To learn how to upload SSL certificates to Palette, refer to [SSL Certificate Management](ssl-certificate-management.md). | ||
|
|
||
|
|
||
| - **Self-hosted Palette Kubernetes Upgrade** - If you installed Palette using the Helm Chart method, the Kubernetes version used for Palette is upgraded from version 1.24 to 1.25. You will need to copy the new Kubernetes YAML to the Kubernetes layer in the Enterprise cluster profile. If you have customized your Kubernetes configuration, you will need to manually adjust custom values and include any additional configuration in the upgraded YAML that we provide. Refer to [Upgrade Kubernetes](upgrade.md#upgrade-kubernetes). | ||
|
|
||
| ### Upgrade from Palette 3.x to 4.0 | ||
|
|
||
| From the Palette system console, click the **Update version** button. Palette will be temporarily unavailable while system services update. | ||
|
|
||
|  | ||
|
|
||
| #### Upgrade Kubernetes | ||
|
|
||
| Follow the steps below to upgrade Kubernetes. | ||
|
|
||
| <br /> | ||
|
|
||
| 1. To obtain the upgraded Kubernetes YAML file for Palette 4.0, contact our support team by sending an email to [email protected]. | ||
|
|
||
|
|
||
| 2. In the system console, click on **Enterprise Cluster Migration**. | ||
|
|
||
|
|
||
| 3. Click on the **Profiles** tab, and select the Kubernetes layer. The Kubernetes YAML is displayed in the editor at right. | ||
|
|
||
|
|
||
| 4. If the existing Kubernetes YAML has been customized or includes additional configuration, we suggest you create a backup of it by copying it to another location. | ||
|
|
||
|
|
||
| 5. Copy the Kubernetes YAML you received from our support team and paste it into the editor. | ||
|
|
||
| <br /> | ||
|
|
||
|  | ||
|
|
||
|
|
||
| 6. If you have made any additional configuration changes or additions, add your customizations to the new YAML. | ||
|
|
||
|
|
||
| 7. Save your changes. | ||
|
|
||
| The Enterprise cluster initiates the Kubernetes upgrade process and leads to the reconciliation of all three nodes. | ||
|
|
||
|
|
||
| ## Palette 3.4 | ||
|
|
||
| Prior versions of Palette installed internal Palette components' ingress resources in the default namespace. The new version of the Helm Chart ensures all Palette required ingress resources are installed in the correct namespace. Self-hosted Palette instances deployed to Kubernetes and upgrading from Palette versions 3.3.X or older must complete the following action. | ||
|
|
||
|
|
||
| 1. Connect to the cluster using the cluster's kubeconfig file. | ||
|
|
||
|
|
||
|
|
||
| 2. Identify all Ingress resources that belong to *Hubble* - an internal Palette component. | ||
|
|
||
| ```shell | ||
| kubectl get ingress --namespace default | ||
| ``` | ||
| 3. Remove each Ingress resource listed in the output that starts with the name Hubble. Use the following command to delete an Ingress resource. Replace `REPLACE_ME` with the name of the Ingress resource you are removing. | ||
| ```shell | ||
| kubectl delete ingress --namespace default <REPLACE_ME> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
95 changes: 15 additions & 80 deletions
95
docs/docs-content/enterprise-version/enterprise-version.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,43 @@ | ||
| --- | ||
| sidebar_label: "Self-Hosted Installation" | ||
| title: "Self-Hosted Installation" | ||
| description: "Understanding, installing and operating Spectro Cloud's Enterprise Self-Hosted variant." | ||
| sidebar_label: "Self-Hosted Palette" | ||
| title: "Self-Hosted Palette" | ||
| description: "Learn how to install and manage a self-hosted Palette environment." | ||
| hide_table_of_contents: false | ||
| sidebar_custom_props: | ||
| icon: "warehouse" | ||
| tags: ["self-hosted", "enterprise"] | ||
| --- | ||
|
|
||
|
|
||
| Palette is available as a self-hosted platform offering. You can install the self-hosted version of Palette in your data centers or public cloud providers to manage Kubernetes clusters. You can install Palette by using the following four methods: | ||
| Palette is available as a self-hosted platform offering. You can install the self-hosted version of Palette in your data centers or public cloud providers to manage Kubernetes clusters. | ||
|
|
||
| :::info | ||
|
|
||
| :::caution | ||
|
|
||
|
|
||
| Starting with Palette 4.0.0, the Palette CLI, and the Helm Chart, are the only supported methods for installing Palette. The Palette OVA installation method is only available for versions 3.4 and earlier. Refer to the [Install Enterprise Cluster](deploying-an-enterprise-cluster.md), or the [Kubernetes Install Helm Chart](deploying-palette-with-helm.md) guides for additional guidance on how to install Palette. | ||
| Palette VerteX is a FIPS-compliant version of Palette that is available for regulated industries, such as government and public sector organizations that handle sensitive and classified information. To learn more about Palette VerteX, check out the [Palette VerteX](../vertex/vertex.md) section. | ||
|
|
||
| ::: | ||
|
|
||
| - [VMware Quick Start](deploying-the-platform-installer.md) | ||
|
|
||
|
|
||
| - [VMware Enterprise](deploying-an-enterprise-cluster.md) | ||
|
|
||
|
|
||
| - [Kubernetes Install Helm Chart](deploying-palette-with-helm.md) | ||
|
|
||
|
|
||
| - [AirGap Install](air-gap-repo.md) | ||
|
|
||
| ## VMware Quick Start | ||
|
|
||
| A single-node Palette installation that is ideal for Proof of Concept (PoC) environments. Refer to the [Quick Start Installation](deploying-the-platform-installer.md) guide for more details. | ||
|
|
||
| ## VMware Enterprise | ||
|
|
||
| A highly available multi-node Palette installation that is typically used for production purposes. Check out the [Enterprise Mode](deploying-an-enterprise-cluster.md) guide to get started. | ||
|
|
||
| ## Kubernetes Install Helm Chart | ||
| ## Access Palette | ||
|
|
||
| Install Palette onto a Kubernetes cluster using a Helm Chart. Review the [Helm Chart Mode](deploying-palette-with-helm.md) guide to learn more. | ||
|
|
||
|
|
||
| ## Airgap Install | ||
|
|
||
| Palette can be installed in a VMware environment without internet access, known as an air gap installation, requiring pre-download of platform manifests, required platform packages, container images for core components, third-party dependencies, and Palette Packs, all sourced from a private rather than the default public Palette repository. | ||
|
|
||
| ## Download Palette Installer | ||
|
|
||
| To request the Palette Self-hosted installer image, please contact our support team by sending an email to [email protected]. Kindly provide the following information in your email: | ||
| To set up a Palette account, contact our support team by sending an email to [email protected]. Include the following information in your email: | ||
|
|
||
| - Your full name | ||
| - Organization name (if applicable) | ||
| - Email address | ||
| - Phone number (optional) | ||
| - A brief description of your intended use for the Palette Self-host installer image. | ||
|
|
||
| Our dedicated support team will promptly get in touch with you to provide the necessary assistance and share the installer image. | ||
|
|
||
| If you have any questions or concerns, please feel free to contact [email protected]. | ||
|
|
||
|
|
||
| ## Upgrade Notes | ||
|
|
||
| Review the [Upgrade Notes](upgrade.md) before attempting to upgrade Palette. | ||
|
|
||
|
|
||
| <br /> | ||
|
|
||
| ## Resources | ||
|
|
||
|
|
||
| * [System Requirements](on-prem-system-requirements.md) | ||
|
|
||
|
|
||
| * [Quick Start Mode](deploying-the-platform-installer.md) | ||
|
|
||
|
|
||
| * [Enterprise Mode](deploying-an-enterprise-cluster.md) | ||
|
|
||
|
|
||
| * [Helm Chart Mode](deploying-palette-with-helm.md) | ||
|
|
||
|
|
||
| * [System Console Dashboard](system-console-dashboard.md) | ||
|
|
||
|
|
||
| * [Creating a VMware Cloud Gateway](../clusters/data-center/vmware.md#install-pcg) | ||
|
|
||
|
|
||
| * [Create VMware Cloud Account](../clusters/data-center/vmware.md#create-vmware-cloud-gateway) | ||
|
|
||
|
|
||
| * [Deploy a VMware Cluster](../clusters/data-center/vmware#deploy-a-vmware-cluster) | ||
|
|
||
| - Target Platform (VMware or Kubernetes) | ||
| - A brief description of your intended use of Palette | ||
|
|
||
| * [PCG Troubleshooting](../troubleshooting/pcg.md) | ||
|
|
||
| Our dedicated Support team will promptly get in touch with you to provide the necessary credentials and assistance required to get started with self-hosted Palette. | ||
|
|
||
| * [Upgrade Notes](upgrade.md) | ||
| ## Resources | ||
|
|
||
|
|
||
| <br /> | ||
| - [Installation](install-palette/install-palette.md) | ||
|
|
||
| <br /> | ||
| - [System Management](system-management/system-management.md) | ||
|
|
||
| - [Upgrade Notes](upgrade.md) |
3 changes: 3 additions & 0 deletions
3
docs/docs-content/enterprise-version/install-palette/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 10 | ||
| } |
3 changes: 3 additions & 0 deletions
3
docs/docs-content/enterprise-version/install-palette/install-on-kubernetes/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "position": 10 | ||
| } |
Oops, something went wrong.