Add doc for VF flags and change the namespace of the operator #4
Conversation
@vpickard Thanks for the comments. I'll fix them. |
| <10> Optional. Replace `<vlan_qos>` with a IEEE 802.1p Priority levels for the VF. The default value is `0`. | ||
| <11> Optional. Replace `<spoof_check>` with the spoof check mode of the VF. Allowed values are `"on"` and `"off"`. | ||
| <12> Optional. Replace `<trust_vf>` with the trust mode of the VF. Allowed values are `"on"` and `"off"`. If `on` or `off` is specified without quotes, it will be rejected by CRD validation, since it will be evaluated as boolean value. | ||
| <13> Optional. Replace `<capabilities>` with the capabilities to be configured for this network. Capabilities supported: (mac|ips), e.g. `'{"mac": true}'`, it allows SR-IOV CNI to set a static mac address to a Pod. More information can be found [TODO:[put a link to Static IP/MAC address assignment doc.]] |
There was a problem hiding this comment.
@pliurh, due to limitations in our tooling, we aren't allow to link to other documentation modules from within a module. What's the Static IP/MAC address assignment doc?
There was a problem hiding this comment.
It's a new feature of Multus.
@dougbtv Do you know where is the doc for the Static IP/MAC address assignment?
There was a problem hiding this comment.
I have one example for SR-IOV using runtimeConfig: zshi-redhat@73c3637
I'd also like to link to multus one.
There was a problem hiding this comment.
I removed this for now. We've got multiple PRs in flight. After I get them in I can do another pass and look for the best place to add some "Next steps" links or "Related resources" to help connect these docs.
| vlanQoS: <vlan_qos> <10> | ||
| spoofChk: <spoof_check> <11> | ||
| trust: <trust_vf> <12> | ||
| capabilities: <capabilities> <13> |
There was a problem hiding this comment.
There was a problem hiding this comment.
@zshi Could you give some comments?
There was a problem hiding this comment.
Please see the example in zshi-redhat@73c3637
There was a problem hiding this comment.
Yes, here is another example using block scalar: https://github.com/redhat-nfvpe/openshift-baremetal-ci/blob/master/tests/sriov/templates/sn-static-ipam.yaml
this template has been tested in CI env.
| <9> Optional. Replace `<min_tx_rate>`` with a Minimum tx rate, in Mbps, for the VF. This value should always be less than or equal to Maximum tx rate. Note: Intel NICs don't support this parameter. | ||
| <10> Optional. Replace `<vlan_qos>` with a IEEE 802.1p Priority levels for the VF. The default value is `0`. | ||
| <11> Optional. Replace `<spoof_check>` with the spoof check mode of the VF. Allowed values are `"on"` and `"off"`. | ||
| <12> Optional. Replace `<trust_vf>` with the trust mode of the VF. Allowed values are `"on"` and `"off"`. If `on` or `off` is specified without quotes, it will be rejected by CRD validation, since it will be evaluated as boolean value. |
There was a problem hiding this comment.
@pliurh -
it sounds like trust is treated differently if it's specified as trust: "on" versus trust: on, but I thought in YAML, a flow scalar is equivalent whether it's quoted or not in the simplest cases? Does Go handle YAML differently?
(http://blogs.perl.org/users/tinita/2018/03/strings-in-yaml---to-quote-or-not-to-quote.html)
Thanks!
cc @zshi-redhat
There was a problem hiding this comment.
@jboxman It should be the same as spoof_check.
There was a problem hiding this comment.
I suggested to use quotes. otherwise it will report error when creating sriov network according to previous tests.
There was a problem hiding this comment.
It looks like go-yaml tend to support both 1.1 and 1.2. some relevant readings:
kubernetes/kubernetes#34146
go-yaml/yaml#214
No description provided.