-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-475: Update content for multiple networks #16349
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
39ca0a9
to
4f572cd
Compare
The preview will be available shortly at: |
modules/nw-multus-ipam-object.adoc
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey Jason, if I'm reading this correct... Is this intended to be an overview for all IPAM plugins? I think this JSON block might be too broad to include for all IPAM plugins, unfortunately.
It's awesome for static, indeed! But, for other types... It's not always the same parameters.
For example, for DHCP, you only set type, for example:
{
"type": "dhcp"
}
So while all of these parameters are perfect for the static IPAM CNI plugin-in, the DHCP CNI plug-in is not as feature rich, and doesn't have any additional parameters other than the required type field.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dougbtv, I think I understand what you're saying. I hadn't fully thought through the presentation of the configuration, then. I can think of a few possibilities:
-
simply split the discussion into 2 sections, one for type=static and one for type=DHCP. The configuration for the former would include the various permissible parameters. Then configuration for the latter would simply specify type=DHCP and that no further configuration is possible.
-
Specify for each parameter that it is only applicable to type=static. That will probably get redundant and may be less clear an approach than 1).
I'll have to consider how best to proceed.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No worries -- I kinda of lean towards #1 to split into two sections, but, definitely defer to you on how it's presented
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd forgotten, I split this out for the YAML configuration, because there you can only provide the staticIPAMConfig if you are doing static assignment.
Per Slack, I need to update this PR to properly reflect which plug-in is supported on which platform. |
437463d
to
c0ad68d
Compare
e7940f1
to
2333719
Compare
The automated preview didn't update, so here are the latest rendered files: |
@openshift/team-documentation PTAL? Thanks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that some of your modules are confusing, that some of your assemblies need to be reorganized, and that you need to make some steps and assumptions clearer. I also have some style changes.
networking/multiple-networks/understanding-multiple-networks.adoc
Outdated
Show resolved
Hide resolved
networking/multiple-networks/understanding-multiple-networks.adoc
Outdated
Show resolved
Hide resolved
networking/multiple-networks/understanding-multiple-networks.adoc
Outdated
Show resolved
Hide resolved
networking/multiple-networks/understanding-multiple-networks.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See the comments on the similar module - you need more examples and to make it clearer how these yaml examples fit together.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need an introduction statement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is more of a placeholder for this PR (#16679) with updated content for SR-IOV in 4.2.
@kalexand-rh thanks! |
Per @vikram-redhat, I'm going to merge this with the fixes I've completed, and then create a fix-up PR where I'll make the remaining structural changes and integrate any changes suggested from QE.
|
- OSDOCS-475
/cherrypick enterprise-4.2 |
@jboxman: new pull request created: #16868 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Created #16983 with updates. |
So this adds docs for the various CNI plug-ins that we support for creating additional networks.