Skip to content

docs: fix links, add more GHA examples #4131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 5, 2025
Merged

docs: fix links, add more GHA examples #4131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7a1eb4
docs: fix links
AkihiroSuda Oct 3, 2025
da9f98b
docs: examples/gha: add more examples
AkihiroSuda Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pkg/driver/qemu/qemu.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ type Config struct {
// softMin must be >= hardMin.
//
// When updating this function, make sure to update
// `website/content/en/docs/config/vmtype.md` too.
// `website/content/en/docs/config/vmtype/qemu.md` too.
func minimumQemuVersion() (hardMin, softMin semver.Version) {
var h, s string
switch runtime.GOOS {
Expand Down
16 changes: 15 additions & 1 deletion website/content/en/docs/examples/gha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,18 @@ The `--plain` mode is useful when you want the VM instance to be as close as pos
```

### Full examples
- https://github.com/kubernetes-sigs/kind/blob/v0.25.0/.github/workflows/vm.yaml#L47-L84
Kubernetes:
- [kind, for running tests with SELinux using Fedora](https://github.com/kubernetes-sigs/kind/blob/v0.30.0/.github/workflows/vm.yaml#L46-L71)
- [Usernetes, for running tests with multiple nodes](https://github.com/rootless-containers/usernetes/blob/gen2-v20250828.0/.github/workflows/reusable-multi-node.yaml#L52-L61)

Container engines:
- [Docker (Moby), for running tests with cgroup v1 using Oracle Linux 8 ](https://github.com/moby/moby/blob/master/.github/workflows/.vm.yml)
- [nerdctl, for running tests with cgroup v1 using AlmaLinux 8](https://github.com/containerd/nerdctl/blob/v2.1.6/.github/workflows/job-test-in-lima.yml)

Container runtimes:
- [runc, for running tests with SELinux using Fedora](https://github.com/opencontainers/runc/blob/v1.3.2/.github/workflows/test.yml#L182-L202)
- [opencontainers/selinux, for running tests with SELinux using AlmaLinux, CentOS Stream, Fedora, and openSUSE](https://github.com/opencontainers/selinux/blob/v1.12.0/.github/workflows/validate.yml#L106-L133)
- [youki, for running tests with cgroup v1 using AlmaLinux 8](https://github.com/youki-dev/youki/blob/v0.5.5/.github/workflows/e2e.yaml#L206-L227)

Others:
- [uutils coreutils, for running tests with SELinux using Fedora](https://github.com/uutils/coreutils/blob/0.2.2/.github/workflows/GnuTests.yml#L190-L225)
6 changes: 3 additions & 3 deletions website/content/en/docs/faq/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Note: **Only** on macOS versions **before** 10.15.7 you might need to add this e
#### "QEMU is slow"
{{% fixlinks %}}
- Make sure that HVF is enabled with `com.apple.security.hypervisor` entitlement. See ["QEMU crashes with `HV_ERROR`"](#qemu-crashes-with-hv_error).
- Emulating non-native machines (ARM-on-Intel, Intel-on-ARM) is slow by design. See [`docs/multi-arch.md`]({{< ref "/docs/config/multi-arch" >}}) for a workaround.
- Emulating non-native machines is slow by design. See [`Configuration guide » Intel-on-ARM and ARM-on-Intel`]({{< ref "/docs/config/multi-arch" >}}) for a workaround.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Wondering if there is a short code to generate this breadcrumb)

{{% /fixlinks %}}

#### error "killed -9"
Expand All @@ -195,7 +195,7 @@ The default guest IP 192.168.5.15 is not accessible from the host and other gues

To add another IP address that is accessible from the host and other virtual machines, enable [`socket_vmnet`](https://github.com/lima-vm/socket_vmnet) (since Lima v0.12).

See [`docs/network.md`]({{< ref "/docs/config/network" >}}).
See [`Configuration guide » Network`]({{< ref "/docs/config/network" >}}).
{{% /fixlinks %}}

#### "Ping shows duplicate packets and massive response times"
Expand All @@ -221,7 +221,7 @@ sudo /usr/libexec/ApplicationFirewall/socketfilterfw --unblock /usr/libexec/boot
### Filesystem sharing
#### "Filesystem is slow"
{{% fixlinks %}}
Try virtiofs. See [`docs/mount.md`]({{< ref "/docs/config/mount" >}})
Try virtiofs. See [`Configuration guide » Filesystem mounts`]({{< ref "/docs/config/mount" >}})
{{% /fixlinks %}}

#### "Filesystem is not writable"
Expand Down