Skip to content

Commit 6ae0867

Browse files
committed
README: Link to the runtime API docs
Make docs/, which landed in 7a4cb36 (docs/command-line-interface: Add Runtime CLI Spec, 2018-01-09, #321), more discoverable. Also document the 'RUNTIME' option. Signed-off-by: W. Trevor King <[email protected]>
1 parent e6a60ee commit 6ae0867

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

+9
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,17 @@ If your distribution does not package node-tap, you can install [npm][] (for exa
3737
$ npm install tap
3838
```
3939

40+
Build the validation executables:
41+
4042
```console
4143
$ make runtimetest validation-executables
44+
```
45+
46+
Runtime validation currently [only supports](docs/runtime-compliance-testing.md) the [OCI Runtime Command Line Interface](doc/command-line-interface.md).
47+
If we add support for alternative APIs in the future, runtime validation will gain an option to select the desired runtime API.
48+
For the command line interface, the `RUNTIME` option selects the runtime command (`funC` in the [OCI Runtime Command Line Interface](doc/command-line-interface.md)).
49+
50+
```
4251
$ sudo make RUNTIME=runc localvalidation
4352
RUNTIME=runc tap validation/linux_rootfs_propagation_shared.t validation/create.t validation/default.t validation/linux_readonly_paths.t validation/linux_masked_paths.t validation/mounts.t validation/process.t validation/root_readonly_false.t validation/linux_sysctl.t validation/linux_devices.t validation/linux_gid_mappings.t validation/process_oom_score_adj.t validation/process_capabilities.t validation/process_rlimits.t validation/root_readonly_true.t validation/linux_rootfs_propagation_unbindable.t validation/hostname.t validation/linux_uid_mappings.t
4453
validation/linux_rootfs_propagation_shared.t ........ 18/19

0 commit comments

Comments
 (0)