[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/olegeech/k8s-bench-suite/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","olegeech","reponame","k8s-bench-suite","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2020-11-30T13:48:07.328911Z","description","All-in-one image for comprehensive K8S network testing. Based on the InfraBuilder original repo.","is_private","last_updated","2020-12-18T12:03:05.957712Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",3978,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# k8s-bench-suite\nBash scripts collection to benchmark kubernetes cluster performance\n\n## [knb](knb) : Kubernetes Network Benchmark\n\n[knb](knb) is a bash script that will start a networking benchmark on a target Kubernetes cluster.\n\nHere are some highlights:\n\n- **Plain bash script** with very few dependencies\n- Complete benchmark **takes only 2 minutes**\n- Ability to select only a subset of benchmark tests to run\n- Testing **both TCP and UDP** bandwidth\n- **Automatic detection of CNI MTU**\n- **Includes host cpu and ram monitoring** in benchmark report\n- Ability to create static graph images based on the result data using plotly/orca (see examples below)\n- No ssh access required, just an access to the target cluster through **standard kubectl**\n- **No need for high privileges**, the script will just launch very lightweight pods on two nodes.\n- Based on **very lights containers** images :\n - ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/infrabuilder/bench-iperf3/latest) [infrabuilder/bench-iperf3](https://hub.docker.com/r/infrabuilder/bench-iperf3), is used to run benchmark tests\n - ![Docker Image Size (tag)](https://img.shields.io/docker/image-size/infrabuilder/bench-custom-monitor/latest) [infrabuilder/bench-custom-monitor](https://hub.docker.com/r/infrabuilder/bench-custom-monitor), is used to monitor nodes\n- **Ability to run the whole suite in a container** [olegeech/k8s-bench-suite](https://hub.docker.com/r/olegeech/k8s-bench-suite):\n - Image is based on the bitnami/kubectl\n - Nodes for testing can be auto-preselected\n\n### Requirements \n\nThis script needs a valid `kubectl` setup with an access to the target cluster.\n\nBinaries dependencies for the host that will execute [knb](knb) :\n\n- awk\n- grep\n- tail\n- date\n- kubectl\n- jq (for plotting)\n\n### Quickstart\n\nChoose two nodes to act as server/client on your cluster (for example node1 and node2) . Then start the knb : \n\n```bash\n./knb --verbose --client-node node1 --server-node node2\n```\n\nIf you omit the `--verbose` flag, it will also complete, but you will have no output until the end of the benchmark.\n\n### Docker quickstart\n\n**Environment variables:**\n\n- `NODE_AUTOSELECT` Auto-selects a few nodes from cluster for running tests\n- `MASTER_ELIGIBLE` Master nodes can also be chosen\n\nYou need to mount a valid kubeconfig inside the container and provide all other required flags to knb:\n\n```bash\ndocker run -e NODE_AUTOSELECT=1 -it --hostname knb --name knb --rm -v /home/user/my-graphs:/my-graphs -v /path/to/my/kubeconfig:/.kube/config olegeech/k8s-bench-suite --verbose --plot --plot-dir /my-graphs\n```\n\n### Examples\n\n- Simple benchmark from \"node1\" to \"node2\" in **verbose** mode :\n\n ```bash\n knb -v -cn node1 -sn node2\n ```\n\n- Benchmark from \"nA\" to \"nB\" and **save data** in file `mybench.knbdata` \n\n ```bash \n knb -cn nA -sn nB -o data -f mybench.knbdata\n ```\n\n- Generate report **in json** from **previous benchmark** data file `mybench.knbdata`\n\n ```bash\n knb -fd mybench.knbdata -o json\n ```\n\n- Plot graphs from **previous benchmark** data file `mybench.knbdata`\n\n ```bash\n knb -fd mybench.knbdata --plot --plot-args '--width 900 --height 600'\n ```\n\n- To run benchmark from node A to node B, showing only result **in yaml** format : \n\n ```bash\n knb -cn A -sn B -o yaml\n ```\n\n- To run benchmark from node Asterix to node Obelix, with the **most verbose output** and a result as **json** in a `res.json` file :\n\n ```bash\n knb --debug -cn Asterix -sn Obelix -o json -f res.json\n ```\n\n- Running benchmark **in namespace** `myns` :\n\n ```bash\n knb -n myns -cn node1 -sn node2\n ```\n\n- Run **only idle and tcp** benchmark :\n\n ```bash\n knb -cn clientnode -sn servernode -ot idle,tcp\n ```\n\n### Usage\n\nTo display usage, use the `-h` flag :\n\n```bash\naducastel@infrabuilder:~/k8s-bench-suite$ ./knb -h\n\nknb is a network benchmark tool for Kubernetes CNI\n\nThere are two modes :\n- benchmark mode : will actually run benchmark on a cluster\n- from data mode : read data generated by previous benchmark with \"-o data\" flag\n\n=====[ Benchmark mode ]====================================================\n\n Mandatory flags :\n\n -cn \n --client-node : Define kubernetes node name that will host the client part\n\n -sn \n --server-node : Define kubernetes node name that will host the server part\n\n Optionnal flags :\n -d \n --duration : Set the benchmark duration for each test in seconds (Default 10)\n\n -k\n --keep : Keep data directory instead of cleaning it (tmp dir that contains raw benchmark data)\n\n -n \n --namespace : Set the target kubernetes namespace\n\n --name : Set the name of this benchmark run\n\n -ot \n --only-tests : Only run a subset of benchmark tests, comma separated (Ex: -ot tcp,idle)\n Possible values: all, tcp, udp, p2p, p2s , p2ptcp, p2pudp, p2stcp, p2sudp, idle\n\n -sbs \n --socket-buffer-size : Set the UDP socket buffer size with unit, or 'auto'. ex: '256K' (Default: auto)\n\n -t \n --timeout : Set the pod ready wait timeout in seconds (Default 30)\n\n=====[ From Data mode ]====================================================\n\nMandatory flags :\n -fd \n --from-data : Define the path to the data to read from\n Data file must be rendered with '--output data'\n\n=====[ Common optionnal flags ]============================================\n\n --debug : Set the debug level to \"debug\"\n\n -dl \n --debug-level : Set the debug level\n Possible values: standard, warn, info, debug\n\n -f \n --file : Set the output file\n\n -h\n --help : Display this help message\n\n -p\n --plot : Plot data using plotly/orca\n\n -pd\n --plot-dir : Directory where to save graphs\n Defaults to the current directory\n\n -pa\n --plot-args : Arguments to the plotly's 'orca graph' function\n Defaults to '--width 900 --height 500'\n\n -o \n --output : Set the output format. Defaults to 'text'\n Possible values: text, yaml, json, data\n -v\n --verbose : Activate the verbose mode by setting debug-level to 'info'\n\n -V\n --version : Show current script version\n\n=====[ Examples ]==========================================================\n\n Simple benchmark from \"node1\" to \"node2\" in verbose mode\n -------------------------------------------------------------------------\n | knb -v -cn node1 -sn node2 |\n -------------------------------------------------------------------------\n\n Benchmark from \"nA\" to \"nB\" with data saved in file \"mybench.knbdata\"\n -------------------------------------------------------------------------\n | knb -cn nA -sn nB -o data -f mybench.knbdata |\n -------------------------------------------------------------------------\n\n Generate report in json from previous benchmark file \"mybench.knbdata\"\n -------------------------------------------------------------------------\n | knb -fd mybench.knbdata -o json |\n -------------------------------------------------------------------------\n\n Create graph images from previous benchmark file \"mybench.knbdata\"\n -------------------------------------------------------------------------\n | knb -fd mybench.knbdata --plot --plot-dir ./my-graphs |\n -------------------------------------------------------------------------\n\n Run only idle and tcp benchmark :\n -------------------------------------------------------------------------\n | knb -cn clientnode -sn servernode -ot idle,tcp |\n -------------------------------------------------------------------------\n\n```\n### Graph examples\n\n![bandwidth](https://user-images.githubusercontent.com/21361354/102022246-d6e1d080-3d85-11eb-8ca6-37064ac3918f.png)\n![cpu-usage](https://user-images.githubusercontent.com/21361354/102022247-d812fd80-3d85-11eb-820f-f5108cf8b930.png)\n![ram-usage](https://user-images.githubusercontent.com/21361354/102022250-d812fd80-3d85-11eb-9f1b-650571bb0054.png)\n\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",237742768,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",8049876,"full_size",48947238,"id",128076136,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:e6ab56e4e9ef6956dc1526970ea733a6aaf8118ccc86ccdbc89e891d4005d339","features","","last_pulled","2026-09-15T08:37:58.597097874Z","last_pushed","2020-12-18T12:03:06Z","os","linux","os_features","os_version","size","variant","2020-12-18T12:03:05.619888Z","last_updater","last_updater_username","media_type","latest","repository",10336773,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":11,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":149,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[150],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

olegeech/k8s-bench-suite

Tags for olegeech/k8s-bench-suite