Skip to content

Commit a5d88d4

Browse files
README: use latest container tag in the examples
We recently changed the container tags from vNN to gSHA-1, but we didn't update README.md. Also, we now push `latest`, which is always updated, so use this tag in the examples and mention to look at CONTAINER_VERSION in .buildkite/autogenerate_pipeline.py for a specific version. Reported-by: Hanna Czenczek <[email protected]> Signed-off-by: Stefano Garzarella <[email protected]>
1 parent 659de9e commit a5d88d4

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ steps:
163163
platform: x86_64.metal
164164
plugins:
165165
- docker#v3.8.0:
166-
image: rustvmm/dev:v16
166+
image: rustvmm/dev:latest
167167
always-pull: true
168168
timeout_in_minutes: 5
169169
```
@@ -244,14 +244,15 @@ coverage before submitting a PR, run the coverage test:
244244

245245
```bash
246246
CRATE="kvm-ioctls"
247-
# NOTE: This might not be the latest container version, you can check which one we're using
248-
# by looking into the .buildkite/autogenerate_pipeline.py file.
249-
LATEST=16
247+
# NOTE: `latest` should point to the latest version, but you can specify an exact
248+
# one as we do with CONTAINER_VERSION in .buildkite/autogenerate_pipeline.py file.
249+
TAG="latest"
250+
docker pull rustvmm/dev:${TAG}
250251
docker run --device=/dev/kvm \
251252
-it \
252253
--security-opt seccomp=unconfined \
253254
--volume $(pwd)/${CRATE}:/${CRATE} \
254-
rustvmm/dev:v${LATEST}
255+
rustvmm/dev:${TAG}
255256
cd ${crate}
256257
pytest --profile=devel rust-vmm-ci/integration_tests/test_coverage.py
257258
```
@@ -292,7 +293,7 @@ steps:
292293
platform: arm.metal
293294
plugins:
294295
- docker#v3.8.0:
295-
image: rustvmm/dev:v16
296+
image: rustvmm/dev:latest
296297
always-pull: true
297298
```
298299
@@ -330,11 +331,15 @@ pipeline output. In its present form, the test cannot fail.
330331
To run the test locally:
331332

332333
```bash
334+
# NOTE: `latest` should point to the latest version, but you can specify an exact
335+
# one as we do with CONTAINER_VERSION in .buildkite/autogenerate_pipeline.py file.
336+
TAG="latest"
337+
docker pull rustvmm/dev:${TAG}
333338
docker run --device=/dev/kvm \
334339
-it \
335340
--security-opt seccomp=unconfined \
336341
--volume $(pwd)/${CRATE}:/${CRATE} \
337-
rustvmm/dev:v${LATEST}
342+
rustvmm/dev:${TAG}
338343
cd ${CRATE}
339344
pytest rust-vmm-ci/integration_tests/test_benchmark.py -s
340345
```
@@ -351,14 +356,15 @@ that autogenerates the pipeline. For example:
351356
```bash
352357
cd ~/vm-superio
353358
CRATE="vm-superio"
354-
# NOTE: This might not be the latest container version, you can check which one we're using
355-
# by looking into the .buildkite/autogenerate_pipeline.py file.
356-
LATEST=16
359+
# NOTE: `latest` should point to the latest version, but you can specify an exact
360+
# one as we do with CONTAINER_VERSION in .buildkite/autogenerate_pipeline.py file.
361+
TAG="latest"
362+
docker pull rustvmm/dev:${TAG}
357363
docker run -it \
358364
--security-opt seccomp=unconfined \
359365
--volume $(pwd):/${CRATE} \
360366
--volume ~/.ssh:/root/.ssh \
361-
rustvmm/dev:v${LATEST}
367+
rustvmm/dev:${TAG}
362368
cd vm-superio
363369
./rust-vmm-ci/test_run.py
364370
```

0 commit comments

Comments
 (0)