Bug 1874825 - Raw CNI macvlan network definition with customizable MAC does not have 'name' field
Summary: Raw CNI macvlan network definition with customizable MAC does not have 'name'...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.6
Hardware: Unspecified
OS: Unspecified
high
high
Target Milestone: ---
: 4.8.0
Assignee: Jason Boxman
QA Contact: Xiaoli Tian
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2020-09-02 11:04 UTC by Pablo Alonso Rodriguez
Modified: 2024-10-01 16:49 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-07-21 17:19:49 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Github openshift openshift-docs pull 25196 0 None open Bug 1874825: Fixed custom MAC CNI example 2021-02-12 09:10:31 UTC

Description Pablo Alonso Rodriguez 2020-09-02 11:04:45 UTC
Document URL: 

https://docs.openshift.com/container-platform/4.5/networking/multiple_networks/attaching-pod.html#nw-multus-advanced-annotations_attaching-pod

Section Number and Name: 

Networking --> Multiple networks --> Attaching a Pod to an additional network --> Specifying Pod-specific addressing and routing options

Describe the issue: 

The "macvlan CNI plug-in JSON configuration object using static IP and MAC address" example lacks the 'name' field in the CNI JSON configuration. This causes the multus admission webhook to reject the network and the example never works.

Suggestions for improvement: 

Making it look similar to this:
~~~
{
  "cniVersion": "0.3.1",
  "name": "<name>",
  "plugins": [{ 
      "type": "macvlan",
      "capabilities": { "ips": true }, 
      "master": "eth0", 
      "mode": "bridge",
      "ipam": {
        "type": "static"
      }
    }, {
      "capabilities": { "mac": true }, 
      "type": "tuning"
    }]
}
~~~

Note the additional `"name": "<name>"` field.

Additional information: 

Other examples I have seen do not have this issue (e.g. https://docs.openshift.com/container-platform/4.5/networking/multiple_networks/configuring-macvlan.html)

Comment 1 Pablo Alonso Rodriguez 2020-09-02 11:43:37 UTC
I have made the following PR: https://github.com/openshift/openshift-docs/pull/25196 

Please let me know if something needs to be fixed or improved there

Comment 7 Tomofumi Hayashi 2021-05-18 11:41:08 UTC
I've review the PR and it looks good to me.

Comment 9 Jason Boxman 2021-07-21 17:19:49 UTC
The PR is merged.

Comment 10 Red Hat Bugzilla 2023-09-15 00:47:24 UTC
The needinfo request[s] on this closed bug have been removed as they have been unresolved for 500 days


Note You need to log in before you can comment on or make changes to this bug.