Skip to content

Conversation

ShadowCurse
Copy link
Contributor

Changes

Make it more clear that the iface_id is only used internally in Firecracker.
Move information about the order of network interface creation and network interface names in the guest from FAQ into network-setup.md.

Reason

Fixes: #5369

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkbuild --all to verify that the PR passes
    build checks on all supported architectures.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

@ShadowCurse ShadowCurse self-assigned this Aug 15, 2025
@ShadowCurse ShadowCurse added Status: Awaiting review Indicates that a pull request is ready to be reviewed Type: Documentation Indicates a need for improvements or additions to documentation labels Aug 15, 2025
@ShadowCurse ShadowCurse force-pushed the network_doc branch 7 times, most recently from 8a06ca3 to 9ecd766 Compare August 15, 2025 16:23
@ShadowCurse ShadowCurse force-pushed the network_doc branch 2 times, most recently from b0c875f to 4fff73e Compare August 18, 2025 11:36
Make it more clear that the `iface_id` is only used internally
in Firecracker.
Move information about the order of network interface creation
and network interface names in the guest from FAQ into
network-setup.md.

Signed-off-by: Egor Lazarchuk <[email protected]>
There is no need to repeat that SendCtrlAltDel
is x86_64 only when the header of the section says
so already.

Signed-off-by: Egor Lazarchuk <[email protected]>
Instead of **Note** syntax we can use GitHub
version [!NOTE] to have a better visuals.

Signed-off-by: Egor Lazarchuk <[email protected]>
@Manciukic Manciukic enabled auto-merge (rebase) August 20, 2025 13:26
@Manciukic Manciukic merged commit 57ea0a3 into firecracker-microvm:main Aug 20, 2025
5 checks passed
@ShadowCurse ShadowCurse deleted the network_doc branch August 20, 2025 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Awaiting review Indicates that a pull request is ready to be reviewed Type: Documentation Indicates a need for improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug] Documents about network interface name in guest contradict each other.

3 participants