K8S supported environment statement #3888

theburi · 2024-06-05T16:21:51Z

Description

Proposal for a new K8S support statement

When should this change go live?

This is a bug fix, security concern, or something that needs urgent release support.
This is already available but undocumented and should be released within a week.
[ X ] This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
This is part of a scheduled alpha or minor. (apply alpha or minor label)
[ ] There is no urgency with this change and can be released at any time.

PR Checklist

My changes are for an already released minor and are in /versioned_docs directory.
[ x ] My changes are for the next minor and are in /docs directory (aka /next/).

My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

github-actions · 2024-06-05T16:22:16Z

👋 🤖 🤔 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.5/.

docs/reference/supported-environments.md
docs/self-managed/setup/overview.md

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.

docs/reference/supported-environments.md

docs/self-managed/setup/overview.md

maxdanilov · 2024-06-05T16:49:11Z

docs/self-managed/setup/overview.md

@@ -31,7 +31,7 @@ For details on supported environments (e.g. Java or Elasticsearch versions), see

 You have the following options to run or deploy the above components in a self-managed fashion:

- **Helm/Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. In addition to stock Kubernetes we also officially support variety of providers like Red Hat OpenShift and Amazon EKS. Also using Kubernetes with Minikube or KIND can be an interesting environment to run Camunda 8 locally on developer machines.
+- **Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported HELM charts to deploy Camunda 8 into your clusters. We suport [CNCF Certified Kubernetes disctributions](https://www.cncf.io/training/certification/software-conformance/) including a variety of providers like RedHat OpenShift and Amazon EKS. Consider using Minikube or KIND to run Camunda 8 locally on developer machines.


why do we need this part at all? wouldn't it make sense to move it into supported-environments.md and not to repeat ourselves? especially with the new headers approach I proposed for the supported-environments.md

akeller · 2024-06-05T18:12:42Z

Removed myself as a reviewer and added @conceptualshark, as we onboard them as the docs specialist for Self-Managed.

github-actions · 2024-06-06T14:42:19Z

docs/self-managed/setup/overview.md

+- **Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported HELM charts to deploy Camunda 8 into your clusters. We suport [CNCF Certified Kubernetes disctributions](https://www.cncf.io/training/certification/software-conformance/) including a variety of providers like RedHat OpenShift and Amazon EKS. Consider using [minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fmacos%2Fx86-64%2Fstable%2Fbinary+download) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start
+) to run Camunda 8 locally on developer machines.


[prettier] _{reported by reviewdog 🐶}

Suggested change

- **Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported HELM charts to deploy Camunda 8 into your clusters. We suport [CNCF Certified Kubernetes disctributions](https://www.cncf.io/training/certification/software-conformance/) including a variety of providers like RedHat OpenShift and Amazon EKS. Consider using [minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fmacos%2Fx86-64%2Fstable%2Fbinary+download) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start

) to run Camunda 8 locally on developer machines.

- **Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported HELM charts to deploy Camunda 8 into your clusters. We suport [CNCF Certified Kubernetes disctributions](https://www.cncf.io/training/certification/software-conformance/) including a variety of providers like RedHat OpenShift and Amazon EKS. Consider using [minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fmacos%2Fx86-64%2Fstable%2Fbinary+download) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start) to run Camunda 8 locally on developer machines.

maxdanilov · 2024-06-07T14:45:58Z

docs/self-managed/setup/overview.md

@@ -31,7 +31,7 @@ For details on supported environments (e.g. Java or Elasticsearch versions), see

 You have the following options to run or deploy the above components in a self-managed fashion:

- **Helm/Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. In addition to stock Kubernetes we also officially support variety of providers like Red Hat OpenShift and Amazon EKS. Also using Kubernetes with Minikube or KIND can be an interesting environment to run Camunda 8 locally on developer machines.
+- **Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported HELM charts to deploy Camunda 8 into your clusters. We suport [CNCF Certified Kubernetes distributions](https://www.cncf.io/training/certification/software-conformance/) including a variety of providers like RedHat OpenShift and Amazon EKS. Consider using [minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fmacos%2Fx86-64%2Fstable%2Fbinary+download) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start) to run Camunda 8 locally on developer machines.


see my comment in #3888 (comment) - why not to move this contents to supported-environments.md for better user experience to find the info on the same page?

I see the point, but I would like to reiterate distributions here as well. I removed "support" from this page to focus on how to run rather than on the support statement.

maxdanilov · 2024-06-07T14:47:57Z

docs/reference/supported-environments.md

@@ -47,17 +47,25 @@ We recommend running Camunda 8 Self-Managed in a Kubernetes environment. We prov

 ### Deployment options

-With the right configuration, Camunda 8 Self-Managed can be deployed on any [Certified Kubernetes](https://www.cncf.io/training/certification/software-conformance/#benefits) distribution (cloud or on-premise). However, we officially test and support a specific list of platforms.
+Camunda 8 self-managed supports the following [CNCF Certified Kubernetes distributions](https://www.cncf.io/training/certification/software-conformance/#benefits). Some distributions include custom patches or upstream source code changes. Camunda will not provide support for issues arising from these changes. The management of the Kubernetes cluster as well as underlying infrastructure, remains your responsibility; we do not offer direct support for these components.


why this paragraph is not moved to Kuberentes block below? it only applies to Kubernetes flavor of installation and Deployment options in general

akeller · 2024-07-01T19:01:50Z

@theburi, what's the status of this PR? Do you need help cleaning it up and/or backporting it? Since there is no link in the description to a supporting issue or epic, I'm not sure how to help.

akeller · 2024-08-06T22:14:49Z

@theburi do you need help with this PR?

theburi · 2024-08-07T08:54:53Z

@akeller Could we hold this PR? I use it as a doc to approve this new statement.

docs/self-managed/setup/overview.md

akeller · 2024-08-07T14:30:24Z

@akeller Could we hold this PR? I use it as a doc to approve this new statement.

Yes, absolutely @theburi! I just don't want you to forget about it or have to suffer through many merge conflicts 😄.

akeller · 2024-08-16T16:35:39Z

Checking in on open PRs - we'll want to merge this well before our minor release, particularly so it unblocks #4049. @theburi please consider merging this next week and opening a new, smaller PR if you want to iterate on the content.

conceptualshark · 2024-08-21T14:02:13Z

Confirmed this is still pending/on hold and will be rebased after appropriate internal approvals.

pierre-yves-monnet

Just a simple comment

pierre-yves-monnet · 2024-09-09T22:46:28Z

docs/self-managed/setup/overview.md

"like RedHat, OpenShift, and Amazon EKS. " : if you start to list providers, you should be complete, add Google and Azure.

Would you read this as a comprehensive list? (this is just an example)

ManuelDittmar · 2024-09-13T10:20:33Z

docs/self-managed/setup/overview.md

@@ -31,8 +31,10 @@ For details on supported environments (e.g. Java or Elasticsearch versions), see

 You have the following options to run or deploy the above components in a self-managed fashion:

- **Helm/Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. In addition to stock Kubernetes we also officially support variety of providers like Red Hat OpenShift and Amazon EKS. Also using Kubernetes with Minikube or KIND can be an interesting environment to run Camunda 8 locally on developer machines.
+- **Kubernetes**: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported Helm charts to deploy Camunda 8 into your [CNCF Certified Kubernetes](https://www.cncf.io/training/certification/software-conformance/) clusters, including a variety of providers like RedHat, OpenShift, and Amazon EKS. Consider using [minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fmacos%2Fx86-64%2Fstable%2Fbinary+download) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start) to run Camunda 8 locally on developer machines.


"We provide supported Helm charts to deploy Camunda 8 into your CNCF Certified Kubernetes clusters, including a variety of providers like RedHat, OpenShift, and Amazon EKS." I would probably not list the vendors here, as you can find them also in the linked resource of CNCF. Also, besides OpenShift, we also don't have any vendor specifics in the helm chart. For AKS,EKS and GCP we provide guides how to configure the helm chart correctly via the value file.

We list the most popular distributions that we test to give customers a bit more understanding of what do we mean. This is why we provide examples: "like Red Hat OpenShift and Amazon EKS" and not a comprehensive list.

christinaausley · 2024-09-24T18:53:32Z

@theburi Are you looking for additional review here, or is this ready to merge? Looks like there may be a few conflicts.

christinaausley · 2024-11-19T20:17:46Z

@theburi is this still applicable or has this gone stale?

christinaausley · 2024-12-09T15:40:24Z

@theburi Can you please provide a status update for this PR?

theburi requested a review from akeller June 5, 2024 16:21

theburi requested review from maxdanilov, aabouzaid, felix-mueller, hisImminence and daniel-ewing June 5, 2024 16:22

theburi added the hold This issue is parked, do not merge. label Jun 5, 2024

maxdanilov requested changes Jun 5, 2024

View reviewed changes

akeller requested review from conceptualshark and removed request for akeller June 5, 2024 18:11

github-actions bot reviewed Jun 6, 2024

View reviewed changes

maxdanilov requested changes Jun 7, 2024

View reviewed changes

aabouzaid previously approved these changes Jun 25, 2024

View reviewed changes

christinaausley dismissed aabouzaid’s stale review via 731de55 June 26, 2024 10:17

christinaausley assigned theburi Jun 26, 2024

hisImminence reviewed Aug 7, 2024

View reviewed changes

docs/self-managed/setup/overview.md Show resolved Hide resolved

K8S supported environment statement

7ca7c3b

theburi force-pushed the k8s-supported-platforms branch from c2830b4 to 7ca7c3b Compare August 14, 2024 16:20

conceptualshark mentioned this pull request Aug 15, 2024

Restructure/reorganize content in SM introduction pages #4049

Merged

9 tasks

akeller added the component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed label Aug 15, 2024

pierre-yves-monnet reviewed Sep 9, 2024

View reviewed changes

ManuelDittmar reviewed Sep 13, 2024

View reviewed changes

aabouzaid approved these changes Sep 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

K8S supported environment statement #3888

K8S supported environment statement #3888

theburi commented Jun 5, 2024

github-actions bot commented Jun 5, 2024

maxdanilov Jun 5, 2024 •

edited

Loading

akeller commented Jun 5, 2024

github-actions bot Jun 6, 2024

maxdanilov Jun 7, 2024

theburi Jun 7, 2024

maxdanilov Jun 7, 2024

akeller commented Jul 1, 2024

akeller commented Aug 6, 2024

theburi commented Aug 7, 2024

akeller commented Aug 7, 2024

akeller commented Aug 16, 2024

conceptualshark commented Aug 21, 2024

pierre-yves-monnet left a comment

pierre-yves-monnet Sep 9, 2024

theburi Sep 13, 2024

ManuelDittmar Sep 13, 2024

theburi Sep 13, 2024

christinaausley commented Sep 24, 2024 •

edited

Loading

christinaausley commented Nov 19, 2024

christinaausley commented Dec 9, 2024

		- Kubernetes: We strongly recommend using Kubernetes to run Camunda 8 in production. We provide supported HELM charts to deploy Camunda 8 into your clusters. We suport [CNCF Certified Kubernetes disctributions](https://www.cncf.io/training/certification/software-conformance/) including a variety of providers like RedHat OpenShift and Amazon EKS. Consider using [minikube](https://minikube.sigs.k8s.io/docs/start/?arch=%2Fmacos%2Fx86-64%2Fstable%2Fbinary+download) or [kind](https://kind.sigs.k8s.io/docs/user/quick-start
		) to run Camunda 8 locally on developer machines.

K8S supported environment statement #3888

Are you sure you want to change the base?

K8S supported environment statement #3888

Conversation

theburi commented Jun 5, 2024

Description

When should this change go live?

PR Checklist

github-actions bot commented Jun 5, 2024

maxdanilov Jun 5, 2024 • edited Loading

Choose a reason for hiding this comment

akeller commented Jun 5, 2024

github-actions bot Jun 6, 2024

Choose a reason for hiding this comment

maxdanilov Jun 7, 2024

Choose a reason for hiding this comment

theburi Jun 7, 2024

Choose a reason for hiding this comment

maxdanilov Jun 7, 2024

Choose a reason for hiding this comment

akeller commented Jul 1, 2024

akeller commented Aug 6, 2024

theburi commented Aug 7, 2024

akeller commented Aug 7, 2024

akeller commented Aug 16, 2024

conceptualshark commented Aug 21, 2024

pierre-yves-monnet left a comment

Choose a reason for hiding this comment

pierre-yves-monnet Sep 9, 2024

Choose a reason for hiding this comment

theburi Sep 13, 2024

Choose a reason for hiding this comment

ManuelDittmar Sep 13, 2024

Choose a reason for hiding this comment

theburi Sep 13, 2024

Choose a reason for hiding this comment

christinaausley commented Sep 24, 2024 • edited Loading

christinaausley commented Nov 19, 2024

christinaausley commented Dec 9, 2024

maxdanilov Jun 5, 2024 •

edited

Loading

christinaausley commented Sep 24, 2024 •

edited

Loading