docs: Clarify Kubernetes Support Lifecycle (#2013) DOC-1018

* docs: k8s lifecycle DOC-1018 * docs: additional content * docs: updated content * docs: vale feedback * Optimised images with calibre/image-actions * docs: added version statement to k8s distros * docs: added statements about Palette VerteX * Apply suggestions from code review Co-authored-by: Adelina Simion <[email protected]> * docs: save * docs: feedback --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Adelina Simion <[email protected]>
spectrocloud · Jan 16, 2024 · 51aaad2 · 51aaad2
1 parent f4470d9
commit 51aaad2
Show file tree

Hide file tree

Showing 11 changed files with 116 additions and 5 deletions.
diff --git a/docs/docs-content/integrations/k3s.md b/docs/docs-content/integrations/k3s.md
@@ -12,6 +12,11 @@ tags: ["packs", "kubernetes", "k3s", "edge"]
 
 K3s is a lightweight distribution of Kubernetes that is specifically designed for resource-constrained environments and Internet of Things (IoT) applications. Unlike standard Kubernetes with multiple binaries for its various components, K3s is packaged as a single binary with a lightweight storage backend and minimal external dependencies. For more information about K3s, refer to [K3s documentation](https://docs.k3s.io/). 
 
+
+### Support Lifecycle
+
+We support other Kubernetes distributions such as K3s, Microk8s, and RKE2 until their official EOL. The EOL is set by the respective owner. Once we stop supporting the minor version, we initiate the deprecation process. Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md#palette-extended-kubernetes-support) guide to learn more.
+
 ## Versions Supported
 
 <Tabs queryString="versions">

diff --git a/docs/docs-content/integrations/kubernetes-edge.md b/docs/docs-content/integrations/kubernetes-edge.md
@@ -39,6 +39,17 @@ We also offer Palette eXtended Kubernetes (PXK) for cloud and data center deploy
 
 :::
 
+### PXK and Palette VerteX
+
+The PXK-E used in [Palette VerteX](../vertex/vertex.md) is compiled and linked with our [NIST-certified FIPS crypto module](../compliance.md#fips-140-2). PXK-E is by default enabled with [Ubuntu Pro](https://ubuntu.com/pro) with FIPS mode enabled. Additionally, the Operating System (OS) is hardened based on the NIST-800 standard. Refer to the [Build Edge Artifacts](../clusters/edge/edgeforge-workflow/build-artifacts.md) guide to learn more on how to build the PXK-E image with FIPS mode enabled.
+
+The combined usage of PXK-E and Palette VerteX provides a secure and FIPS-compliant experience as the Kubernetes distribution, OS, and management platform VerteX is FIPS-compliant.
+
+
+### Support Lifecycle
+
+We support PXK-E for N-3 Kubernetes minor versions for a duration of 14 months. The duration exceeds the official EOL by four months. Once we stop supporting the minor version, we initiate the deprecation process. Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md#palette-extended-kubernetes-support) guide to learn more.
+
 # Versions Supported
 
 

diff --git a/docs/docs-content/integrations/kubernetes-generic.md b/docs/docs-content/integrations/kubernetes-generic.md
@@ -10,7 +10,7 @@ logoUrl: "https://registry.spectrocloud.com/v1/k8s-dashboard/blobs/sha256:2de5d8
 tags: ["packs", "kubernetes"]
 ---
 
-The Kubernetes pack supports several cloud and data center infrastructure providers. This pack defines the default properties we use to deploy Kubernetes clusters and enables most of the Kubernetes hardening standards that the Center for Internet Security (CIS) recommends.
+The Cloud Native Computing Foundation's (CNCF) Kubernetes pack supports several cloud and data center infrastructure providers. This pack defines the default properties we use to deploy Kubernetes clusters and enables most of the Kubernetes hardening standards that the Center for Internet Security (CIS) recommends.
 
 We also support managed Kubernetes distributions for Elastic Kubernetes Service (EKS), Azure Kubernetes Service (AKS), Google Kubernetes Engine (GKE), and Tencent Kubernetes Engine (TKE). 
 
@@ -20,6 +20,10 @@ Review the [Maintenance Policy](maintenance-policy.md) to learn about pack updat
 
 <br />
 
+### Support Lifecycle
+
+We support CNCF Kubernetes for N-3 Kubernetes minor versions for a duration of 14 months. The duration exceeds the official EOL by four months. Once we stop supporting the minor version, we initiate the deprecation process. Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md#palette-extended-kubernetes-support) guide to learn more.
+
 ## Versions Supported
 
 

diff --git a/docs/docs-content/integrations/kubernetes-support.md b/docs/docs-content/integrations/kubernetes-support.md
@@ -0,0 +1,69 @@
+---
+sidebar_label: "Kubernetes Support Lifecycle"
+title: "Kubernetes Support Lifecycle"
+description: "Learn about the Kubernetes versions we support and how we manage Kubernetes support."
+icon: ""
+hide_table_of_contents: false
+sidebar_position: 10
+tags: ["packs", "support", "kubernetes", "lifecycle"]
+---
+
+
+## Overview
+
+We follow a similar lifecycle as established by the Kubernetes community. You can learn more about the official supported Cloud Native Computing Foundation (CNCF) Kubernetes release cycle in the [Kubernetes Releases](https://kubernetes.io/releases/) page. This means we support three minor Kubernetes versions at any given time. We support the current release and the three previous minor version releases, also known as N-3. For example, if the current release is 1.29, we support 1.28, 1.27, and 1.26.
+
+The table below lists the Kubernetes distributions we support and the duration of support.
+
+| Kubernetes Distribution | Supported Minor Versions | Support Duration | Notes |
+| ----------------------- | ------------------ | ---------------- | ----- |
+| CNCF Kubernetes     | N-3                | 14 months        |  The official open-source version of [Kubernetes](https://kubernetes.io/).    |
+| Palette eXtended Kubernetes (PXK) | N-3                | 14 months   | Additional support may be extended. Discuss this with our support team if you need additional support. |
+| Palette eXtended Kubernetes - Edge (PXK-E) | N-3                | 14 months        | Additional support may be extended. Discuss this with our support team if you need additional support. |
+| Other       | N-3                | EOL       | Other distributions available in Palette such as K3s, Microk8s, and RKE2, we only support until their official EOL. The EOL is set by the respective owner. |
+
+
+:::info
+
+Kubernetes follows the [semantic version schema](https://semver.org/). Versions are annotated as x.y.z, where x is the major version, y is the minor version, and z is the patch version.
+:::
+
+We support N-3 Kubernetes minor versions until the official End-Of-Life (EOL). Once we stop supporting the minor version, we initiate the deprecation process. You can learn more about our deprecation process in the [Pack Deprecation](./maintenance-policy.md#pack-deprecations) section. 
+
+
+## Palette eXtended Kubernetes Support
+
+We support CNCF Kubernetes, [Palette eXtended Kubernetes (PXK)](./kubernetes.md) and [Palette eXtended Kubernetes Edge (PXK-E)](./kubernetes-edge.md) for N-3 Kubernetes minor versions for a duration of 14 months. The duration exceeds the official EOL by four months. Once we stop supporting the minor version, we initiate the deprecation process. 
+
+The diagram below illustrates the support lifecycle of a Kubernetes version. A deprecated Kubernetes version will no longer receive updates.
+
+![Diagram of the Kubernetes Support Lifecycle. PXK and CNCF is supported for 14 months. After that, normal deprecation flow is initiated.](/integrations_kubernetes-support_support-cycle.png)
+
+Additional support may be extended for PXK and PXK-E. Discuss this with our support team if you need extended support. You can contact our support team at [[email protected]](mailto:[email protected]).
+
+## Other Kubernetes Distributions
+
+We support other Kubernetes distributions such as K3s, Microk8s, and RKE2 until their official EOL. The EOL is set by the respective owner. Once we stop supporting the minor version, we initiate the deprecation process. You can learn more about our deprecation process in the [Pack Deprecation](./maintenance-policy.md#pack-deprecations) section.
+
+
+![Diagram of other Kubernetes Support Lifecycle. Other distros are supported until their EOL. After that, normal deprecation flow is initiated.](/integrations_kubernetes-support_support-cycle_other.png)
+
+
+## Kubernetes Upgrades 
+
+The official guidelines for Kubernetes upgrades recommend upgrading one minor version at a time. For example, if you are using Kubernetes version 1.26, you should upgrade to 1.27, before upgrading to version 1.28. You can learn more about the official Kubernetes upgrade guidelines in the [Version Skew Policy](https://kubernetes.io/releases/version-skew-policy/) page. We 
+recommend following the official guidelines for all Kubernetes upgrades, including PXK and PXK-E.
+
+:::tip
+
+Use cluster profile versions to manage your Kubernetes upgrades. Create a new cluster profile version for each Kubernetes upgrade. You can then use the new cluster profile version to upgrade your cluster.
+
+:::
+
+To learn more about upgrading your cluster and cluster profiles, check out the resources below:
+
+- [Update a Cluster](../clusters/cluster-management/cluster-updates.md)
+- [Version a Cluster Profile](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md)
+
+
+We also recommend you check out  [Deploy Cluster Profile Updates](../clusters/cluster-management/update-k8s-cluster.md) tutorial to learn how to update your cluster profile.
diff --git a/docs/docs-content/integrations/kubernetes.md b/docs/docs-content/integrations/kubernetes.md
@@ -34,6 +34,17 @@ We also offer Palette eXtended Kubernetes Edge (PXK-E) for Edge deployments. Ref
 
 :::
 
+### PXK and Palette VerteX
+
+The PXK used in [Palette VerteX](../vertex/vertex.md) is compiled and linked with our [NIST-certified FIPS crypto module](../compliance.md#fips-140-2). PXK is by default enabled with [Ubuntu Pro](https://ubuntu.com/pro) with FIPS mode enabled. Additionally, the Operating System (OS) is hardened based on the NIST-800 standard. However, if you use a different OS through the [BYOOS](./byoos.md) pack, then you are 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.
+
+
+### Support Lifecycle
+
+We support PXK for N-3 Kubernetes minor versions for a duration of 14 months. The duration exceeds the official EOL by four months. Once we stop supporting the minor version, we initiate the deprecation process. Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md#palette-extended-kubernetes-support) guide to learn more.
+
 ## Versions Supported
 
 

diff --git a/docs/docs-content/integrations/maintenance-policy.md b/docs/docs-content/integrations/maintenance-policy.md
@@ -129,7 +129,7 @@ For important guidelines on updating pack versions, review [Update the Pack Vers
 
 ### Kubernetes Packs
 
-A minor Kubernetes version is deprecated in Palette when the Kubernetes community announces the version is entering End of Life (EOL). 
+Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md) page to learn about the Kubernetes versions we support and the duration of support.
 
 
 ### CNI / CSI / Add-on Packs

diff --git a/docs/docs-content/integrations/microk8s.md b/docs/docs-content/integrations/microk8s.md
@@ -12,6 +12,10 @@ tags: ['packs', 'microk8s', 'kubernetes']
 
 MicroK8s is a Cloud Native Computing Foundation (CNCF) certified upstream Kubernetes deployment that runs entirely on your workstation or edge device. It runs all Kubernetes services natively without virtual machines and packs all the required libraries and binaries.
 
+### Support Lifecycle
+
+We support other Kubernetes distributions such as K3s, Microk8s, and RKE2 until their official EOL. The EOL is set by the respective owner. Once we stop supporting the minor version, we initiate the deprecation process. Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md#palette-extended-kubernetes-support) guide to learn more.
+
 ## Prerequisites
 
 - One of the following Ubuntu environments to run commands:

diff --git a/docs/docs-content/integrations/rke2.md b/docs/docs-content/integrations/rke2.md
@@ -27,6 +27,11 @@ RKE2 launches control plane components as static pods, managed by the kubelet in
 You can deploy RKE2 by adding this pack to a cluster profile. Once the cluster profile is created, you can deploy the RKE2-based Kubernetes clusters through Palette.
 
 
+### Support Lifecycle
+
+We support other Kubernetes distributions such as K3s, Microk8s, and RKE2 until their official EOL. The EOL is set by the respective owner. Once we stop supporting the minor version, we initiate the deprecation process. Refer to the [Kubernetes Support Lifecycle](kubernetes-support.md#palette-extended-kubernetes-support) guide to learn more.
+
+
 
 ## Versions Supported
 

diff --git a/static/assets/docs/images/integrations_kubernetes-support_support-cycle.png b/static/assets/docs/images/integrations_kubernetes-support_support-cycle.png
diff --git a/static/assets/docs/images/integrations_kubernetes-support_support-cycle_other.png b/static/assets/docs/images/integrations_kubernetes-support_support-cycle_other.png
diff --git a/vale/styles/spectrocloud/spectrocloud.yml b/vale/styles/spectrocloud/spectrocloud.yml
@@ -1,16 +1,18 @@
 extends: existence
 message: "Avoid using 'spectrocloud' outside of a URL format. Use 'Spectro Cloud' instead."
 level: error
-ignorecase: true
+ignorecase: false
 nonword: true
 tokens:
-  - 'spectrocloud'
   - 'spectro cloud'
   - 'SpectroCloud'
   - 'SpectroCloud'
+  - 'Spectrocloud'
   - 'Spectro cloud'
   - 'spectro Cloud'
 scope: sentence
 exceptions:
+  - '\[mailto:[^@]*@spectrocloud\.com\]'
   - '\w*\.spectrocloud\.\w*'
-  - '\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+(?<!spectrocloud)\.[A-Za-z]{2,}\b'
+  - '@spectrocloud\.com'
+  - '\[support@spectrocloud\.com\]'