-
Notifications
You must be signed in to change notification settings - Fork 137
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.
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
Made the name of environment variables consistent through benchmarking doc #740
base: main
Are you sure you want to change the base?
Conversation
doc/BENCHMARKING.md
Outdated
@@ -32,12 +32,12 @@ You can use the following steps. | |||
--fuse-version 2 \ | |||
--with-fio --with-libunwind | |||
|
|||
2. Set environment variables related to the benchmark. There are four required environment variables you need to set in order to run the benchmark. | |||
2. Set environment variables related to the benchmark. There are four required environment variables you need to set in order to run the benchmark. These variables can be set to any name, but be consistent with it in subsequent steps. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we change these steps to first create the files needed and then populate the env variables?
Also, on line 45, there is a DOC-EXAMPLE-BUCKET
which is undefined. Please add that to the set of variables to set.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. That seems more reasonable. Making the change. Thanks
486b350
to
6336ab6
Compare
…g doc Signed-off-by: Ankit Saurabh <[email protected]>
Signed-off-by: Ankit Saurabh <[email protected]>
6336ab6
to
2f38025
Compare
export S3_BUCKET_NAME=DOC-EXAMPLE-BUCKET | ||
export S3_BUCKET_TEST_PREFIX=benchmark/ | ||
export S3_BUCKET_BENCH_FILE=bench100GB.bin | ||
export S3_BUCKET_SMALL_BENCH_FILE=bench5MB.bin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think step 2 should be creating those variables (what is now in step 3). Then, step 3 can refer to those variables (what is now in step 2).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These environment variables are to run the benchmark script that we run in step 4. We earlier thought that these environment variables should be set once we have created the resource: #740 (comment)
Description of change
In our Benchmarking doc, the names for environment variables
S3_BUCKET_NAME
,S3_BUCKET_TEST_PREFIX
,S3_BUCKET_BENCH_FILE
andS3_BUCKET_SMALL_BENCH_FILE
across steps. This might create confusion for new user trying to run benchmark.Made the names consistent across the steps for environment variables in used in benchmarking.
Relevant issues:
NA
Does this change impact existing behavior?
No. Just documentation edits.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).