docs(self-managed): update OpenShift routes instructions #3997

hamza-m-masood · 2024-06-27T16:42:53Z

Description

Related issue: https://github.com/camunda/distribution/issues/253
This PR updates the OpenShift routes page for 8.5.

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/).

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-27T16:43:19Z

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md

hamza-m-masood · 2024-06-27T18:44:17Z

The connector changes are only being added to 8.5 since within 8.6, zeebe gateway will have full support for rest. I will then open another PR to recommend the customer to use rest in zeebe gateway when openshift routes are configured. I can only create that PR once I have tested 8.6 zeebe.

leiicamundi

lgtm, I'll try the setup instructions later

good work, wp :)

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md

leiicamundi · 2024-06-28T06:37:27Z

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md

+
+```bash
+#grab OpenShift generated tls crt
+kubectl get secret -n camunda camunda-zeebe-gateway -o jsonpath="{.data['tls\.crt']}" | base64 --decode > tls.crt


As discussed in https://github.com/camunda/distribution/issues/254#issuecomment-2196227345, could we integrate this directly at the startup of the container?

@conceptualshark We continued our discussion and noticed that instead we should put a reference to a github issue in the docs: camunda/connectors#2806

Is it a good idea to put a link to a github issue in the docs or should I just mention that we are working on a fix that will not require this manual workaround and not add a link?

For now I will add a link and you can remove it if you think it's not appropriate.

added link to github issue ✅

I think this reference is fine - we can make a note to remove it once the issue is closed.

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md

hamza-m-masood · 2024-06-28T14:42:33Z

@conceptualshark Please wait for @aabouzaid to approve the PR before you start your review. Thanks.

leiicamundi

I checked both the content and the rendering, looks good!
nice work @hamza-m-masood 🚀

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md

akeller · 2024-07-01T14:27:49Z

This PR updates the OpenShift routes page for 8.5.

Is there anything in this PR that should be ported to 8.6 (/next/)?

aabouzaid · 2024-07-01T16:20:47Z

@akeller No change in the content, so Hamza will copy the same content to other versions once all reviewers are done.

christinaausley · 2024-07-03T13:27:57Z

docs/self-managed/setup/deploy/openshift/redhat-openshift.md

@@ -157,7 +157,7 @@ If you deploy Camunda 8 (and related infrastructure) with permissive SCCs out of

 ## Ingress Configuration

-Before exposing services outside the cluster, we need an ingress component. Here's how you can configure it:
+Before exposing services outside the cluster, we need an Ingress component. Here's how you can configure it:


I don't think we're consistent with ingress/Ingress casing across our docs. @conceptualshark WDYT? Do you think this warrants an issue for the backlog? Would you like to take a look at this across the SM docs?

👍 I can spin something off to go through this. I think the capitalization does a lot of work here.

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md

aabouzaid

LGTM, thank you 👍

hamza-m-masood · 2024-07-18T10:59:41Z

@conceptualshark I am ready for your review. Thanks for waiting.
Please feel free to merge the PR when you are happy.

Langleu · 2024-07-18T13:34:58Z

@hamza-m-masood I'm curious whether there's anything in place that regularly tests what's described in the docs?
So we don't get surprised by either OpenShift or Camunda changes.

hamza-m-masood · 2024-07-18T14:02:28Z

Hi @Langleu good question! I have a PR for getting routes working on our CI. It's currently on pause at the moment because of the reasons listed in the PR. I will start working on it again when the routes operator is functional in our OpenShfit CI cluster.

Langleu · 2024-07-18T14:11:31Z

awesome, great to see!

christinaausley · 2024-07-22T15:34:49Z

@hamza-m-masood Ready to merge here, or waiting on additional review?

conceptualshark

I made a few formatting adjustments that should hopefully improve readability, and updated a few lines. If these changes work for you, this is good to go from me, so I'm preemptively approving. 👍

hamza-m-masood · 2024-07-23T12:19:36Z

@conceptualshark I'm happy with the changes you made. Looks great!
@christinaausley Please feel free to merge.

changes for routes

6c710f6

hamza-m-masood requested a review from conceptualshark June 27, 2024 16:43

hamza-m-masood commented Jun 27, 2024

View reviewed changes

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md Outdated Show resolved Hide resolved

hamza-m-masood self-assigned this Jun 27, 2024

fix indentation

cf9835b

leiicamundi self-requested a review June 28, 2024 06:25

leiicamundi requested changes Jun 28, 2024

View reviewed changes

hamza-m-masood added 3 commits June 28, 2024 15:32

fixed link

29864a0

added github issue link

625e71f

fix spelling error

1798e4e

hamza-m-masood marked this pull request as ready for review June 28, 2024 14:41

hamza-m-masood requested a review from aabouzaid June 28, 2024 14:42

leiicamundi previously approved these changes Jun 28, 2024

View reviewed changes

christinaausley requested review from christinaausley June 28, 2024 14:50

christinaausley added component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Jun 28, 2024

reword

abff907

hamza-m-masood dismissed leiicamundi’s stale review via abff907 June 28, 2024 15:03

aabouzaid requested changes Jun 28, 2024

View reviewed changes

hamza-m-masood added 7 commits June 28, 2024 16:16

reword

878d697

pkcs

a968bac

cert to certificate

d81b1b6

ingress

8139970

jks

7a2d969

adding space in pkcs

d8ee383

change ns

436fa1d

hamza-m-masood added 2 commits June 28, 2024 16:35

reworded comments

87d1ee8

changed placeholders to default names

2cd6048

akeller added the target:8.5 label Jul 1, 2024

aabouzaid changed the title ~~feat: changes for routes~~ docs(self-managed): update OpenShift routes instructions Jul 1, 2024

akeller removed the target:8.5 label Jul 1, 2024

hamza-m-masood added 3 commits July 2, 2024 13:25

added changes to 8.6

012ea64

added full stops

6746f11

added in space at start of comments

68ffca6

christinaausley reviewed Jul 3, 2024

View reviewed changes

christinaausley and others added 2 commits July 3, 2024 09:35

style(formatting): minor grammatical tweaks

bbf451a

add space after the commit hash

79e7bb0

hamza-m-masood requested a review from aabouzaid July 3, 2024 17:47

hamza-m-masood commented Jul 3, 2024

View reviewed changes

versioned_docs/version-8.5/self-managed/setup/deploy/openshift/redhat-openshift.md Outdated Show resolved Hide resolved

leiicamundi requested a review from Langleu July 16, 2024 12:08

adding back spaces to comments

8d27b9c

aabouzaid previously approved these changes Jul 18, 2024

View reviewed changes

formatting and copyedits

8dbc2c2

conceptualshark dismissed aabouzaid’s stale review via 8dbc2c2 July 22, 2024 15:53

conceptualshark approved these changes Jul 22, 2024

View reviewed changes

Merge branch 'main' into routes-modification

d4e905c

christinaausley merged commit 4370d92 into main Jul 23, 2024
7 checks passed

christinaausley deleted the routes-modification branch July 23, 2024 13:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(self-managed): update OpenShift routes instructions #3997

docs(self-managed): update OpenShift routes instructions #3997

hamza-m-masood commented Jun 27, 2024

github-actions bot commented Jun 27, 2024 •

edited

Loading

hamza-m-masood commented Jun 27, 2024 •

edited

Loading

leiicamundi left a comment

leiicamundi Jun 28, 2024

hamza-m-masood Jun 28, 2024

hamza-m-masood Jun 28, 2024

conceptualshark Jul 22, 2024

hamza-m-masood commented Jun 28, 2024

leiicamundi left a comment

akeller commented Jul 1, 2024

aabouzaid commented Jul 1, 2024

christinaausley Jul 3, 2024

conceptualshark Jul 15, 2024

aabouzaid left a comment

hamza-m-masood commented Jul 18, 2024 •

edited

Loading

Langleu commented Jul 18, 2024

hamza-m-masood commented Jul 18, 2024

Langleu commented Jul 18, 2024

christinaausley commented Jul 22, 2024

conceptualshark left a comment

hamza-m-masood commented Jul 23, 2024

docs(self-managed): update OpenShift routes instructions #3997

docs(self-managed): update OpenShift routes instructions #3997

Conversation

hamza-m-masood commented Jun 27, 2024

Description

When should this change go live?

PR Checklist

github-actions bot commented Jun 27, 2024 • edited Loading

hamza-m-masood commented Jun 27, 2024 • edited Loading

leiicamundi left a comment

Choose a reason for hiding this comment

leiicamundi Jun 28, 2024

Choose a reason for hiding this comment

hamza-m-masood Jun 28, 2024

Choose a reason for hiding this comment

hamza-m-masood Jun 28, 2024

Choose a reason for hiding this comment

conceptualshark Jul 22, 2024

Choose a reason for hiding this comment

hamza-m-masood commented Jun 28, 2024

leiicamundi left a comment

Choose a reason for hiding this comment

akeller commented Jul 1, 2024

aabouzaid commented Jul 1, 2024

christinaausley Jul 3, 2024

Choose a reason for hiding this comment

conceptualshark Jul 15, 2024

Choose a reason for hiding this comment

aabouzaid left a comment

Choose a reason for hiding this comment

hamza-m-masood commented Jul 18, 2024 • edited Loading

Langleu commented Jul 18, 2024

hamza-m-masood commented Jul 18, 2024

Langleu commented Jul 18, 2024

christinaausley commented Jul 22, 2024

conceptualshark left a comment

Choose a reason for hiding this comment

hamza-m-masood commented Jul 23, 2024

github-actions bot commented Jun 27, 2024 •

edited

Loading

hamza-m-masood commented Jun 27, 2024 •

edited

Loading

hamza-m-masood commented Jul 18, 2024 •

edited

Loading