The Ceph NVMe-oF Gateway project pivots around 2 other major Open Source projects:
- SPDK [source code], which internally relies on the DPDK project.
- Ceph [source code].
Besides the regular Ceph community channels, the NVMe-oF Gateway team can be specifically reached at:
- Ceph Slack workspace,
#nvmeofchannel, - Weekly Sync Meeting
If you find an issue, identify whether the issue comes from the NVMe-oF Gateway, or any of the underlying components:
- For NVMe-oF Gateway issues (usually a Python traceback), check if the issue has already been reported. Otherwise, open a new one.
- For SPDK-related issues, open an issue in the SPDK GitHub Issues.
- For Ceph-related issues, open an issue in the Ceph Tracker.
This project follows:
- Python coding guidelines (PEP-8).
- gRPC and Protocol Buffers.
When committing your changes:
- Sign-off (
git commit -s), which will automatically add the following trailer to your commit:Signed-off-by: FirstName LastName <email@example.com>. This constitutes your Developer Certificate of Origin, and is enforced by a CI check. - Follow the Conventional Commit syntax. This is not yet enforced via CI checks.
TODO.
Refer to Ceph's "Submitting Patches to Ceph" documentation, with the difference that:
- This project uses GitHub Issues instead of the Ceph Tracker,
- Therefore commits and pull requests should use the
Fixes: #12345syntax (where#12345is the GitHub issue number), instead of theFixes: https://tracker.ceph.com....
TODO: No documentation is yet in place.