Skip to content

Commit

Permalink
Add headings to README for clarity. (#337)
Browse files Browse the repository at this point in the history
  • Loading branch information
paulosjca authored Nov 21, 2022
1 parent c80684e commit 986062a
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,29 @@ gRPC OSS benchmarks are a collection of libraries and executables to schedule,
run and monitor [gRPC performance benchmarking][benchmarking] tests on a
Kubernetes cluster.

### Controller

The main executable is a [custom controller][] that manages resources of kind
[LoadTest][loadtest]. This controller must be deployed to the cluster before
load tests can be run on it. For deployment information, see [deployment][]. The
controller is implemented with [kubebuilder][].

There is also a set of [tools](tools/README.md) used to generate load test
[custom controller]: cmd/controller/main.go
[deployment]: doc/deployment.md
[kubebuilder]: https://kubebuilder.io
[loadtest]: config/crd/bases/e2etest.grpc.io_loadtests.yaml

### Tools

There is a set of [tools](tools/README.md) used to generate load test
configurations, prepare prebuilt images and run batches of tests. These tools
are used to run batches of tests for continuous integration.

### Examples

[Examples](config/samples/README.md) of load test configurations in the
supported languages are also provided.

[custom controller]: cmd/controller/main.go
[deployment]: doc/deployment.md
[kubebuilder]: https://kubebuilder.io
[loadtest]: config/crd/bases/e2etest.grpc.io_loadtests.yaml

## Dashboard

The data generated in continuous integration are saved to [BigQuery][bigquery],
Expand Down

0 comments on commit 986062a

Please sign in to comment.