Kubernetes supported platforms #3381
Conversation
theburi
requested review from
akeller,
aabouzaid,
felix-mueller and
hisImminence
|
👋 🤖 🤔 Hello! Did you make your changes in all the right places? These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.4/.
You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
docs/self-managed/platform-deployment/helm-kubernetes/overview.md
Outdated
Show resolved
Hide resolved
|
|
||
| ## Officially supported platforms | ||
|
|
||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). However, we officially test and support a [specific list of platforms](./platforms/platforms.md). | ||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). |
There was a problem hiding this comment.
[prettier] reported by reviewdog 🐶
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). | |
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). | |
| @@ -9,7 +9,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; | |||
|
|
|||
| [Deploying Camunda 8 using Helm charts](../deploy.md) will work for all platforms and distributions. However, each platform or cloud provider may have special prerequisites or pitfalls to avoid. This section highlights important notes for a smooth Camunda 8 deployment on different Kubernetes platforms. | |||
|
|
|||
| In addition to Stock Kubernetes (which could be deployed on cloud or on-premise), Camunda only officially tests and supports the following platforms: | |||
| In addition to [CNCF Certified Kubernetes distributions](https://www.cncf.io/training/certification/software-conformance/) (which could be deployed on cloud or on-premise), Camunda only officially tests the following platforms: | |||
There was a problem hiding this comment.
Stock Kubernetes (or better let's call it upstream Kubernetes) is the parent of all CNCF Certified Kubernetes distributions. So we need to mention both.
christinaausley
added
the
component:self-managed
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
|
|
||
| ## Officially supported platforms | ||
|
|
||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). However, we officially test and support a [specific list of platforms](./platforms/platforms.md). | ||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). |
There was a problem hiding this comment.
I'd specify here a link to the supported k8s versions to avoid confusion (not just any Kubernetes distribution)
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). However, we officially test and support a [specific list of platforms](./platforms/platforms.md). | ||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). | ||
| - Camunda 8 self-managed supports the following [CNCF Certified Kubernetes distributions](https://www.cncf.io/training/certification/software-conformance/). Some distributions include custom patches or upstream source code changes. Camunda will not provide support for issues arising from these changes. | ||
| - We test and validate a [limited list of platforms](./platforms/platforms.md). |
There was a problem hiding this comment.
Does the fact that we test on a limited set of k8s distributions make a difference to the customer?
There was a problem hiding this comment.
We need to be super clear about this. What do we test on, and what do we assume it will run on?
We have pending changes on the Supported Environments page to address clarity in exactly what will get our support. If we say we test and validate on a limited list of platforms, let's name those explicitly.
|
I see there are a few discussions on this PR - @theburi can you work to resolve these? With the alpha release next week, we should try to get these wrapped up and the PR merged. |
|
@theburi Let me know if I can assist here before release tomorrow. Can you link to the related issues or epics, and label according to the versioned release? |
|
Hi. We are not going to release this PR in this alpha. We did not ade a decision to make these changes. |
|
@theburi Will this go out with release next week? |
|
@christinaausley No. This content is not finalized yet. |
|
If you decide to keep this issue open and clean it up, please get in touch with @conceptualshark for technical writing assistance. Thanks! |
|
|
||
| ## Officially supported platforms | ||
|
|
||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). However, we officially test and support a [specific list of platforms](./platforms/platforms.md). | ||
| With the right configuration, Camunda 8 Self-Managed can be deployed on any Kubernetes distribution (Cloud or on-premise). | ||
| - Camunda 8 self-managed supports the following [CNCF Certified Kubernetes distributions](https://www.cncf.io/training/certification/software-conformance/). Some distributions include custom patches or upstream source code changes. Camunda will not provide support for issues arising from these changes. |
There was a problem hiding this comment.
I think above statement is bit confusing and contradicting. First it says that it supports the CNCF certified K8s Distro but then it also says Camunda will not provide support for issues arising from these changes.
- Can we move this part to another section may be something like "Compatible Platforms” and keep only tested platforms under "Officially supported platforms” section for better clarity?
- Does it make sense to change the statement to following?
Camunda 8 self-managed is compatible with the following [CNCF Certified Kubernetes distributions](https://www.cncf.io/training/certification/software-conformance/).”
Description
Proposed changes to support certified K8s distributions and improve clarity of what is supported
When should this change go live?
holdlabel or convert to draft PR)?PR Checklist
/versioned_docsdirectory, or they are not for an already released version./docsdirectory (aka/next/), or they are not for future versions.