Skip to content

style: Reword to include network shield references #210

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
danielvallance merged 1 commit into from
Jul 3, 2026
Merged

style: Reword to include network shield references #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions pages/features/custom-network-configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ This lets you reference one instance's interface from another.
When enabled, the guest configures the interface for you.
Disable it to leave the interface untouched, so your app or image can set up networking on its own.

### Relay
### Network Shield and Relay

@unikraft-bot unikraft-bot Jul 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Headings] 'Network Shield and Relay' should use sentence-style capitalization.


The relay feature lets you redirect all network traffic from and to a network interface to another network interface.
In practice, this means you can set up a gateway or proxy VM and configure its network interface as the relay for another VM's network interface.

This is useful in sandbox environments - as a gateway or proxy can inspect, filter, and inject data into the sandbox's traffic.
In this setup, the sandbox doesn't need unfiltered network access or access to secrets.
The network shield feature provides the ability to transparently insert a “shield” between a microVM and the public Internet.
The shield provides filtering capabilities but also the possibility to inject credentials/secrets for agentic or other use cases.
This is useful in sandbox environments - as it means the sandbox will not need unfiltered network access or access to secrets.

@unikraft-bot unikraft-bot Jul 3, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'won't' instead of 'will not'.

The shield relies on a relay feature that redirects all network traffic to and from a network interface toward another network interface.
This allows for setting up a gateway/proxy VM and configure its interface as the relay for another VM's interface.

To use a relay, reference another interface by name inside a `relay` object:

Expand Down
Loading