-
Notifications
You must be signed in to change notification settings - Fork 193
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc(openshift): rework structure #3873
Conversation
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
@leiicamundi I ran an |
c69d185
to
800cca6
Compare
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Show resolved
Hide resolved
Hello @christinaausley, Thank you for running the linter. The PR was in draft because it needed some adjustments. It is now ready for review (cc @Langleu). Please note that the change in the versions referenced as supported in the documentation is related to the versions we are now testing, linked to camunda/camunda-platform-helm#1816. For versions 4.12 and 4.13, support ends according to https://access.redhat.com/support/policy/updates/openshift on July 17, 2024 (Maintenance support ends) for 4.12 and November 17, 2024 for 4.13 : we do not have tested them since a while but we continue to support them until the indicated EOL. |
To deploy Camunda 8 on OpenShift, please follow these installation steps: | ||
|
||
1. Install [Helm and other CLI tools](/self-managed/setup/install.md#prerequisites). | ||
2. Ensure that `bash` and `sed` are available locally, as they are necessary for the [post-rendering process to patch the values of OpenShift](https://github.com/camunda/camunda-platform-helm/blob/main/charts/camunda-platform/openshift/patch.sh). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should we be more specific on sed?
The one on mac can be very different to whatever one find on e.g. debian.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
haven't tried it out yet whether it works the same on both mac and linux as the mac sed can be limited. Meaning maybe it doesn't matter too much.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just tried it out, with mac sed it doesn't do anything not even throw an error and the values were still present.
On debian / Linux whatever gnu sed, worked correctly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching this @Langleu!
I've suggested a fix in camunda/camunda-platform-helm#1970, but it won't be effective until the next release of the Helm chart. Should we add a tooltip indicating that this feature will only work from the next release of our chart?
Additionally, I propose an alternative approach to eliminate the need for the post-render script altogether by utilizing a flag in the source control configuration (SCC) to remove the attribute. This would simplify the process for end-users, as demonstrated in the provided example here.
Should we explore in the flag-based solution? (cc @maxdanilov @hamza-m-masood)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From my perspective camunda/camunda-platform-helm#1970 released would be the right approach.
versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the tab approach 👍.
I only had look at next
as I assume 8.5
is just copy / paste.
Left some comments but overall looks a lot cleaner!
Looks like this is in good shape, re-requesting a review from @conceptualshark to prep for merging! |
Description
This PR adds documentation for configuring Ingress for Camunda 8 deployment on OpenShift. It provides instructions for both using Kubernetes Ingress and OpenShift Routes, along with prerequisites and considerations for each method. This documentation aims to guide users in exposing Camunda 8 services externally and ensuring proper setup for ingress components.
This work is related to https://github.com/camunda/team-infrastructure-experience/issues/239
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).