linux-system-roles / network

An ansible role to configure networking
https://linux-system-roles.github.io/network/
BSD 3-Clause "New" or "Revised" License
238 stars 106 forks source link

docs: Add MAC VTAP example #679

Closed marituhone closed 8 months ago

marituhone commented 8 months ago

Enhancement: Improved Configuration for MAC VTAP

Reason: The current setup process for MAC VTAP lacks a standardized and reusable approach,Currently we are supporting MAC VTAP as "tap": True in macvlan. To address this, this pull request introduces a yml file, "macvtap.yml", to provide a structured method for configuring MAC VTAP. This enhancement aims to simplify the setup process and improve the usability of MAC VTAP.

Result: With the addition of the YAML "macvtap.yml" file, users can easily define and modify MAC VTAP settings by modifying this file. This will streamline the configuration process and enable users to customize MAC VTAP according to their specific requirements.

Issue Tracker Tickets (Jira or BZ if any): issue #285

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 45.00%. Comparing base (ab77dd1) to head (d029c11).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #679 +/- ## =========================================== + Coverage 20.50% 45.00% +24.49% =========================================== Files 10 12 +2 Lines 1478 3100 +1622 Branches 433 433 =========================================== + Hits 303 1395 +1092 - Misses 1174 1704 +530 Partials 1 1 ``` | [Flag](https://app.codecov.io/gh/linux-system-roles/network/pull/679/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=linux-system-roles) | Coverage Δ | | |---|---|---| | [sanity](https://app.codecov.io/gh/linux-system-roles/network/pull/679/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=linux-system-roles) | `20.50% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=linux-system-roles#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

liangwen12year commented 8 months ago

PR Title lint is failed, you can take a look at https://linux-system-roles.github.io/contribute.html, specifically the section about Write a good PR title and description. In short, you can change the title into docs: Add MAC VTAP example.

liangwen12year commented 8 months ago

Can you squash the PR into only one commit with the commit title docs: Add MAC VTAP example.

spetrosi commented 8 months ago

Can you squash the PR into only one commit with the commit title docs: Add MAC VTAP example.

fyi, we moved the requirement to indicate change type to the PR title only. Commits now can be in any form. Though I like to still add a type: prefix to the commit for clarity.

liangwen12year commented 8 months ago

https://medium.com/@slamflipstrom/a-beginners-guide-to-squashing-commits-with-git-rebase-8185cf6e62ec, please look at this guide on how to squash the commits.

marituhone commented 8 months ago

@liangwen12year i squashed them

liangwen12year commented 8 months ago

@liangwen12year i squashed them

Can you check why the pr also has the commit - Merge branch 'linux-system-roles:main' into issueFix ?

marituhone commented 8 months ago

@liangwen12year i have fixed it

liangwen12year commented 8 months ago

@liangwen12year i have fixed it

@marituhone thanks for contributing to it.

liangwen12year commented 8 months ago

Nit-picking, can you change the commit title to docs: Add MAC VTAP example?