Skip to content

[Bug][Docs] Fix UCX TCP connection issue and add setup guide#49

Merged
DwyaneShi merged 7 commits into
aibrix:devfrom
jasonlee-1024:dev_bob
May 20, 2026
Merged

[Bug][Docs] Fix UCX TCP connection issue and add setup guide#49
DwyaneShi merged 7 commits into
aibrix:devfrom
jasonlee-1024:dev_bob

Conversation

@bob-021206

Copy link
Copy Markdown
Contributor

Pull Request Description

This PR fixes an issue with UCX TCP connections and adds a setup guide for using UCX over TCP.

Motivation

During development and testing, UCX TCP connections were found to be unstable under certain conditions, leading to connection failures or unexpected behavior. In addition, there was no clear documentation on how to properly configure UCX for TCP usage, which made debugging and setup more difficult.

Root Cause

The issue was related to improper handling and/or configuration of UCX TCP connections, which could lead to failures during initialization or data transfer.

Changes

  • Fixed UCX TCP connection handling logic to improve stability
  • Improved robustness of connection initialization
  • Added SETUP_UCX_TCP.md with detailed instructions for configuring UCX TCP
  • Included required dependencies and environment configuration for TCP transport

Impact

  • Improves stability of UCX TCP communication
  • Provides clear guidance for setting up UCX TCP environment
  • Reduces setup errors and debugging time for developers
  • No breaking changes to existing APIs

Related Issues

N/A

Important: Before submitting, please complete the description above and review the checklist below.


Contribution Guidelines (Expand for Details)

We appreciate your contribution to PrisKV! To ensure a smooth review process and maintain high code quality, please adhere to the following guidelines:

Pull Request Title Format

Your PR title should start with one of these prefixes to indicate the nature of the change:

  • [Bug]: Corrections to existing functionality
  • [CI]: Changes to build process or CI pipeline
  • [Docs]: Updates or additions to documentation
  • [API]: Modifications to PrisKV's API or interface
  • [CLI]: Changes or additions to the Command Line Interface
  • [Misc]: For changes not covered above (use sparingly)

Note: For changes spanning multiple categories, use multiple prefixes in order of importance.

Submission Checklist

  • PR title includes appropriate prefix(es)
  • Changes are clearly explained in the PR description
  • New and existing tests pass successfully
  • Code adheres to project style and best practices
  • Documentation updated to reflect changes (if applicable)
  • Thorough testing completed, no regressions introduced

By submitting this PR, you confirm that you've read these guidelines and your changes align with the project's contribution standards.

Signed-off-by: bob-021206 <binyan_github@163.com>
Signed-off-by: bob-021206 <binyan_github@163.com>
Signed-off-by: bob-021206 <binyan_github@163.com>
… arity)

Signed-off-by: bob-021206 <binyan_github@163.com>
@bob-021206

Copy link
Copy Markdown
Contributor Author

Hi @Jeffwan @DwyaneShi, just wanted to kindly follow up on this PR when you have a chance. I’d appreciate any review or feedback. Thanks!

Comment thread client/transport/ucx.c
Comment thread cluster/client/test_status.c Outdated
Comment thread server/transport/transport.c
Comment thread server/kv.c Outdated
Comment thread server/kv.c Outdated
Comment thread SETUP_UCX_TCP.md Outdated
Comment thread SETUP_UCX_TCP.md Outdated
@DwyaneShi

Copy link
Copy Markdown
Collaborator

@bob-021206 Thanks for the contribution. The PR looks good to me overall, and I left some minor comments. Thanks in advance for addressing the comments from the reviewers.

@bob-021206

Copy link
Copy Markdown
Contributor Author

@DwyaneShi Thanks for the review! We are also working on AIBrix and vLLM-Omni compatibility, which requires using the pypriskv Python package directly. Do you have any plan to publish pypriskv to PyPI in the future so it can be installed via pip install?

Comment thread server/transport/ucx.c
connfd = accept(listener->listenfd, (struct sockaddr *)&client_addr, &client_addr_len);
if (connfd < 0) {
if (errno == EAGAIN || errno == EWOULDBLOCK) {
// no connection available, return

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

let's keep these comments

@DwyaneShi

Copy link
Copy Markdown
Collaborator

@bob-021206 There are some building issues to be fixed. I'll publish pypriskv to PyPI after this PR getting merged.

@DwyaneShi

Copy link
Copy Markdown
Collaborator

I'll merge this PR and the building issue will be fixed in a follow-up PR separately.

@DwyaneShi DwyaneShi merged commit 27bc963 into aibrix:dev May 20, 2026
0 of 2 checks passed
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.

3 participants