feat: add docs for vmnet config in finch.yaml#216
Open
ayush-panta wants to merge 1 commit into
Open
Conversation
Signed-off-by: ayush-panta <ayushkp@amazon.com>
ayush-panta
force-pushed
the
update-shared-networking-docs
branch
from
dc4b05e to
90e24ac
Compare
ayush-panta
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of changes:
Adds documentation for the new
vmnetconfiguration option in the configuration reference. This option was introduced in runfinch/finch#1749 to make socket_vmnet opt-in rather than force-installed. Previously, everyfinch vm initrequired sudo to install socket_vmnet regardless of whether shared networking was needed.With this change:
vmType: qemuusers who need shared networking explicitly setvmnet: true(sudo required once)vmType: vzusers who setvmnet: trueget vzNAT networking automatically with no privilege escalationvmnetunset/false): No sudo prompt, no socket_vmnet (the majority use case)Terms of contribution:
By submitting this pull request, I confirm that my contribution is made under the terms of the licenses outlined in the LICENSE-SUMMARY file.