diff --git a/Others/spdk/README.md b/Others/spdk/README.md new file mode 100644 index 0000000000000000000000000000000000000000..854f8030abbb4a43409eced745ede30a2dc0ced3 --- /dev/null +++ b/Others/spdk/README.md @@ -0,0 +1,43 @@ +# Quick reference + +- The official spdk docker image. + +- Maintained by: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative). + +- Where to get help: [openEuler CloudNative SIG](https://gitee.com/openeuler/cloudnative), [openEuler](https://gitee.com/openeuler/community). + +# Storage Performance Development Kit (SPDK) | openEuler +Current Storage Performance Development Kit (SPDK) docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. + +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. + +Learn more about SPDK on [SPDK Website](https://spdk.io/doc/)⁠. + +# Supported tags and respective Dockerfile links +The tag of each `spdk` docker image is consist of the version of `spdk` and the version of basic image. The details are as follows +| Tag | Currently | Architectures | +|----------|-------------|------------------| +|[24.09-oe2403sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/Others/spdk/24.09/24.03-lts-sp1/Dockerfile)| SPDK 24.09 on openEuler 24.03-LTS-SP1 | amd64, arm64 | + +# Usage +In this usage, users can select the corresponding `{Tag}` based on their requirements. + +- Pull the `openeuler/spdk` image from docker + + ```bash + docker pull openeuler/spdk:{Tag} + ``` + +- Run default unit tests: + + By default, if you start the container without specifying a command (such as `bash`), it will automatically run default unit tests. + + ```bash + docker run -it --rm openeuler/spdk:{Tag} + ``` + +# Question and answering +If you have any questions or want to use some special features, please submit an issue or a pull request on [openeuler-docker-images](https://gitee.com/openeuler/openeuler-docker-images). \ No newline at end of file diff --git a/Others/spdk/doc/image-info.yml b/Others/spdk/doc/image-info.yml new file mode 100644 index 0000000000000000000000000000000000000000..a6e4c8935b385554e0cefbf9e0338dad291ad9dc --- /dev/null +++ b/Others/spdk/doc/image-info.yml @@ -0,0 +1,41 @@ +name: spdk +category: others +description: SPDK(Storage Performance Development Kit) 是由Intel牵头开发的一个开源项目,在用户态实现高性能存储设备访问,特别是NVMe和NVMe-oF。 +environment: | + 本应用在Docker环境中运行,安装Docker执行如下命令 + ``` + yum install -y docker + ``` +tags: | + spdk镜像的Tag由其版本信息和基础镜像版本信息组成,详细内容如下 + + | Tag | Currently | Architectures | + |----------|-------------|------------------| + |[24.09-oe2403sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/Others/spdk/24.09/24.03-lts-sp1/Dockerfile)| SPDK 24.09 on openEuler 24.03-LTS-SP1 | amd64, arm64 | + +download: | + 拉取镜像到本地 + ``` + docker pull openeuler/spdk:{Tag} + ``` + +usage: | + - 运行默认单元测试: + + 默认情况下,启动容器没有指定命令(例如 bash)时,将自动运行默认的单元测试。 + + ``` + docker run -it --rm openeuler/spdk:{Tag} + ``` + +license: BSD-3-Clause +similar_packages: + - N/A +dependency: + - pkg-config + - libuuid + - libevent + - OpenSSL + - librdmacm + - libibverbs + - libaio \ No newline at end of file diff --git a/Others/spdk/doc/picture/logo.png b/Others/spdk/doc/picture/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..d9f51e574aac366a662d242dc8d5d944689255b2 Binary files /dev/null and b/Others/spdk/doc/picture/logo.png differ