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

refactor: update documentation, docker build process, and JSON RPC handling #44

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

idoyo7
Copy link

@idoyo7 idoyo7 commented Jul 3, 2024

Changes Included in This Pull Request

  1. Documentation Update for Multi-Node Setup

    • Updated the multi-node.md documentation to enhance clarity and ensure accuracy, reflecting the latest operational procedures for setting up multiple nodes.
  2. Docker Image Build Process Enhancement

    • Modified the Docker image build process to include new dependencies required for the updated environment. This change ensures that all necessary tools and libraries are available in the Docker image.
  3. Refinement of JSON RPC Parameter Types

    • Refactored the JSON RPC parameter types in jsonrpc.go to improve compatibility and robustness. This update makes our JSON RPC calls more consistent and reliable across different platforms and configurations.

Rationale Behind Changes

These changes aim to improve the usability and stability of our system. The updates to the documentation make it easier for new users to get started with multi-node setups, while the Docker and JSON RPC updates enhance the overall development environment and system reliability.

Testing and Validation

  • All changes have been tested in a controlled development environment.
  • Docker build changes have been verified by successfully building and running containers.
  • JSON RPC changes have been tested to ensure that all functions perform as expected without any regressions.

I welcome any feedback or suggestions on these changes and look forward to your reviews. Thank you for considering this pull request!

@idoyo7 idoyo7 changed the title Comprehensive Updates: Documentation, Docker Build, and JSON RPC Refinements refactor: update documentation, docker build process, and JSON RPC handling Jul 3, 2024
@idoyo7
Copy link
Author

idoyo7 commented Jul 3, 2024

this is my first time editting opensource and making PR.
via testing in my local cluster, I have checked parameters that has been changed.
"I'm aware that my previous PR didn't follow the standard format, but I'd like to provide the necessary information to recreate the PR in the correct format.

However, I'd like to emphasize that the JSON RPC type definition must be updated, as the current version prevents NVMe devices from being created.

This PR was tested and verified on SPDK v24.05, K8S v1.28, and Ubuntu 22.04."

@jimharris
Copy link
Member

Hi @idoyo!

Thank you for your submission and the detailed explanations! Unfortunately, SPDK does not take pull requests via GitHub. Please see https://spdk.io/development for how to push patches to the SPDK Gerrit instance for review.

If you have found issues with the current implementation, please also consider submitting an issue to the SPDK GitHub database, https://github.com/spdk/spdk/issues. Then you can add comments to that issue with links to the Gerrit URLs that will get generated for your patches.

Tagging @cyb70289 and @askervin for their attention.

Thanks,

Jim

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.

2 participants