Skip to content

[master] gvforwarder as a systemd service#1061

Merged
praveenkumar merged 2 commits intocrc-org:masterfrom
openshift-cherrypick-robot:cherry-pick-1052-to-master
May 16, 2025
Merged

[master] gvforwarder as a systemd service#1061
praveenkumar merged 2 commits intocrc-org:masterfrom
openshift-cherrypick-robot:cherry-pick-1052-to-master

Conversation

@openshift-cherrypick-robot
Copy link
Copy Markdown

@openshift-cherrypick-robot openshift-cherrypick-robot commented May 16, 2025 •
edited by sourcery-ai bot
Loading

This is an automated cherry-pick of #1052

/assign praveenkumar

Summary by Sourcery

Enable gvforwarder as a systemd-managed service by installing the required package, creating a tap network device, and configuring and enabling a systemd service template

New Features:

Enhancements:

  • Include gvisor-tap-vsock-gvforwarder in installer dependencies
  • Provision tap0 network interface inside the VM with a fixed MAC address for predictable networking

vyasgun and others added 2 commits May 16, 2025 05:48
@vyasgun
gvforwarder as a systemd service
ddecfb6 
- Create a tap device using nmcli with a hardcoded mac address
- Start gvforwarder systemd service which will use this device

Signed-off-by: vyasgun <vyasgun20@gmail.com>
@praveenkumar
Use gvisor-tap-vsock-gvforwarder package instead image
0d6d31a 
Signed-off-by: Praveen Kumar <kumarpraveen.nitdgp@gmail.com>
@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request May 16, 2025
Merged
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented May 16, 2025 •
edited
Loading

Reviewer's Guide

This PR automates deployment of gvisor’s tap-vsock forwarder by extending createdisk.sh: it installs the new package, configures a tap interface on the VM via nmcli, defines a systemd unit that runs podman’s gvforwarder, and enables it at boot.

Sequence Diagram: Setup of gvforwarder Service by createdisk.sh

sequenceDiagram
    actor ScriptRunner as "User/CI"
    participant CSH as "createdisk.sh"
    participant VM
    participant NM as "NetworkManager (on VM)"
    participant SD as "systemd (on VM)"

    ScriptRunner ->> CSH: Execute script
    CSH ->> VM: SSH: Install 'gvisor-tap-vsock-gvforwarder' package
    activate VM
    VM -->> CSH: Package installed
    deactivate VM

    CSH ->> VM: SSH: 'nmcli connection add type tun ifname tap0 ...'
    activate VM
    VM ->> NM: Create & Configure tap0 interface
    activate NM
    NM -->> VM: tap0 configured
    deactivate NM
    VM -->> CSH: tap0 setup complete
    deactivate VM

    CSH ->> VM: SSH: Write '/etc/systemd/system/gv-user-network@.service' file
    activate VM
    VM -->> CSH: Service file created
    deactivate VM

    CSH ->> VM: SSH: 'systemctl daemon-reload'
    activate VM
    VM ->> SD: Reload unit files
    activate SD
    SD -->> VM: Units reloaded
    deactivate SD
    VM -->> CSH: Daemon reloaded
    deactivate VM

    CSH ->> VM: SSH: 'systemctl enable gv-user-network@tap0.service'
    activate VM
    VM ->> SD: Enable service for tap0 device
    activate SD
    SD -->> VM: Service enabled for boot
    deactivate SD
    VM -->> CSH: Service enabled
    deactivate VM
Loading

File-Level Changes

Change Details Files
Include gvforwarder package in installation
  • Updated ADDITIONAL_PACKAGES to add gvisor-tap-vsock-gvforwarder
 createdisk.sh
Automate tap0 interface creation on VM
  • Added SSH commands to run nmcli connection add for tap0 with a fixed MAC address
 createdisk.sh
Introduce and enable gv-user-network@.service
  • Replaced podman container file snippet with a systemd unit using tee
  • Configured service stanza, dependencies (NetworkManager, device), and environment for gvforwarder
  • Reloaded systemd daemon and enabled gv-user-network@tap0.service on the VM
 createdisk.sh
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@openshift-ci openshift-ci bot requested review from anjannath and cfergeau May 16, 2025 05:48
@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented May 16, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign cfergeau for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented May 16, 2025

Hi @openshift-cherrypick-robot. Thanks for your PR.

I'm waiting for a crc-org member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@praveenkumar
Copy link
Copy Markdown
Member

praveenkumar commented May 16, 2025

/ok-to-test

@openshift-ci
Copy link
Copy Markdown

openshift-ci bot commented May 16, 2025

@openshift-cherrypick-robot: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-microshift-arm 0d6d31a link true /test e2e-microshift-arm
ci/prow/e2e-microshift 0d6d31a link true /test e2e-microshift
ci/prow/e2e-snc 0d6d31a link true /test e2e-snc

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@praveenkumar praveenkumar merged commit 0a9fd8f into crc-org:master May 16, 2025
1 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@anjannath anjannath Awaiting requested review from anjannath

@cfergeau cfergeau Awaiting requested review from cfergeau

Assignees

@praveenkumar praveenkumar

Labels

ok-to-test

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@openshift-cherrypick-robot @praveenkumar @vyasgun