Template:

Networking Definition of Planned

Epic Template descriptions and documentation

Epic Goal

In the interest of inclusive language, NMState has renamed the "slaves" configuration option to "port". Unfortunately we have NMState configurations in production that use the old name and that will break when it is removed. While we were able to convince them to re-enable the old name in RHEL 9 to defer this problem, in RHEL 10 it is likely they will want to remove it again. We need to determine how to handle that. There are a few options I can think of offhand, and there may be more:

• Ask the NMState team to leave the compatibility shim in place indefinitely. TBD how receptive they would be to this.
• Require customers to manually update their old configs. This can be a bit awkward for day 1 configurations because it requires editing all of the network-config secrets. I'm more inclined to go with this for kubernetes-nmstate though since it's easier to update those configurations.
• Implement some way to automatically migrate existing configs (essentially run s/slaves/port/ on them).
• Modify the way baremetal-operator processes these configs so old configs will no longer cause errors. One source of problems today is that BMO continues to run NMState on config secrets even after the node has been deployed and the secret is no longer needed. If that were stopped we may not need to update existing configs at all.

Why is this important?

Some major customers were very unhappy when their configurations broke after upgrade. Part of the issue may have been that we were unaware of the change until after 4.13 shipped and did not release note it in OCP. We should work with PM to determine how important this still is.

As noted above, we will want to have a plan in place before RHEL 10 is used in OpenShift as that is the next time this is likely to become an issue.

Planning Done Checklist

The following items must be completed on the Epic prior to moving the Epic from Planning to the ToDo status

• Priority+ is set by engineering
• Epic must be Linked to a +Parent Feature
• Target version+ must be set
• Assignee+ must be set
• (Enhancement Proposal is Implementable
• (No outstanding questions about major work breakdown
• (Are all Stakeholders known? Have they all been notified about this item?
• Does this epic affect SD? {}Have they been notified{+}? (View plan definition for current suggested assignee)
  1. Please use the “Discussion Needed: Service Delivery Architecture Overview” checkbox to facilitate the conversation with SD Architects. The SD architecture team monitors this checkbox which should then spur the conversation between SD and epic stakeholders. Once the conversation has occurred, uncheck the “Discussion Needed: Service Delivery Architecture Overview” checkbox and record the outcome of the discussion in the epic description here.
  2. The guidance here is that unless it is very clear that your epic doesn’t have any managed services impact, default to use the Discussion Needed checkbox to facilitate that conversation.

Additional information on each of the above items can be found here: Networking Definition of Planned

Acceptance Criteria

• CI - MUST be running successfully with tests automated
• Release Technical Enablement - Provide necessary release enablement
  details and documents.

...

Dependencies (internal and external)

1.

...

Previous Work (Optional):

1. …

Open questions::

1. …

Done Checklist

• CI - CI is running, tests are automated and merged.
• Release Enablement <link to Feature Enablement Presentation>
• DEV - Upstream code and tests merged: <link to meaningful PR or GitHub Issue>
• DEV - Upstream documentation merged: <link to meaningful PR or GitHub Issue>
• DEV - Downstream build attached to advisory: <link to errata>
• QE - Test plans in Polarion: <link or reference to Polarion>
• QE - Automated tests merged: <link or reference to automated tests>
• DOC - Downstream documentation merged: <link to meaningful PR>