Clarify Kubernetes Support Lifecycle #2013

karl-cardenas-coding · 2024-01-11T19:51:19Z

Describe the Change

This PR adds information about our support life cycle for Kubernetes.

Review Changes

netlify · 2024-01-11T19:51:25Z

✅ Deploy Preview for docs-spectrocloud ready!

Name	Link
🔨 Latest commit	`ec53df5`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-spectrocloud/deploys/65a6bf2c176f87000860a7b9
😎 Deploy Preview	https://deploy-preview-2013--docs-spectrocloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

…olicy

docs/docs-content/integrations/kubernetes-support.md

github-actions · 2024-01-16T15:37:39Z

Images automagically compressed by Calibre's image-actions ✨

Compression reduced images by 35.9%, saving 53.23 KB.

Filename	Before	After	Improvement	Visual comparison
`static/assets/docs/images/integrations_kubernetes-support_support-cycle_other.png`	71.56 KB	45.24 KB	-36.8%	View diff
`static/assets/docs/images/integrations_kubernetes-support_support-cycle.png`	76.52 KB	49.62 KB	-35.2%	View diff

585 images did not require optimisation.

…8s-policy

addetz

Tiny comments 🚀

docs/docs-content/integrations/kubernetes-support.md

docs/docs-content/integrations/kubernetes.md

docs/docs-content/integrations/microk8s.md

docs/docs-content/integrations/rke2.md

docs/docs-content/integrations/kubernetes-support.md

docs/docs-content/integrations/kubernetes-generic.md

docs/docs-content/integrations/k3s.md

docs/docs-content/integrations/kubernetes-edge.md

docs/docs-content/integrations/kubernetes.md

Co-authored-by: Adelina Simion <[email protected]>

…8s-policy

* 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]> (cherry picked from commit 51aaad2)

vault-token-factory-spectrocloud · 2024-01-16T17:56:14Z

💔 Some backports could not be created

Status	Branch	Result
❌	version-4-0	Backport failed because of merge conflicts
❌	version-3-4	Backport failed because of merge conflicts You might need to backport the following PRs to version-3-4: - Refactor/restructure cluster & app profiles sections (#1551) - docs: updated URLs to use file path context
❌	version-4-1	Backport failed because of merge conflicts
✅	version-4-2

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

backport --pr 2013

Questions ?

Please refer to the Backport tool documentation and see the Github Action logs for details

yuliiiah

I've made suggestions on structure, word usage, and some other small things. Hope it's helpful, and congrats on the doc 🎉

yuliiiah · 2024-01-16T17:14:13Z

docs/docs-content/integrations/k3s.md

+
+### 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. You can learn more about our Kubernetes support lifecycle in the [Kubernetes Support Lifecycle](./kubernetes-support.md#other-kubernetes-distributions) page.


It should be "on the Kubernetes Support Lifecycle page." Reference.

yuliiiah · 2024-01-16T17:26:03Z

docs/docs-content/integrations/kubernetes-support.md

+
+## 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.


I'd want to simplify this, as in:

Our support for Kubernetes aligns with the official Kubernetes release cycle. Meaning that at any given time, we support the current Kubernetes 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.

yuliiiah · 2024-01-16T17:27:50Z

docs/docs-content/integrations/kubernetes-support.md

+---
+sidebar_label: "Kubernetes Support Lifecycle"
+title: "Kubernetes Support Lifecycle"
+description: "Learn about the Kubernetes versions we support and how we manage Kubernetes support."


I'd want to avoid repetition here:

Learn how we support the Kubernetes Lifecycle.

yuliiiah · 2024-01-16T17:30:36Z

docs/docs-content/integrations/kubernetes-support.md

+
+:::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.


Should this be semantic versioning schema? Also, for me it would make sense to emphasize versioning notation with bold, as in:

** x.y.z**, where x is..., y is..., and z is...

yuliiiah · 2024-01-16T17:38:41Z

docs/docs-content/integrations/kubernetes-support.md

+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. 


Since we don't stop supporting a specific version, but rather a version, it feels like "a" would be more appropriate here. Also, to me deprecation is a process, so it feels a bit redundant to add "process" here.

Once we stop supporting a minor version, we initiate its deprecation.

yuliiiah · 2024-01-16T17:54:14Z

docs/docs-content/integrations/kubernetes-support.md

+
+## 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.


Once we stop supporting the minor version, we initiate the deprecation process. You can learn more about our deprecation process in the Pack Deprecation section.

This also repeats what you've mentioned in the Overview section. Maybe, consider making it an admonition that calls attention to this process for all Kubernetes versions and distros?

yuliiiah · 2024-01-16T17:56:48Z

docs/docs-content/integrations/kubernetes-support.md

+
+## 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 


Is it possible to add a link here? Especially given that we're explicitly recommending readers to follow these guidelines.

The official guidelines for Kubernetes upgrades

yuliiiah · 2024-01-16T17:58:10Z

docs/docs-content/integrations/kubernetes-support.md

+:::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.
+
+:::


This tip feels disconnected from the previous paragraph and the section overall. What was your intention behind it?

yuliiiah · 2024-01-16T17:58:38Z

docs/docs-content/integrations/kubernetes-support.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.


We also recommend you check out the Deploy Cluster Profile Updates tutorial to learn how to update your cluster profile.

yuliiiah · 2024-01-16T17:59:41Z

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.


With spelling out Operating System – do we expect that people who read this doc won't know what OS stands for?

* 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]> (cherry picked from commit 51aaad2) Co-authored-by: Karl Cardenas <[email protected]>

