System CLI Interface naming rule inconsistency

Bug #1983614 reported by Mohammad Issa
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
StarlingX
Fix Released
Low
Mohammad Issa

Bug Description

Brief Description
-----------------------------

Starling-X API does not allow to use "-" or "." in its interface name. So this command will cause error.

[sysadmin@controller-1 ~(keystone_admin)]$ system host-if-add -c pci-sriov -N 1 --vf-driver netdevice worker-0 vf-2 vf ens3f1
Cannot use special characters in interface name.

In this case, interface "vf-2" use "-(hyphen)" in its name. But Starling-X does not allow to its interface name.

Severity
-----------------------------

<Minor: System/Feature is usable with minor issue>

Steps to Reproduce
-----------------------------

Use "-" in interface name.

system host-if-add -c pci-sriov -N 1 --vf-driver netdevice worker-0 vf-2 vf ens3f1

-> Will cause error.

Expected Behavior
-----------------------------

consistent naming rule should be used.

Actual Behavior
-----------------------------

Naming rule is inconsistent. Conflict Starling-X naming rule and other naming rules

Reproducibility
-----------------------------

Reproducible

System Configuration
-----------------------------

N/A

Load info (eg: 2022-03-10_20-00-07)
-----------------------------

N/A

Last Pass
-----------------------------

N/A

Timestamp/Logs
-----------------------------

N/A

Alarms
-----------------------------

N/A

Test Activity
-----------------------------

N/A

Workaround
-----------------------------

Avoid to use "-" in interface name.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to config (master)

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/config/+/852207

Changed in starlingx:
status: New → In Progress
Ghada Khalil (gkhalil)
Changed in starlingx:
importance: Undecided → Low
assignee: nobody → Mohammad Issa (m-issa)
tags: added: stx.8.0 stx.networking
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to config (master)

Reviewed: https://review.opendev.org/c/starlingx/config/+/852207
Committed: https://opendev.org/starlingx/config/commit/95de6d1eb1b900406e6930d5415d0f437c7f0952
Submitter: "Zuul (22348)"
Branch: master

commit 95de6d1eb1b900406e6930d5415d0f437c7f0952
Author: Mohammad Issa <email address hidden>
Date: Thu Aug 4 15:52:26 2022 -0400

    System CLI interface naming rule inconsistency

    Starling-X API does not allow the use of dashes and dots
    in the interface name. The aim is to allow the use of dots,
    dashes, and underscores in general.

    This change is because of Starling-X and K8s having
    naming rule inconsistencies and might cause confusion to customer.

    Test Plan:

    PASS: Obtain the list of characters that are deemed not valid
          for interface names and remove dots, dashes, and underscores
          from the list.

          Test 1: using "+": system host-if-add ... controller-0 vf+2 vf ..
          --> Cannot use '+' as a special character in interface name.
          Test 2: using "=": system host-if-add ... controller-0 vf=2 vf ..
          --> Cannot use '=' as a special character in interface name.
          Test 3: using ".": system host-if-add ... controller-0 vf.2 vf ..
          --> No error returned
          Test 4: using "-": system host-if-add ... controller-0 vf-2 vf ..
          --> No error returned
          Test 5: using "_": system host-if-add ... controller-0 vf_2 vf ..
          --> No error returned

    PASS: The changes were tested on a controller to make sure it can
          be locked and unlocked.

    Closes-Bug: 1983614

    Signed-off-by: Mohammad Issa <email address hidden>
    Change-Id: Ie50981dfca988bcb47eaf1a28603ad24f2de83d7

Changed in starlingx:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.