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

docs: document reverse proxy config for job streams #4018

Merged
merged 10 commits into from
Aug 5, 2024

Conversation

npepinpe
Copy link
Member

@npepinpe npepinpe commented Jul 4, 2024

Description

This PR documents the proper configuration for long living job streams if there is a reverse proxy or load balancer between the user's clients and the Camunda gateway.

closes #3903

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/).
  • I included my new page in the sidebar file(s).

Copy link
Contributor

github-actions bot commented Jul 4, 2024

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

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

lenaschoenburg
lenaschoenburg previously approved these changes Jul 5, 2024
Copy link
Member

@lenaschoenburg lenaschoenburg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔧 I think this needs to added to the versioned docs too, to 8.4 at least I think.

docs/apis-tools/go-client/job-worker.md Outdated Show resolved Hide resolved
@christinaausley christinaausley added the component:docs Documentation improvements, including new or updated content label Jul 5, 2024
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@npepinpe I pushed a few updates, but I think this is in good shape otherwise. I assume it should be backported to previous versions as well?

@npepinpe
Copy link
Member Author

Looks good 👍 Hm, there's no job streaming before 8.4, so we could backport to 8.5 and 8.4.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Went ahead and backported to the requested versions - all looks good on my end, so approving here unless there's any other engineering reviews waiting.

@npepinpe npepinpe merged commit 64ce561 into main Aug 5, 2024
7 checks passed
@npepinpe npepinpe deleted the np-job-stream-proxy-docs branch August 5, 2024 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Document recommended configuration for worker job streaming with reverse proxies
4 participants