Skip to content

Commit 7bb4382

Browse files
committed
improve docs and help for flags
1 parent 8ec72b5 commit 7bb4382

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

Readme.md

+10
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,22 @@ The basic command to run an iperf test is:
3434
k8s-iperf run
3535
```
3636

37+
Running in multi-cluster mode over Cilium Cluster Mesh:
38+
39+
```
40+
k8s-iperf run --k8s-service-annotation "service.cilium.io/global=true" --k8s-multi-cluster --k8s-client-context minikube --k8s-server-context kind
41+
```
42+
3743
### Flags
3844

3945
- `--k8s-namespace` Specify the Kubernetes namespace to run the test in (default: "default")
4046
- `--k8s-image` Specify the Docker image to use for the test (default: "dariomader/iperf3:latest")
4147
- `--k8s-server-node` Specify the Kubernetes node to run the iperf3 server on
4248
- `--k8s-client-node` Specify the Kubernetes node to run the iperf3 client on
49+
- `--k8s-service-annotation` Specify the service annotation for the iperf3 server (signature: key1=value1,key2=value2)
50+
- `--k8s-client-context` Specify the Kubernetes client context to use for the test
51+
- `--k8s-server-context` Specify the Kubernetes server context to use for the test
52+
- `--k8s-multi-cluster` Run the test in multi-cluster mode
4353

4454
### Iperf Arguments
4555

pkg/cli/commands.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ func init() {
7373
runCmd.Flags().StringP("k8s-server-context", "", "", "Kubernetes server context to use for the test")
7474
runCmd.Flags().StringP("k8s-client-context", "", "", "Kubernetes client context to use for the test")
7575
runCmd.Flags().BoolP("k8s-multi-cluster", "", false, "Run the test in multi-cluster mode")
76-
runCmd.Flags().StringP("k8s-service-annotation", "", "", "Service annotation to use for the test")
76+
runCmd.Flags().StringP("k8s-service-annotation", "", "", "Service annotation to use for the test (signature: key1=value1,key2=value2)")
7777
rootCmd.AddCommand(runCmd)
7878
}
7979

0 commit comments

Comments
 (0)