wso2 / wso2/docs-apim

[APIM] Adding [apim.event_hub] configuration in a distributed deployment

Open
#9,235 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M 4.2.0 Type/Question
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description

When configuring the distributed setup in the WSO2 APIM, the event hub configuration is used to retrieve Gateway artifacts. In documentation [1], it says to add the event hub configurations to the GW deployment.toml file. But it is not mentioned in the documentation [2]. Shouldn't it be added to the documentation [2] as well? Please note that this is relating to using email usernames.

Also, the [3] is regarding configuring event hub username to construct the TopicConnectionFactory when the username is changed to email. (to escape the @) I was not able to locate where this is mentioned in the documentation [1] and [2]. (In documentation [1], the configuration is there in Add Event Hub Configurations: but it is not specifically mentioned.) Shouldn't this be added in the documentation in [1] & [2]?

Kindly appreciate your feedback on this.

[1] https://apim.docs.wso2.com/en/4.2.0/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-distributed-setup-with-tm-separated/#configure-the-gateway-nodes
[2] https://apim.docs.wso2.com/en/4.2.0/install-and-setup/setup/distributed-deployment/deploying-wso2-api-m-in-a-distributed-setup/
[3] https://github.com/wso2/product-apim/issues/12754

Affected Component

APIM

Version

4.2.0

Environment Details (with versions)

N/A

Related Issues

No response

Suggested Labels

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the two distributed-deployment documentation pages linked as [1] and [2], then read the related product issue [3] for the email-username context. Update the relevant sections to explicitly cover the event hub configuration and escaped email username, and verify that both deployment guides describe the required setup consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
40/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.