* 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]>

* 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]> * docs: fixed merge conflicts * Optimised images with calibre/image-actions --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Adelina Simion <[email protected]>

* 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]>

* 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 * 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]>

vault-token-factory-spectrocloud · 2024-04-05T22:48:24Z

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

vault-token-factory-spectrocloud · 2024-04-06T06:02:24Z

🎉 This PR is included in version 4.2.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

docs: k8s lifecycle DOC-1018

836e8ba

karl-cardenas-coding added backport-version-4-0 Backport change to version 4.0 auto-backport Enable backport backport-version-3-4 Backport change to version 3.4 backport-version-4-1 Backport change to version 4.1 backport-version-4-2 Backport change to version 4.2 labels Jan 11, 2024

karl-cardenas-coding added 5 commits January 11, 2024 12:55

Merge branch 'master' into k8s-policy

a6ccb1e

docs: additional content

a090145

Merge branch 'master' of github.com:spectrocloud/librarium into k8s-p…

05c305a

…olicy

docs: updated content

ba50cca

Merge branch 'master' into k8s-policy

d41ceab

karl-cardenas-coding marked this pull request as ready for review January 16, 2024 14:57

karl-cardenas-coding requested a review from a team as a code owner January 16, 2024 14:57

karl-cardenas-coding requested review from yuliiiah, lennessyy and caroldelwing January 16, 2024 14:57

github-actions bot reviewed Jan 16, 2024

View reviewed changes

karl-cardenas-coding and others added 2 commits January 16, 2024 08:33

docs: vale feedback

4a7ca3a

Optimised images with calibre/image-actions

88a017e

karl-cardenas-coding added 2 commits January 16, 2024 08:46

docs: added version statement to k8s distros

6d3d0b5

Merge branch 'k8s-policy' of github.com:spectrocloud/librarium into k…

18730ac

…8s-policy

addetz approved these changes Jan 16, 2024

View reviewed changes

docs: added statements about Palette VerteX

6771ead

github-actions bot reviewed Jan 16, 2024

View reviewed changes

docs/docs-content/integrations/kubernetes-edge.md Show resolved Hide resolved

docs/docs-content/integrations/kubernetes.md Show resolved Hide resolved

karl-cardenas-coding and others added 4 commits January 16, 2024 10:36

Apply suggestions from code review

82a6d94

Co-authored-by: Adelina Simion <[email protected]>

docs: save

a3d2e88

Merge branch 'k8s-policy' of github.com:spectrocloud/librarium into k…

9b154b2

…8s-policy

docs: feedback

ec53df5

karl-cardenas-coding merged commit 51aaad2 into master Jan 16, 2024
10 checks passed

karl-cardenas-coding deleted the k8s-policy branch January 16, 2024 17:55

vault-token-factory-spectrocloud bot mentioned this pull request Jan 16, 2024

[version-4-2] docs: Clarify Kubernetes Support Lifecycle (#2013) DOC-1018 #2045

Merged

yuliiiah approved these changes Jan 16, 2024

View reviewed changes

karl-cardenas-coding mentioned this pull request Jan 16, 2024

[version-3-4]Backport/version 3 4/pr 2013 #2046

Merged

karl-cardenas-coding mentioned this pull request Jan 16, 2024

[version-4-0] docs: Clarify Kubernetes Support Lifecycle (#2013) DOC-1018 #2048

Merged

karl-cardenas-coding mentioned this pull request Jan 16, 2024

[version-4-1]docs: Clarify Kubernetes Support Lifecycle (#2013) DOC-1018 #2049

Merged

vault-token-factory-spectrocloud bot added the released label Apr 5, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clarify Kubernetes Support Lifecycle #2013

Clarify Kubernetes Support Lifecycle #2013

karl-cardenas-coding commented Jan 11, 2024 •

edited

Loading

netlify bot commented Jan 11, 2024 •

edited

Loading

github-actions bot commented Jan 16, 2024

addetz left a comment

vault-token-factory-spectrocloud bot commented Jan 16, 2024

yuliiiah left a comment

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

yuliiiah Jan 16, 2024

vault-token-factory-spectrocloud bot commented Apr 5, 2024

vault-token-factory-spectrocloud bot commented Apr 6, 2024


		### 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. You can learn more about our Kubernetes support lifecycle in the [Kubernetes Support Lifecycle](./kubernetes-support.md#other-kubernetes-distributions) page.


		## 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.


		:::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.


		## 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.


		## 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

		- [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.

Clarify Kubernetes Support Lifecycle #2013

Clarify Kubernetes Support Lifecycle #2013

Conversation

karl-cardenas-coding commented Jan 11, 2024 • edited Loading

Describe the Change

Review Changes

netlify bot commented Jan 11, 2024 • edited Loading

✅ Deploy Preview for docs-spectrocloud ready!

github-actions bot commented Jan 16, 2024

addetz left a comment

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Jan 16, 2024

💔 Some backports could not be created

Manual backport

Questions ?

yuliiiah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vault-token-factory-spectrocloud bot commented Apr 5, 2024

vault-token-factory-spectrocloud bot commented Apr 6, 2024

karl-cardenas-coding commented Jan 11, 2024 •

edited

Loading

netlify bot commented Jan 11, 2024 •

edited

Loading