Skip to content

Commit 389477b

Browse files
committed
Some cleanup
1 parent cdb1755 commit 389477b

File tree

4 files changed

+24
-21
lines changed

4 files changed

+24
-21
lines changed

docs/Agent/agent.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
# Pbench Agent
22

3-
The Pbench Agent manages performance experiments, controlling artificial
4-
benchmark execution and gathering additional performance data while they
5-
run.
3+
The Pbench Agent manages performance experiments and collects the data for
4+
analysis. The Agent CLI controls the execution of predefined synthetic
5+
benchmarks (such as fio and uperf) and allows execution of generic workloads
6+
(via [pbench-user-benchmark](user-guide/man_page.md#pbench-user-benchmark))
7+
while gathering and managing additional selected performance data
8+
([pbench-register-tool-set](user-guide/man_page.md#pbench-register-tool-set)).
69

710
For more information, see [Getting Started](user-guide/getting_started.md)
811
and [Man Page](user-guide/man_page.md).

docs/Dashboard/user_guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ It has three components.
1717

1818
![Overview](assets/images/Overview.png)
1919

20-
The *User Profile* page can be used to view profile information from the OIDC authentication as well as to view and manage Pbench Server API keys. This page is accessed by selecting the *My profile* option from the dropdown menu activated by clicking on the username at the right end of the header bar.
20+
The _User Profile_ page can be used to view profile information from the OIDC authentication as well as to view and manage Pbench Server API keys. This page is accessed by selecting the *My profile* option from the dropdown menu activated by clicking on the username at the right end of the header bar.
2121

2222
From this page, Pbench Server API keys can be created by clicking on the *New API Key* button; existing keys are listed with their labels and creation dates; and, the keys can be copied or deleted using the icon buttons.
2323

docs/Server/API/access_model.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ the administrator *role*, can UPDATE or DELETE the dataset.
1919

2020
## User Identity
2121

22-
The Pbench Server works with an external OIDC identity provider, for example
23-
Red Hat, Google, or GitHub SSO. The Pbench Server authenticates user access using
24-
the OIDC JWT tokens. The token's encoded `sub` field is the primary "user ID"
25-
controlling ownership of and access to data. The token's `preferred_username`
26-
field will be remembered and used when trying to report the "user ID" in human
27-
readable form.
22+
The Pbench Server must be configured with an external OIDC identity provider,
23+
such as Red Hat, Google, or GitHub. The Pbench Server authenticates user access
24+
by validating signed OIDC JWT tokens. The token's encoded `sub` field is the
25+
primary "user ID" controlling ownership of and access to data. The Pbench
26+
Server caches each token's `sub` UUID and `preferred_username` to translate
27+
user ID values back into human readable form.
2828

2929
## Roles
3030

docs/Server/API/api.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Pbench Server API documentation
22

3-
The Pbench Server API provides the interface to Pbench data for use by the UI
4-
dashboard as well as any other web clients.
3+
The Pbench Server API provides a RESTful HTTPS interface to curated Pbench
4+
performance data for use by the UI dashboard as well as any other web clients.
55

6-
The Pbench Server provides a set of HTTP endpoints to manage user
7-
authentication and curated performance information, called "dataset resources"
8-
or just "datasets". A dataset represents the aggregation of server artifacts
9-
associated with the results of a performance experiment, for example the
10-
benchmarked workload and tool data collected from `pbench-fio` or from
11-
`pbench-user-benchmark`.
6+
The performance results data associated with an experiment is collectively
7+
referred to as a "dataset". The dataset resource is initially defined by the
8+
".tar.xz" tar ball uploaded to the Pbench Server. The server extracts and
9+
creates metadata describing the dataset, and (if appropriate) indexes synthetic
10+
benchmark data in Elasticsearch to support later analysis.
1211

13-
The [V1 API](V1/README.md) provides a RESTful functional interface oriented
14-
around the "dataset" resource.
12+
The [V1 API](V1/README.md) provides access to the original tar ball, the
13+
original performance results file structure within the tarball, Pbench Server
14+
[metadata](metadata.md), and the Elasticsearch indexed data.
1515

1616
The Pbench Server APIs accept parameters from a variety of sources. See the
1717
individual API documentation for details.
1818
1. Some parameters, especially "resource ids", are embedded in the URI, such as
1919
`/api/v1/datasets/<resource_id>`;
2020
2. Some parameters are passed as query parameters, such as
21-
`/api/v1/datasets?name:fio`;
21+
`/api/v1/datasets?filter=server.benchmark:fio`;
2222
3. For `PUT` and `POST` APIs, some parameters may be passed as a JSON
2323
(`application/json` content type) request payload, such as
2424
`{"metadata": {"dataset.name": "new name"}}` or as an `application/octet-stream`

0 commit comments

Comments
 (0)