Skip to content

Commit

Permalink
Maybe I didn't miss anything.
Browse files Browse the repository at this point in the history
  • Loading branch information
dbutenhof committed Apr 5, 2023
1 parent d3ab44e commit 9c234e4
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 24 deletions.
6 changes: 0 additions & 6 deletions docs/API/V1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,6 @@ artifacts, and the archived tarball. The resource ID becomes invalid subsequentl
unless a new dataset is created with the same checksum value. (This is highly
unlikely, unless the same Pbench Agent tarball is uploaded again.)

A user resource is the "owner" of each [dataset](#datasets) managed by the
Pbench Server. If a user is deleted, then any datasets owned by that user
become orphaned; datasets with `public` access are still accessible to other
users, and `private` datasets are accessible through the `ADMIN` user role (see
[access model](../access_model.md)).

### Metadata

Metadata resources are secondary resources tied to a dataset resource and, for
Expand Down
2 changes: 1 addition & 1 deletion docs/API/V1/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ from the "pbench-fio" script.
_NOTE_: `filter` expression values, like the `true` in
`GET /api/v1/datasets?filter=server.archiveonly:true`, are always interpreted
as strings, so be careful about the string representation of the value (in this
case, a boolean, which is represented in JSON as "true" or "false"). Beware
case, a boolean, which is represented in JSON as `true` or `false`). Beware
especially when attempting to match a JSON document (such as
`dataset.metalog.pbench`).

Expand Down
6 changes: 3 additions & 3 deletions docs/API/V1/server_audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ all upload or index operations.
* `upload`: A dataset was uploaded to the server.

### `object_id`
Select by the object ID. For datasets, this is the `resource_id`; for users it's
the OIDC ID, and for server configuration settings there is no ID. This allows
selecting datasets (or users) that no longer exist, using the original values.
Select by the object ID: the `resource_id` for datasets, or the OIDC ID for
users. (Server configuration settings have no ID.) This allows
selecting datasets or users that no longer exist, or have been renamed.

### `object_name`
Select by the name of an object at the time the audit record was generated. If
Expand Down
10 changes: 5 additions & 5 deletions docs/API/V1/upload.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ You can set the initial resource name (`dataset.name`), for example, as well as
assigning any keys in the `global` and `user` namespaces. See
[metadata](../metadata.md) for more information.

In particular the client can set the
[default dataset name](../metadata.md#datasetname), the
[dataset origin](../metadata.md#serverorigin),
[disable indexing](../metadata.md#serverarchiveonly), and override the
[default dataset expiration time](../metadata.md#serverdeletion).
In particular the client can set any of:
* `dataset.name`: [default dataset name](../metadata.md#datasetname)
* `server.origin`: [dataset origin](../metadata.md#serverorigin)
* `server.archiveonly`: [suppress indexing](../metadata.md#serverarchiveonly)
* `server.deletion`: [default dataset expiration time](../metadata.md#serverdeletion).

For example, `?metadata=server.archiveonly:true,global.project:oidc`

Expand Down
8 changes: 3 additions & 5 deletions docs/API/access_model.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@ the administrator *role*, can UPDATE or DELETE the dataset.

## Roles

The Pbench Server acess model allows assigning an `ADMIN` role to one or more
The Pbench Server access model allows assigning an `ADMIN` role to one or more
user accounts through the OIDC identity provider. These users will be granted
full CRUD access to all server data, including

- All datasets
- Server configuration settings
full CRUD access to all server data, including all datasets, server settings,
and audit logs.

## Groups

Expand Down
7 changes: 3 additions & 4 deletions docs/API/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ to exist if the associated dataset is deleted.
### Dataset namespace

This defines the dataset resource, and contains metadata received from the
Pbench Agent, including the full contents of a `metadata.log` file created
while gathering results and during dataset packaging.
Pbench Agent, including the full contents of a `metadata.log` file if one is
present in the tarball. (Support for additional tarball formats is TBD.)

The `metadata.log` data is represented under the key `dataset.metalog` and can
be queried as part of the entire dataset using the `dataset` key, as a discrete
Expand Down Expand Up @@ -129,8 +129,7 @@ analysis but the server will do nothing else with it. The value can be
specified as "t", "true", "y" or "yes" (case insensitive) for True, and "f",
"false", "n", or "no" (also case insensitive) for False. Note that this is
currently only interpreted by the Pbench Server when a dataset is first
uploaded, and will inhibit unpacking and indexing the dataset. It can be
changed later, but the server currently takes no action on such changes.
uploaded, and has no effect if modified later.

#### `server.origin`

Expand Down

0 comments on commit 9c234e4

Please sign in to comment.