Skip to content

Commit

Permalink
docs: Replace 'qemu-unpriv' with 'qemu'
Browse files Browse the repository at this point in the history
There is no longer a privileged 'qemu' platform and the 'qemu' and
'qemu-unpriv' platforms are the same.

Let's use qemu everywhere in order to be able to remove all
'qemu-unpriv' usage.
  • Loading branch information
travier committed Feb 3, 2023
1 parent 8588dbe commit 01d7818
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 25 deletions.
7 changes: 3 additions & 4 deletions docs/kola.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,8 @@ inspection.
Kola is still under heavy development and it is expected that its
interface will continue to change.

By default, kola uses the `qemu-unprivileged` platform with the most recently
built image (assuming it is run from within a CoreOS Assembler working
directory).
By default, kola uses the `qemu` platform with the most recently built image
(assuming it is run from within a CoreOS Assembler working directory).

1. TOC
{:toc}
Expand Down Expand Up @@ -212,7 +211,7 @@ After you run the kola test, you can find more information in `tmp/kola/<test-na
Example output:

```
kola -p qemu-unpriv --output-dir tmp/kola testiso -P --qemu-native-4k
kola -p qemu --output-dir tmp/kola testiso -P --qemu-native-4k
Testing scenarios: [iso-offline-install iso-live-login iso-as-disk miniso-install miniso-install-nm]
Detected development build; disabling signature verification
Successfully tested scenario iso-offline-install for 35.20220217.dev.0 on uefi (metal4k)
Expand Down
16 changes: 8 additions & 8 deletions docs/kola/external-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ Here's an example `kola.json`:
{
"architectures": "!s390x ppc64le",
"distros": "fcos",
"platforms": "qemu-unpriv",
"platforms": "qemu",
"tags": "sometagname needs-internet skip-base-checks othertag",
"requiredTag": "special",
"additionalDisks": [ "5G" ],
Expand Down Expand Up @@ -228,7 +228,7 @@ If a test has a `requiredTag`, it is run only if the required tag is specified.
In the example above, the test would only run if `--tag special` was provided.

The `additionalDisks` key has the same semantics as the `--add-disk` argument
to `qemuexec`. It is currently only supported on `qemu-unpriv`.
to `qemuexec`. It is currently only supported on `qemu`.

The `injectContainer` boolean if set will cause the framework to inject
the ostree base image container into the target system; the path can be
Expand All @@ -239,21 +239,21 @@ via `skopeo copy oci-archive:$KOLA_OSTREE_OCIARCHIVE containers-storage:localhos
The `minDisk` key takes a size in GB and ensures that an instance type with at
least the specified amount of primary disk space is used. On QEMU, this is
equivalent to the `--qemu-size` argument to `qemuexec`. This is currently only
enforced on `qemu-unpriv` and `aws`.
enforced on `qemu` and `aws`.

The `minMemory` key takes a size in MB and ensures that an instance type with
at least the specified amount of memory is used. On QEMU, this is equivalent to
the `--memory` argument to `qemuexec`. This is currently only enforced on
`qemu-unpriv`.
`qemu`.

The `additionalNics` key has the same semantics as the `--additional-nics` argument
to `qemuexec`. It is currently only supported on `qemu-unpriv`.
to `qemuexec`. It is currently only supported on `qemu`.

The `appendKernelArgs` key has the same semantics at the `--kargs` argument to
`qemuexec`. It is currently only supported on `qemu-unpriv`.
`qemuexec`. It is currently only supported on `qemu`.

The `appendFirstbootKernelArgs` key has the same semantics at the `--firstbootkargs`
argument to `qemuexec`. It is currently only supported on `qemu-unpriv`.
argument to `qemuexec`. It is currently only supported on `qemu`.

The `timeoutMin` key takes a positive integer and specifies a timeout for the test
in minutes. After the specified amount of time, the test will be interrupted.
Expand Down Expand Up @@ -328,7 +328,7 @@ $ chmod a+x basic/noop # Make sure the test is executable
$ cosa kola run -p qemu --qemu-image path/to/qcow2 -E path/to/my-project/ 'ext.my-project.basic' # Run the test
=== RUN ext.my-project.basic
--- PASS: ext.my-project.basic (35.57s)
PASS, output in _kola_temp/qemu-unpriv-2020-08-18-1815-2295199
PASS, output in _kola_temp/qemu-2020-08-18-1815-2295199
```

## Fast build and iteration on your project's tests
Expand Down
10 changes: 3 additions & 7 deletions docs/mantle/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,16 +186,12 @@ for more information about the `.boto` file.

## qemu

`qemu` is run locally and needs no credentials, but does need to be run as root.

## qemu-unpriv

`qemu-unpriv` is run locally and needs no credentials. It has a restricted set of functionality compared to the `qemu` platform, such as:
`qemu` is run locally and needs no credentials. It has a few restrictions:

- No [Local cluster](platform/local/)
- Usermode networking instead of namespaced networks
- Usermode networking (no namespaced networks):
* Single node only, no machine to machine networking
* Machines have internet access
* Machines have internet access by default

## kubevirt

Expand Down
9 changes: 3 additions & 6 deletions mantle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -372,12 +372,9 @@ The json file should have the following fields at the minimum with the api key b
```

### qemu
`qemu` is run locally and needs no credentials, but does need to be run as root.

### qemu-unpriv
`qemu-unpriv` is run locally and needs no credentials. It has a restricted set of functionality compared to the `qemu` platform, such as:
`qemu` is run locally and needs no credentials. It has a few restrictions:

- No [Local cluster](platform/local/)
- Usermode networking instead of namespaced networks
- Usermode networking (no namespaced networks):
* Single node only, no machine to machine networking
* Machines have internet access
* Machines have internet access by default

0 comments on commit 01d7818

Please sign in to comment.