Skip to content
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

Merged
merged 16 commits into from
Jun 10, 2024
Merged

doc(openshift): rework structure #3873

merged 16 commits into from
Jun 10, 2024

Conversation

leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Jun 3, 2024

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?

  • 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.
  • 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.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@leiicamundi leiicamundi added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed component:infex Issues related with InfEx project kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) labels Jun 3, 2024
@leiicamundi leiicamundi self-assigned this Jun 3, 2024
@leiicamundi leiicamundi requested review from Langleu and a team June 3, 2024 17:11
@christinaausley
Copy link
Contributor

@leiicamundi I ran an npm run format to resolve most of the formatting errors flagged 👍 Before I do a complete review, is this still in draft because there are additional changes incoming?

@leiicamundi leiicamundi force-pushed the feature/improve-openshift-doc branch from c69d185 to 800cca6 Compare June 4, 2024 12:39
@leiicamundi
Copy link
Contributor Author

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.

@leiicamundi leiicamundi marked this pull request as ready for review June 4, 2024 14:06
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).
Copy link
Member

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.

Copy link
Member

@Langleu Langleu Jun 5, 2024

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.

Copy link
Member

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.

Copy link
Contributor Author

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)

Copy link
Member

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.

@akeller akeller requested a review from conceptualshark June 5, 2024 15:12
Copy link
Member

@Langleu Langleu left a 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!

@akeller
Copy link
Member

akeller commented Jun 7, 2024

Looks like this is in good shape, re-requesting a review from @conceptualshark to prep for merging!

@akeller akeller requested a review from conceptualshark June 7, 2024 15:41
@akeller akeller merged commit 354b67d into main Jun 10, 2024
8 checks passed
@akeller akeller deleted the feature/improve-openshift-doc branch June 10, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:infex Issues related with InfEx project component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

7 participants