Bug 1810032

Summary: [Docs][API] Default value of network-filter for vnic-profile entity is not documented
Product: [oVirt] ovirt-distribution Reporter: msheena
Component: ovirt-engine-api-modelAssignee: Ales Musil <amusil>
Status: CLOSED CURRENTRELEASE QA Contact: msheena
Severity: low Docs Contact:
Priority: unspecified    
Version: ---CC: amusil, bugs, dholler, mburman, oliel
Target Milestone: ovirt-4.5.0Flags: pm-rhel: ovirt-4.5?
Target Release: 4.5.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ovirt-engine-api-model-4.5.1 ovirt-engine-4.5.0 Doc Type: Bug Fix
Doc Text:
Default value of network-filter for vnic-profile entity has been documented in REST API documentation.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2022-04-20 06:33:59 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: Network RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
Verification screen-shot none

Description msheena 2020-03-04 13:01:06 UTC 
Description of problem
======================
The default value for a network filter is not documented at [1].
In the example provided for creating a vnic-profile at [2] it is noted: "The automatically created vNIC profile for the external network will be without network filter", however that is not the case.

Also it says: "In case no network filter was given, the default network filter will be configured", yet this "default" is not mentioned.

It is also stated that: "For more details of how the default network filter is calculated please refer to the documentation in NetworkFilters.", but there is no documentation of the default network-filter.

I believe it should be stated what is the default network-filter per each type of network (vm, physical, ovn etc..).

[1] - http://ovirt.github.io/ovirt-engine-api-model/4.4/#services/vnic_profiles
[2] - http://ovirt.github.io/ovirt-engine-api-model/4.4/#services/vnic_profiles/methods/add

Version-Release number of selected component (if applicable)
============================================================
ovirt-engine-4.4.0-0.24.master.el8ev.noarch
Comment 1 Sandro Bonazzola 2022-03-16 17:24:50 UTC 
$ git tag --contains 4df5ac7eee5c2619feb1226cd03e7e0904b68709
4.5.1
4.5.2
Comment 2 Sandro Bonazzola 2022-03-16 17:34:07 UTC 
ovirt-engine-api-model-4.5.1 rpm is not available.
It's currently bundled within ovirt-engine:

git tag --contains a216da9fe7983d468e9686cc0c6058cdefca6080
ovirt-engine-4.5.0
ovirt-engine-4.5.0_alpha1

commit a216da9fe7983d468e9686cc0c6058cdefca6080
Author: Ori Liel <oliel>
Date:   Tue Nov 16 15:00:03 2021 +0200

    bump model (4.5.1) and metamodel (1.3.7)
    
    Model changes since current version (4.5.0):
    
    * Bump metamodel version to 1.3.7
    * Bumpy puppycrawl version to 8.29
    * Document default network filter
      (https://bugzilla.redhat.com/1810032)
    
    Metamodel changes since current version (1.3.4)
    
    * Anchor Links-Summary table in adoc
      (https://bugzilla.redhat.com/1978582)
    
    Signed-off-by: Ori Liel <oliel>
    Change-Id: I8c58e28c2001704e7923dd88117383b6f1527f35
Comment 3 msheena 2022-03-22 14:25:07 UTC 
Verified at http://ovirt.github.io/ovirt-engine-api-model/4.5/#services/vnic_profiles/methods/add

A note has been added saying: 'The automatically created vNIC profile for the external network will be without network filter.'
This explicitly states what is the default network-filter and answers the bug.
Comment 4 msheena 2022-03-22 14:30:16 UTC 
Created attachment 1867505 [details]
Verification screen-shot

The screenshot shows the added note: 'The automatically created vNIC profile for the external network will be without network filter.'
Comment 5 Sandro Bonazzola 2022-04-20 06:33:59 UTC 
This bugzilla is included in oVirt 4.5.0 release, published on April 20th 2022.

Since the problem described in this bug report should be resolved in oVirt 4.5.0 release, it has been closed with a resolution of CURRENT RELEASE.

If the solution does not work for you, please open a new bug report.