Skip to content

Commit f12008a

Browse files
committed
Update README
1 parent 538aa9a commit f12008a

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.rst

+19-9
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,30 @@ Usage
1212

1313
Command line summary::
1414

15-
usage: nspawn-runner [-h] [-v] [--debug]
16-
{chroot-create,chroot-login,prepare,run,cleanup,gitlab-config,toml}
15+
usage: nspawn-runner [-h] [-v] [--debug] [--ram-disk]
16+
{chroot-list,chroot-create,chroot-login,chroot-maintenance,prepare,run,cleanup,gitlab-config,toml}
1717
...
18-
18+
1919
Manage systemd-nspawn machines for CI runs.
20-
20+
2121
positional arguments:
22-
{chroot-create,chroot-login,prepare,run,cleanup,gitlab-config,toml}
22+
{chroot-list,chroot-create,chroot-login,chroot-maintenance,prepare,run,cleanup,gitlab-config,toml}
2323
sub-command help
24-
chroot-create create a chroot that serves as a base for ephemeral
25-
machines
24+
chroot-list list available chroots
25+
chroot-create create a chroot that serves as a base for ephemeral machines
2626
chroot-login enter the chroot to perform maintenance
27+
chroot-maintenance perform routine maintenance of chroots
2728
prepare start an ephemeral system for a CI run
2829
run run a command inside a CI machine
2930
cleanup cleanup a CI machine after it's run
3031
gitlab-config configuration step for gitlab-runner
3132
toml output the toml configuration for the custom runner
32-
33-
optional arguments:
33+
34+
options:
3435
-h, --help show this help message and exit
3536
-v, --verbose verbose output
3637
--debug verbose output
38+
--ram-disk use ram disks
3739

3840
Steps:
3941

@@ -73,9 +75,17 @@ __ https://github.com/Truelite/nspawn-runner/issues/3
7375
* ``nspawn_runner_chroot_suite``: suite to use for debootstrap
7476
* ``nspawn_runner_maint_recreate``: set to true to always recreate the chroot
7577
during maintenance. See `issue #4`__ for details.
78+
* ``nspawn_runner_cpu_weight``: enable CPU accounting and set CPUWeight to this value. Defaults to 50. Set null to disable.
79+
* ``nspawn_runner_memory_high``: enable memory accounting and set MemoryHigh to this value. Defaults to 30%. Set null to disable.
80+
* ``nspawn_runner_memory_max``: enable memory accounting and set MemoryMax to this value. Defaults to 40%. Set null to disable.
81+
* ``nspawn_runner_seccomp``: set to true to enable seccomp filtering. Defaults to false (SYSTEMD_SECCOMP=0) to improve performance.
7682

7783
__ https://github.com/Truelite/nspawn-runner/issues/4
7884

85+
Please refer to the `systemd documentation`__ for more details on resource control.
86+
87+
__ https://www.freedesktop.org/software/systemd/man/systemd.resource-control.html
88+
7989
If ``nspawn-runner chroot-create`` finds a matching playbook, it will get
8090
creation defaults from it, and run the playbook to customize the chroot after
8191
creation.

0 commit comments

Comments
 (0)