mirror of
https://github.com/clearlinux/dockerfiles.git
synced 2026-07-11 15:07:25 +00:00
update iperf README.md
Signed-off-by: Gong Sophia <sophia.gong@intel.com>
This commit is contained in:
+91
-17
@@ -1,22 +1,96 @@
|
||||
# iperf3 service on clearlinux
|
||||
Iperf is a widely used tool for network performance measurement and tuning.
|
||||
# Clear Linux* OS `iperf3` container image
|
||||
|
||||
## Build
|
||||
```
|
||||
sudo docker build -t clearlinux/iperf .
|
||||
```
|
||||
<!-- Required -->
|
||||
## What is this image?
|
||||
|
||||
## Run as Server:
|
||||
```
|
||||
sudo docker run -it --rm --name=iperf-srv -p 5201:5201 clearlinux/iperf -s
|
||||
```
|
||||
`clearlinux/iperf` is a Docker image with `iperf` running on top of the
|
||||
[official clearlinux base image](https://hub.docker.com/_/clearlinux).
|
||||
|
||||
## Run as Client (first get server IP address):
|
||||
```
|
||||
sudo docker run -it --rm --network=host clearlinux/iperf -c <SERVER_IP>
|
||||
```
|
||||
<!-- application introduction -->
|
||||
> [iperf](https://iperf.fr/) is a tool for active measurements of the maximum achievable
|
||||
> bandwidth on IP networks. It supports tuning of various parameters related to timing,
|
||||
> buffers and protocols (TCP, UDP, SCTP with IPv4 and IPv6).
|
||||
|
||||
## Extra Build ARGs
|
||||
- ``swupd_args`` Specifies [SWUPD](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options) flags
|
||||
For other Clear Linux* OS
|
||||
based container images, see: https://hub.docker.com/u/clearlinux
|
||||
|
||||
Default build args in Docker are on: https://docs.docker.com/engine/reference/builder/#arg
|
||||
## Why use a clearlinux based image?
|
||||
|
||||
<!-- CL introduction -->
|
||||
> [Clear Linux* OS](https://clearlinux.org/) is an open source, rolling release
|
||||
> Linux distribution optimized for performance and security, from the Cloud to
|
||||
> the Edge, designed for customization, and manageability.
|
||||
|
||||
Clear Linux* OS based container images use:
|
||||
* Optimized libraries that are compiled with latest compiler versions and
|
||||
flags.
|
||||
* Software packages that follow upstream source closely and update frequently.
|
||||
* An aggressive security model and best practices for CVE patching.
|
||||
* A multi-staged build approach to keep a reduced container image size.
|
||||
* The same container syntax as the official images to make getting started
|
||||
easy.
|
||||
|
||||
To learn more about Clear Linux* OS, visit: https://clearlinux.org.
|
||||
|
||||
<!-- Required -->
|
||||
## Deployment:
|
||||
|
||||
### Deploy with Docker
|
||||
The easiest way to get started with this image is by simply pulling it from
|
||||
Docker Hub.
|
||||
|
||||
|
||||
1. Pull the image from Docker Hub:
|
||||
```
|
||||
docker pull clearlinux/iperf
|
||||
```
|
||||
|
||||
2. Start a container using the examples below:
|
||||
|
||||
## Run as Server:
|
||||
```
|
||||
sudo docker run -it --rm --name=iperf-srv -p 5201:5201 clearlinux/iperf -s
|
||||
```
|
||||
|
||||
## Run as Client (first get server IP address):
|
||||
```
|
||||
sudo docker run -it --rm --network=host clearlinux/iperf -c <SERVER_IP>
|
||||
```
|
||||
|
||||
<!-- Optional -->
|
||||
### Deploy with Kubernetes
|
||||
|
||||
<!-- Required -->
|
||||
## Build and modify:
|
||||
|
||||
The Dockerfiles for all Clear Linux* OS based container images are available at
|
||||
https://github.com/clearlinux/dockerfiles. These can be used to build and
|
||||
modify the container images.
|
||||
|
||||
1. Clone the clearlinux/dockerfiles repository.
|
||||
```
|
||||
git clone https://github.com/clearlinux/dockerfiles.git
|
||||
```
|
||||
|
||||
2. Change to the directory of the application:
|
||||
```
|
||||
cd iperf/
|
||||
```
|
||||
|
||||
3. Build the container image:
|
||||
```
|
||||
docker build -t clearlinux/iperf .
|
||||
```
|
||||
|
||||
Refer to the Docker documentation for [default build arguments](https://docs.docker.com/engine/reference/builder/#arg).
|
||||
Additionally:
|
||||
|
||||
- `swupd_args` - specifies arguments to pass to the Clear Linux* OS software
|
||||
manager. See the [swupd man pages](https://github.com/clearlinux/swupd-client/blob/master/docs/swupd.1.rst#options)
|
||||
for more information.
|
||||
|
||||
<!-- Required -->
|
||||
## Licenses
|
||||
|
||||
All licenses for the Clear Linux* Project and distributed software can be found
|
||||
at https://clearlinux.org/terms-and-policies
|
||||
|
||||
Reference in New Issue
Block a user