Skip to content

improve docs and help for flags #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2024
Merged

improve docs and help for flags #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,22 @@ The basic command to run an iperf test is:
k8s-iperf run
```

Running in multi-cluster mode over Cilium Cluster Mesh:

```
k8s-iperf run --k8s-service-annotation "service.cilium.io/global=true" --k8s-multi-cluster --k8s-client-context minikube --k8s-server-context kind
```

### Flags

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

### Iperf Arguments

Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/commands.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func init() {
runCmd.Flags().StringP("k8s-server-context", "", "", "Kubernetes server context to use for the test")
runCmd.Flags().StringP("k8s-client-context", "", "", "Kubernetes client context to use for the test")
runCmd.Flags().BoolP("k8s-multi-cluster", "", false, "Run the test in multi-cluster mode")
runCmd.Flags().StringP("k8s-service-annotation", "", "", "Service annotation to use for the test")
runCmd.Flags().StringP("k8s-service-annotation", "", "", "Service annotation to use for the test (signature: key1=value1,key2=value2)")
rootCmd.AddCommand(runCmd)
}

Expand Down