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

Enable gateway to use reverse proxy for cluster communication #9572

Merged
merged 6 commits into from
Jun 23, 2022

Conversation

npepinpe
Copy link
Member

@npepinpe npepinpe commented Jun 22, 2022

Description

This PR adds the advertised host/port configuration to the cluster configuration of the standalone gateway. This enables the use case where the gateway and broker must communicate with a reverse proxy in between, such as when one is using a sidecar-contained based service mesh (e.g. Istio or Linkerd).

To improve test-ability, I extracted the creation of the AtomixCluster into a Spring component which is injected when the standalone gateway starts. That way we can test the component by itself. There's still an integration test which ensures it works end-to-end of course.

Related issues

closes #9342

Definition of Done

Not all items need to be done depending on the issue and the pull request.

Code changes:

  • The changes are backwards compatibility with previous versions
  • If it fixes a bug then PRs are created to backport the fix to the last two minor versions. You can trigger a backport by assigning labels (e.g. backport stable/1.3) to the PR, in case that fails you need to create backports manually.

Testing:

  • There are unit/integration tests that verify all acceptance criterias of the issue
  • New tests are written to ensure backwards compatibility with further versions
  • The behavior is tested manually
  • The change has been verified by a QA run
  • The impact of the changes is verified by a benchmark

Documentation:

  • The documentation is updated (e.g. BPMN reference, configuration, examples, get-started guides, etc.)
  • New content is added to the release announcement
  • If the PR changes how BPMN processes are validated (e.g. support new BPMN element) then the Camunda modeling team should be informed to adjust the BPMN linting.

Please refer to our review guidelines.

@github-actions
Copy link
Contributor

github-actions bot commented Jun 22, 2022

Unit Test Results

   782 files  +  2     782 suites  +2   1h 29m 4s ⏱️ - 1m 55s
5 651 tests  - 53  5 644 ✔️  - 53  7 💤 ±0  0 ±0 
5 823 runs   - 53  5 816 ✔️  - 53  7 💤 ±0  0 ±0 

Results for commit 5b79f89. ± Comparison against base commit dfbcbff.

♻️ This comment has been updated with latest results.

@npepinpe
Copy link
Member Author

There's a flaky test, but it seems unrelated to the changes here.

Copy link
Contributor

@deepthidevaki deepthidevaki left a comment

Choose a reason for hiding this comment

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

Thanks. Looks good to me. Please also add documentation for the new configs in the config templates.

Copy link
Contributor

@deepthidevaki deepthidevaki left a comment

Choose a reason for hiding this comment

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

🚀 Please fix the env variables in docs before merging.

dist/src/main/config/gateway.yaml.template Outdated Show resolved Hide resolved
dist/src/main/config/gateway.yaml.template Outdated Show resolved Hide resolved
@npepinpe
Copy link
Member Author

bors merge

@zeebe-bors-camunda
Copy link
Contributor

Build succeeded:

@zeebe-bors-camunda zeebe-bors-camunda bot merged commit 0714df1 into main Jun 23, 2022
@zeebe-bors-camunda zeebe-bors-camunda bot deleted the 9342-gateway-proxy branch June 23, 2022 13:31
zeebe-bors-camunda bot added a commit that referenced this pull request Jul 3, 2022
9669: fix: advertised address should fall back to configured address r=oleschoenburg a=oleschoenburg

## Description

Since we introduced support for advertised addresses in the gateway in #9572, the atomix communication services were bound to the default host and port (0.0.0.0:26502) if no advertised address was configured instead of falling back to the configured host and port first. 

## Related issues

closes #9658 because job available notifications were not received which caused the delay in job activation.



Co-authored-by: Ole Schönburg <ole.schoenburg@gmail.com>
Co-authored-by: Christopher Zell <zelldon91@googlemail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cannot connect standalone gateway with brokers behind a reverse proxy
2 participants