Skip to content

Commit 174e371

Browse files
committed
lambda.md : Add the lambda flow section for clarity.
Signed-off-by: Santosh Mahto <santosh.mahto@collabora.com>
1 parent 5c116dc commit 174e371

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed

resctl-bench/doc/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ The benchmarks
2020
* [iocost-qos](iocost-qos.md): Benchmark IO isolation with different io.cost QoS configurations
2121
* [iocost-tune](iocost-tune.md): Benchmark storage device to determine io.cost QoS solutions
2222

23+
AWS lambda workflow
24+
===================
25+
26+
* [lambda](lambda.md) : Lambda overview, configurations and setups
2327

2428
Other Notes
2529
===========

resctl-bench/doc/lambda.md

+10-8
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,8 @@ We still need to configure our S3 bucket to allow public read only access, so th
8787
}
8888
```
8989

90-
9190
We also store the credential parameters required to file a github issue in AWS Systems Manager -> parameter store.
92-
We use github app `iocost-issue-creater` to file a github issue, thus it's credentials information `App Id` and
93-
`Private Key` are stored in parameter store.
91+
Lambda uses github app [iocost-issue-creater](https://github.com/apps/iocost-issue-creater) to file a github issue, thus it's credentials information `App Id` and `Private Key` are stored in AWS parameter store.
9492
```
9593
{
9694
/iocost-bot/appid : "xxxx"
@@ -100,18 +98,22 @@ We use github app `iocost-issue-creater` to file a github issue, thus it's crede
10098

10199
AWS lambda flow
102100
===============
103-
1. User generates the benchmark result on their device.
104-
`$ resctl-bench -r "$RESULT_JSON" --logfile=$LOG_FILE run iocost-tun`
105-
2. User uploads the result to aws lambda function url as:
106-
`resctl-bench -r <RESULT_JSON> upload --upload-url <AWS lambda function URL>`
101+
1. User generates the benchmark result on their device.
102+
`$ resctl-bench -r "$RESULT_JSON" --logfile=$LOG_FILE run iocost-tune`
103+
2. User uploads the result to aws lambda function url as:
104+
`resctl-bench -r <RESULT_JSON> upload --upload-url <AWS lambda function URL>`
107105
e.g
108106
`$resctl-bench --result resctl-bench-result_2022_07_01-00_26_40.json.gz upload --upload-url https://ygvr6jnjckwamfao5xztg6idiu0ukjeb.lambda-url.eu-west-1.on.aws`
109107

110108
3. Lamda is tiggered automatically in AWS.
111109
- It saves the benchmark result to S3 bucket.
112-
- Then create a issue in iocost-benchmark/iocost-benchmarks project using `iocost-issue-creater` github app.
110+
- Then creates an issue in [iocost-benchmarks](https://github.com/iocost-benchmark/iocost-benchmarks) project using [iocost-issue-creater](https://github.com/apps/iocost-issue-creater) github app.
113111
- Issue contain a link to benchmark result stored in s3 bucket.
112+
e.g https://github.com/iocost-benchmark/iocost-benchmarks/issues/88
114113

114+
### Lambda workflow:
115+
Client uploads the benchmark result (above steps) -> AWS Lambda runs -> save result to s3 bucket -> Create github Issue with link of result stored in s3.
116+
Thereafter it's job of [iocost-benchmarks project](https://github.com/iocost-benchmark/iocost-benchmarks) to import and merge the results with existing database and generate final hwdb file.
115117

116118
Deploying
117119
=========

0 commit comments

Comments
 (0)