chore: correct wording of pxk (#4197)

* fix wording of pxk * ci: auto-formatting prettier issues * docs: more content * docs: vale suggestions --------- Co-authored-by: wcrum <wcrum@users.noreply.github.com> Co-authored-by: Karl Cardenas <karl@spectrocloud.com> Co-authored-by: Karl Cardenas <29551334+karl-cardenas-coding@users.noreply.github.com>
spectrocloud · Oct 4, 2024 · 59d0bba · 59d0bba
1 parent b3caff0
commit 59d0bba
Show file tree

Hide file tree

Showing 3 changed files with 48 additions and 37 deletions.
diff --git a/docs/deprecated/integrations/kubernetes.md b/docs/deprecated/integrations/kubernetes.md
@@ -31,16 +31,16 @@ Review our [Maintenance Policy](maintenance-policy.md) to learn about pack updat
 
 ## What is PXK?
 
-Palette eXtended Kubernetes (PXK) is a customized version of the open-source Cloud Native Computing Foundation (CNCF)
+Palette eXtended Kubernetes (PXK) is a recompiled version of the open-source Cloud Native Computing Foundation (CNCF)
 distribution of Kubernetes. This Kubernetes version can be deployed through Palette to all major infrastructure
 providers, public cloud providers, and private data center providers. This is the default distribution when deploying a
 Kubernetes cluster through Palette. You have the option to choose other Kubernetes distributions, such as MicroK8s,
 Konvoy, and more, should you want to consume a different Kubernetes distribution.
 
 PXK is different from the upstream open-source Kubernetes version primarily because of the carefully reviewed and
 applied hardening of the operating system (OS) and Kubernetes. The hardening ranges from removing unused kernel modules
-to using an OS configuration that follows industry best practices. Our custom Kubernetes configuration addresses common
-Kubernetes deployment security pitfalls and implements industry best practices.
+to using an OS configuration that follows industry best practices. Our recompiled Kubernetes configuration addresses
+common Kubernetes deployment security pitfalls and implements industry best practices.
 
 A benefit of Palette when used with PXK is the ability to apply different flavors of container storage interface (CSI)
 plugins and container network interface (CNI) plugins. Other open-source Kubernetes distributions, such as MicroK8s,
@@ -69,6 +69,14 @@ responsible for ensuring FIPS compliance and hardening of the OS.
 The combined usage of PXK and Palette VerteX provides a secure and FIPS-compliant experience as the Kubernetes
 distribution, OS, and management platform VerteX is FIPS-compliant.
 
+:::info
+
+While Palette eXtended Kubernetes is designed to work seamlessly with the Palette VerteX management plane, in the case
+Palette VerteX management plane is removed, it can be managed using standard Kubernetes tools like `kubeadm` and
+`clusterctl` without relying on Palette VerteX.
+
+:::
+
 ### Support Lifecycle
 
 We support PXK for N-3 Kubernetes minor versions for a duration of 14 months. The duration exceeds the official EOL by

diff --git a/docs/docs-content/glossary-all.md b/docs/docs-content/glossary-all.md
@@ -13,6 +13,13 @@ tags: ["glossary"]
 
 This page gives a quick reference to various object types and concepts within the Palette platform.
 
+## Agent
+
+The Palette Agent bridges the information transfer between Palette SaaS and Palette management plane. The agent collects
+information such as metrics, workloads, and heartbeats and constantly updates to the management plane. In addition to
+this, the agent is responsible for initiating and controlling Backup, OS-Patch, and Compliance Scan on the active
+cluster.
+
 ## App Mode
 
 A mode optimized for a simpler and streamlined developer experience that allows you to focus on the building,
@@ -165,23 +172,18 @@ are not part of any Palette pack or a chart. Pack manifests provide a pass-throu
 through raw manifests. Pack Manifest layers can be added to a cluster profile stack built using Spectro Packs and
 Charts.
 
-## Palette Edge Manager (Local API)
-
-A cmd line API that supports TUI operations & site diagnostics. For Dark Site or Air Gapped environments Palette Edge
-Manager can be used to upload cluster configurations.
-
 ## Palette eXtended Kubernetes (PXK)
 
-Palette eXtended Kubernetes (PXK) is a customized version of the open-source Cloud Native Computing Foundation (CNCF)
+Palette eXtended Kubernetes (PXK) is a recompiled version of the open-source Cloud Native Computing Foundation (CNCF)
 distribution of Kubernetes. This Kubernetes version can be deployed through Palette to all major infrastructure
 providers, public cloud providers, and private data center providers. This is the default distribution when deploying a
 Kubernetes cluster through Palette. You have the option to choose other Kubernetes distributions, such as MicroK8s,
 Konvoy, and more, should you want to consume a different Kubernetes distribution.
 
 PXK is different from the upstream open-source Kubernetes version primarily because of the carefully reviewed and
 applied hardening of the operating system (OS) and Kubernetes. The hardening ranges from removing unused kernel modules
-to using an OS configuration that follows industry best practices. Our custom Kubernetes configuration addresses common
-Kubernetes deployment security pitfalls and implements industry best practices.
+to using an OS configuration that follows industry best practices. Our recompiled Kubernetes configuration addresses
+common Kubernetes deployment security pitfalls and implements industry best practices.
 
 A benefit of Palette when used with PXK is the ability to apply different flavors of container storage interface (CSI)
 plugins and container network interface (CNI) plugins. Other open-source Kubernetes distributions, such as MicroK8s,
@@ -194,7 +196,7 @@ open-source Kubernetes distribution.
 
 ## Palette eXtended Kubernetes Edge (PXK-E)
 
-Palette eXtended Kubernetes Edge (PXK-E) is a customized version of the open-source Cloud Native Computing Foundation
+Palette eXtended Kubernetes Edge (PXK-E) is a recompiled version of the open-source Cloud Native Computing Foundation
 (CNCF) distribution of Kubernetes. This Kubernetes distribution is customized and optimized for edge computing
 environments and can be deployed through Palette. PXK-E is the Kubernetes distribution Palette defaults to when
 deploying Edge clusters.
@@ -206,7 +208,8 @@ posture and reduces potential attack surfaces.
 
 Another differentiator of PXK-E is the carefully reviewed and applied hardening of the OS and Kubernetes. The hardening
 ranges from removing unused OS kernel modules to using an OS configuration that follows industry best practices. Our
-custom Kubernetes configuration addresses common deployment security pitfalls and implements industry best practices.
+recompiled Kubernetes configuration addresses common deployment security pitfalls and implements industry best
+practices.
 
 With PXK-E, you can manage automatic OS upgrades while retaining immutability and the flexibility to roll out changes
 safely. The A/B partition architecture of Kairos allows for new OS and dependency versions to be installed in a separate
@@ -225,21 +228,11 @@ complexity.
 There are no changes to the Kubernetes source code used in PXK-E, and it follows the same versioning schema as the
 upstream open-source Kubernetes distribution.
 
-## Palette Orchestrator
-
-Palette orchestrator supports deploying the clusters as per the specifications desired and modeled in Palette UI.
-Furthermore, it supports the cluster version upgrades as per the user requirements. The Palette orchestrator also aids
-in recycling the certificates of the clusters, node health checks, and recycling unhealthy nodes.
+## Palette Terminal User Interface (TUI)
 
-## PaletteOS (P6OS)
-
-PaletteOS is a real-time operating system provisioned by Palette. It is embedded with a base Operating System such as
-Ubuntu, K3OS, etc., and one of the Kubernetes distributions such as CNCF (Cloud Native Computing Foundation), K3s (a
-Lightweight Kubernetes Distribution), or RKE (Rancher Kubernetes Engine). Palette builds several of these based on the
-most desired versions of the base operating system and Kubernetes distribution.
-
-**Examples**: (Ubuntu20.0.4+CNCFK8s1.21.3, SLES+K3S). We also encourage our customers to build their own Operating
-system.
+Palette TUI is a terminal user interface that allows users to configure host and network settings for their Edge hosts.
+Palette TUI is not enabled by default, and must have the `stylus.includeTui` parameter set to true for it to be enabled
+automatically.
 
 ## Palette Upgrade Controller
 
@@ -313,13 +306,6 @@ cluster profile, create a cluster, etc.
 TUI is initially used as an interface to site operator to provide site-specific settings such as NW Settings (Static IP,
 DHCP, WAN, GW, Proxy), Palette endpoint, and Device ID override. It can accept inputs from the unattended.yaml file.
 
-## Spectro Agent
-
-Spectro Agent bridges the information transfer between Palette SaaS and Palette Orchestrator. The Spectro Agent collects
-information such as metrics, workloads, and heartbeats and constantly updates to the SaaS platform for user access. In
-addition to this, the Spectro Agent is responsible for initiating and controlling Backup, OS-Patch, and Compliance Scan
-on the running cluster.
-
 ## System Administrator
 
 The self-hosted Palette or Palette VerteX user with access to the

diff --git a/docs/docs-content/integrations/kubernetes.md b/docs/docs-content/integrations/kubernetes.md
@@ -31,16 +31,16 @@ Review our [Maintenance Policy](maintenance-policy.md) to learn about pack updat
 
 ## What is PXK?
 
-Palette eXtended Kubernetes (PXK) is a customized version of the open-source Cloud Native Computing Foundation (CNCF)
+Palette eXtended Kubernetes (PXK) is a recompiled version of the open-source Cloud Native Computing Foundation (CNCF)
 distribution of Kubernetes. This Kubernetes version can be deployed through Palette to all major infrastructure
 providers, public cloud providers, and private data center providers. This is the default distribution when deploying a
 Kubernetes cluster through Palette. You have the option to choose other Kubernetes distributions, such as MicroK8s,
 Konvoy, and more, should you want to consume a different Kubernetes distribution.
 
 PXK is different from the upstream open-source Kubernetes version primarily because of the carefully reviewed and
 applied hardening of the operating system (OS) and Kubernetes. The hardening ranges from removing unused kernel modules
-to using an OS configuration that follows industry best practices. Our custom Kubernetes configuration addresses common
-Kubernetes deployment security pitfalls and implements industry best practices.
+to using an OS configuration that follows industry best practices. Our recompiled Kubernetes configuration addresses
+common Kubernetes deployment security pitfalls and implements industry best practices.
 
 A benefit of Palette when used with PXK is the ability to apply different flavors of container storage interface (CSI)
 plugins and container network interface (CNI) plugins. Other open-source Kubernetes distributions, such as MicroK8s,
@@ -58,6 +58,15 @@ We also offer Palette eXtended Kubernetes Edge (PXK-E) for Edge deployments. Ref
 
 :::
 
+### CNCF Conformance
+
+PXK is a CNCF-certified Kubernetes distribution. The CNCF certification ensures that the Kubernetes distribution
+supports the required Kubernetes APIs. You can view the official list of CNCF-certified products by visiting the
+[Certified Kubernetes Software Conformance](https://www.cncf.io/certification/software-conformance/) page. To review
+what versions of PXK are certified, refer to the official
+[Kubernetes Distributions & Platforms](https://docs.google.com/spreadsheets/d/1uF9BoDzzisHSQemXHIKegMhuythuq_GL3N1mlUUK2h0/edit?usp=sharing)
+spreadsheet maintained by the CNCF.
+
 ### PXK and Palette VerteX
 
 <!-- prettier-ignore-start -->
@@ -70,6 +79,14 @@ on the NIST-800 standard. However, if you use a different OS through the <Versio
 The combined usage of PXK and Palette VerteX provides a secure and FIPS-compliant experience as the Kubernetes
 distribution, OS, and management platform VerteX is FIPS-compliant.
 
+:::info
+
+Palette eXtended Kubernetes is optimized for the Palette or VerteX management plane. In the event that the Palette or
+VerteX management plane is removed, you can continue to manage the Kubernetes cluster through tools
+like `kubeadm` and `clusterctl` without relying on Palette or VerteX.
+
+:::
+
 ### Support Lifecycle
 
 We support PXK for N-3 Kubernetes minor versions for a duration of 14 months. The duration exceeds the official EOL by