Skip to content

OSDOCS-475 revisions#16983

Merged
jboxman merged 1 commit intoopenshift:masterfrom
jboxman-rh:OSDOCS-475-remix
Oct 15, 2019
Merged

OSDOCS-475 revisions#16983
jboxman merged 1 commit intoopenshift:masterfrom
jboxman-rh:OSDOCS-475-remix

Conversation

@jboxman
Copy link
Copy Markdown
Contributor

@jboxman jboxman commented Oct 1, 2019

This includes changes stemming from #16349.

@jboxman jboxman added this to the Future Release milestone Oct 1, 2019
@jboxman jboxman self-assigned this Oct 1, 2019
@openshift-ci-robot openshift-ci-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 1, 2019
@jboxman jboxman changed the title OSDOCS-475 update PR OSDOCS-475 revisions Oct 3, 2019
@jboxman jboxman added the peer-review-needed Signifies that the peer review team needs to review this PR label Oct 4, 2019
@openshift-docs-preview-bot
Copy link
Copy Markdown

The preview will be available shortly at:

@jboxman
Copy link
Copy Markdown
Contributor Author

jboxman commented Oct 4, 2019

@openshift/team-documentation, PTAL. Thanks!

@vikram-redhat
Copy link
Copy Markdown
Contributor

@kalexand-rh @huffmanca @mburke5678 peer review please.

Comment thread modules/nw-multus-add-pod.adoc Outdated
Comment thread modules/nw-multus-add-pod.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need mark-up? NetworkAttachmentDefinition

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we have a specific style for this; I'd prefer to only use a code block to reference values and commands. This is a CR Kind, so I think of it as the name of the CR thing, since all CRs of Kind: NetworkAttachmentDefinition describe an additional network. Although it's also a parameter value, but not in this context. So the use is bifurcated and thus I'm not sure which is appropriate universally.

Comment thread modules/nw-multus-bridge-object.adoc Outdated
Copy link
Copy Markdown
Contributor

@mburke5678 mburke5678 Oct 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably my ignorance. You said above the CNI plug-in configuration is JSON format??
Can you get a more robust example with more of the parameters from the template?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replied on a later comment.

Comment thread modules/nw-multus-host-device-object.adoc Outdated
Comment thread modules/nw-multus-host-device-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial cap? This looks odd.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mburke5678, it does feel wrong. I asked in #forum-multus and all the Multus CNI plug-ins are lowercase names. I'm not completely surprised, as it is a plug-in rather than a complex software project or product.

Comment thread modules/nw-multus-bridge-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Initial cap? This looks odd.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed, but see above.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here: You said above the CNI plug-in configuration is JSON format??

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mburke5678, yeah, the plug-in configuration is not very intuitive. The configuration is a JSON object, but it's provided as a string value for a YAML parameter, and then the CNO injects it to the plug-in during initialization.

That's where the single quotes at the beginning and end of the multi-line value come from. I wonder if providing this as a YAML multi-line string might make it more obvious?

Also: https://yaml-multiline.info

Comment thread modules/nw-multus-ipam-object.adoc Outdated
Copy link
Copy Markdown
Contributor

@mburke5678 mburke5678 Oct 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/ipam/IPAM?
If so, change throughout topic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mburke5678, based on comments in #forum-multus, the concept is IPAM, but the actual plug-in is just ipam. It's the same for the others. It's nonetheless jarring to read.

Comment thread modules/nw-multus-ipam-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/ipam/IPAM?

Comment thread modules/nw-multus-ipam-object.adoc Outdated
Copy link
Copy Markdown
Contributor

@mburke5678 mburke5678 Oct 9, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/append/prepend?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way it works, the DNS resolver adds the domain to the end of a host name that isn't qualified. So fedora is a host name, unqualified. And thus the resolver will append example.com, giving us fedora.example.com to resolve.

Actually I think it's fedora.example.com. or some such, but I've long forgotten what DNS I knew.

Comment thread modules/nw-multus-ipam-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/append/prepend?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See above.

Comment thread modules/nw-multus-macvlan-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Init cap?

Comment thread modules/nw-multus-ipvlan-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Init cap?

Comment thread modules/nw-multus-bridge-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Init cap?

Comment thread modules/nw-multus-ipam-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

init cap?

Comment thread modules/nw-multus-ipvlan-object.adoc Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Init cap or IPvlan?

@mburke5678 mburke5678 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Oct 9, 2019
@jboxman
Copy link
Copy Markdown
Contributor Author

jboxman commented Oct 10, 2019

@mburke5678 thanks!

@jboxman
Copy link
Copy Markdown
Contributor Author

jboxman commented Oct 14, 2019

@anuragthehatter, I've updated the multiple networks content based on peer review feedback. Can you take a look? Thanks!

@anuragthehatter
Copy link
Copy Markdown

@weliang1 Can you help verifying @jboxman chnages in regards to Multiple Networks here https://OSDOCS-475-remix--ocpdocs.netlify.com/?

@weliang1
Copy link
Copy Markdown

weliang1 commented Oct 15, 2019 via email

@jboxman
Copy link
Copy Markdown
Contributor Author

jboxman commented Oct 15, 2019

@weliang1 thanks!

@jboxman
Copy link
Copy Markdown
Contributor Author

jboxman commented Oct 15, 2019

@vikram-redhat, this went through QE already in #16349. Only the content has been reorganized. I'm going to merge this, and then fix https://bugzilla.redhat.com/show_bug.cgi?id=1761891.

@jboxman jboxman merged commit 4f6ed92 into openshift:master Oct 15, 2019
@jboxman jboxman deleted the OSDOCS-475-remix branch October 15, 2019 17:38
@jboxman
Copy link
Copy Markdown
Contributor Author

jboxman commented Oct 15, 2019

/cherrypick enterprise-4.2

@openshift-cherrypick-robot
Copy link
Copy Markdown

@jboxman: new pull request created: #17312

Details

In response to this:

/cherrypick enterprise-4.2

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.2 peer-review-done Signifies that the peer review team has reviewed this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants