diff --git a/Others/iperf/README.md b/Others/iperf/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f165165f986622b9df3cc3ebb31cad8ebb1dfdc7 --- /dev/null +++ b/Others/iperf/README.md @@ -0,0 +1,50 @@ +# Quick reference + +- The official iperf 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). + +# iperf | openEuler +Current iperf docker images are built on the [openEuler](https://repo.openeuler.org/). This repository is free to use and exempted from per-user rate limits. + +iperf is a tool for active measurements of the maximum achievable bandwidth on IP networks. It supports tuning of various parameters related to timing, protocols, and buffers. For each test it reports the measured throughput / bitrate, loss, and other parameters. + +Learn more about iperf on [iperf Website](https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/iperf/)⁠. + +# Supported tags and respective Dockerfile links +The tag of each `iperf` docker image is consist of the version of `iperf` and the version of basic image. The details are as follows + +| Tag | Currently | Architectures | +|----------|-------------------------------------------|------------------| +|[3.19-oe2403sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/Others/iperf/3.19/24.03-lts-sp1/Dockerfile)| iperf 3.19 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/iperf` image from docker + + ```bash + docker pull openeuler/iperf:{Tag} + ``` + +- Basic Usage + + Start the server (default port: 5201) + ``` + iperf3 -s + ``` + + Output Example: + ``` + Server is listening on 5201 + ``` + + Run on custom port + ``` + iperf3 -s -p 9000 + ``` + +# 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/iperf/doc/image-info.yml b/Others/iperf/doc/image-info.yml new file mode 100644 index 0000000000000000000000000000000000000000..bb1a402267a743280de49d43cf2cbe9fa089de72 --- /dev/null +++ b/Others/iperf/doc/image-info.yml @@ -0,0 +1,43 @@ +name: iperf +category: others +description: iperf 是一款网络性能测试工具,用于测量 带宽(Throughput) 和 延迟(Latency)。 +environment: | + 本应用在Docker环境中运行,安装Docker执行如下命令 + ``` + yum install -y docker + ``` +tags: | + iperf镜像的Tag由其版本信息和基础镜像版本信息组成,详细内容如下 + + | Tag | Currently | Architectures | + |----------|-------------|------------------| + |[3.19-oe2403sp1](https://gitee.com/openeuler/openeuler-docker-images/blob/master/Others/iperf/3.19/24.03-lts-sp1/Dockerfile)| iperf 3.19 on openEuler 24.03-LTS-SP1 | + +download: | + 拉取镜像到本地 + ``` + docker pull openeuler/iperf:{Tag} + ``` + +usage: | + 启动iperf3 (默认端口: 5201) + ``` + iperf3 -s + ``` + + 输出示例: + ``` + Server is listening on 5201 + ``` + + 自定义端口运行 + ``` + iperf3 -s -p 9000 + ``` + +license: BSD 3-Clause License +similar_packages: + - netperf: Netperf 是一款经典的 网络性能基准测试工具,由 Hewlett-Packard (HP) 开发,用于精确测量 TCP/UDP 的吞吐量、延迟和请求/响应性能。 +dependency: + - OpenSSL + - libc \ No newline at end of file diff --git a/Others/iperf/doc/picture/logo.png b/Others/iperf/doc/picture/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..585b2a136c34f9359bac1794797d0e9e90a83744 Binary files /dev/null and b/Others/iperf/doc/picture/logo.png differ