Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A light framework for, and a loose collection of tests, workloads, and repro pac
1. Provide a unified approach to processing/outputting results, to facilitate meaningful comparisons between setups

### 1.2 What The Repro Framework DOESN'T Do
* Manage infrastructure, security, or ACLs (create/delete instances, set up sudo and ssh, configure access and firewall, isolate the network, secure communication, etc)
* Manage infrastructure, security, or ACLs (create/delete instances, set up sudo and ssh, configure access and firewall, isolate the network, secure communication, etc). The one exception is the optional convenience helper `scripts/aws_create_instance.sh` (see §1.4); it is not part of the framework and is not required to run any repro.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this and the scripts/ line below. Section 1.4 already defines util/ for standalone utilities.

* Act as a result repository (dashboard, result collection, persistent database, etc)
* Provide an automation framework (queuing, scheduling, etc)
* Pick the correct test approach for you (see https://github.com/aws/aws-graviton-getting-started/tree/main/perfrunbook to learn more about that)
Expand All @@ -37,6 +37,10 @@ When this is performed, the only mechanism employed (and recommended) is `sudo`,

The repository consists of workloads identified with a unique name (each placed in an eponymous directory under `workloads/`), repro scenarios (all placed under `repros/`), framework files (placed under `common/`), and standalone utilities (placed under `util/`).

Two further directories sit outside the framework proper:
* `scripts/` - optional convenience helpers that are *not* part of the Repro Framework and are not needed to run any repro. These include `aws_create_instance.sh`, an env-var-driven wrapper around `aws ec2 run-instances` for spinning up a throw-away SUT/LDG instance (see §1.2 - infrastructure management is otherwise out of scope). Run `scripts/aws_create_instance.sh --help` for its options.
* `tests/` - tests for the above, grouped by type: `tests/unit/` (bats unit tests, run with [bats](https://github.com/bats-core/bats-core); tests mirror the repo layout under `tests/unit/scripts/`, with shared helpers in `tests/unit/helpers/`) and `tests/integration/` (real-AWS end-to-end scripts, run on demand). Run the unit suite with `make unittest`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make unittest doesn't have a Makefile to go on so these instructions are broken.


### 1.5 Glossary

* `workload` - A distinct building block which tests and measures one or more metrics such as throughput performance. It can be run individually or as part of a repro scenario. The use of synthetic benchmarks as workloads is strongly discouraged, as they do not usually represent real life performance correctly.
Expand Down
Loading