Skip to content

opiproject/gospdk

Repository files navigation

gospdk

Linters CodeQL OpenSSF Scorecard Go Docker License codecov Go Report Card Go Doc Pulls Last Release GitHub stars GitHub Contributors

The Storage Performance Development Kit (SPDK) provides a set of tools and libraries for writing high performance, scalable, user-mode storage applications. It achieves high performance by moving all of the necessary drivers into userspace and operating in a polled mode instead of relying on interrupts, which avoids kernel context switches and eliminates interrupt handling overhead.

This project contains Go implementation of the SPDK json-rpc protocol https://spdk.io/doc/jsonrpc.html

I Want To Contribute

This project welcomes contributions and suggestions. We are happy to have the Community involved via submission of Issues and Pull Requests (with substantive content or even just fixes). We are hoping for the documents, test framework, etc. to become a community process with active engagement. PRs can be reviewed by any number of people, and a maintainer may accept.

See CONTRIBUTING and GitHub Basic Process for more details.

Installation

There are several ways of running this CLI.

Docker

docker pull opiproject/gospdk:<version>

You can specify a version like 0.1.1 or use latest to get the most up-to-date version.

Run latest version of the CLI in a container:

docker run --rm opiproject/gospdk:latest --help

Replace --help with any gospdk command, without gospdk itself.

Golang

go install -v github.com/opiproject/gospdk@latest

or import

import (
        "github.com/opiproject/gospdk/spdk"
)