updated README.md file

some minor clarifying edits
This commit is contained in:
Jim Donovan 2017-06-16 10:59:44 -04:00 committed by GitHub
parent 2de1d4c7ca
commit 6d79b5b68f
1 changed files with 20 additions and 13 deletions

View File

@ -1,22 +1,31 @@
# Introduction
s3-benchmark is a program for performing S3 operations PUT, GET, and DELETE for objects. Besides the
bucket configuration, the object size and number of threads can be given for different tests.
s3-benchmark is a performance testing tool provided by Wasabi for performing S3 operations (PUT, GET, and DELETE) for objects. Besides the bucket configuration, the object size and number of threads varied be given for different tests.
The testing tool is loosely based on the Nasuni (http://www6.nasuni.com/rs/nasuni/images/Nasuni-2015-State-of-Cloud-Storage-Report.pdf) performance benchmarking methodologies used to test the performance of different cloud storage providers
# Prerequisites
To leverage this tool, the following prerequisites apply
• Git development environment
• Ubuntu Linux shell programming skills
• Access to a Go 1.7 development system (only if the OS is not Ubuntu Linux 16.04)
• Access to the appropriate AWS EC2 (or equivalent) compute resource (optimal performance is realized using m4.10xlarge EC2 Ubuntu with 10 GB ENA)
The test is loosely based on the Nasuni benchmark used to test the performance of different cloud
storage providers.
# Building the Program
Obtain a local copy of the repository using the following git command:
Obtain a local copy of the repository using the following git command with any directory that is convenient:
```
git clone https://github.com/wasabi-tech/s3-benchmark.git
```
If the test is being run on Ubuntu version 16.04 LTS (the current long term release), the binary
executable s3-benchmark.ubuntu will run the benchmark without building.
You should see the following files in the s3-benchmark directory.
LICENSE README.md s3-benchmark.go s3-benchmark.ubuntu
Otherwise, to build the test, you must install Go 1.7 development system along with the supporting libraries
given in the import section.
If the test is being run on Ubuntu version 16.04 LTS (the current long term release), the binary
executable s3-benchmark.ubuntu will run the benchmark testing without having to build the executable.
Otherwise, to build the s3-benchmark executable, you must issue this following command:
/usr/bin/go build s3-bechmark.go
# Command Line Arguments
Below are the command line arguments to the program (which can be displayed using -help):
@ -56,7 +65,5 @@ Benchmark completed.
```
# Note
Your benchmark results may vary most often because of limitations of your network connection to the cloud storage
provider. Wasabi performance claims are tested under conditions that remove any latency (which can be shown using
the ping command) and bandwidth bottlenecks that restrict how fast data can be moved. For more information,
contact Wasabi customer support.
Your performance testing benchmark results may vary most often because of limitations of your network connection to the cloud storage provider. Wasabi performance claims are tested under conditions that remove any latency (which can be shown using the ping command) and bandwidth bottlenecks that restrict how fast data can be moved. For more information,
contact Wasabi technical support (support@wasabi.com).