-
Notifications
You must be signed in to change notification settings - Fork 1.8k
OSDOCS-14584:updates CUDN invalid scenarios tables #93300
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
base: main
Are you sure you want to change the base?
Conversation
@JoeAldinger: This pull request references OSDOCS-14584 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
@JoeAldinger: This pull request references OSDOCS-14584 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the sub-task to target the "4.20.0" version, but no target version was set. 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 openshift-eng/jira-lifecycle-plugin repository. |
f93449f
to
879a9d2
Compare
🤖 Mon May 19 15:31:30 - Prow CI generated the docs preview: |
7b3735c
to
e332b7a
Compare
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.
Caught some errors, and provided some suggestions.
modules/cudn-status-conditions.adoc
Outdated
|`spec.network.localnet.mtu` in body should be greater than or equal to `576`. | ||
|You must set `mtu` higher than `576` | ||
|
||
|The `mtu` must be at least `1280` when IPv6 subnet is set. |
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.
|The `mtu` must be at least `1280` when IPv6 subnet is set. | |
|The `mtu` must be at least `1280` when IPv6 subnet is used. |
not sure about this one.
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 tried to reword for clarity.
modules/cudn-status-conditions.adoc
Outdated
|You must set physical network name to not exceed the 253 character in length. | ||
|
||
|The name of the physical network must not contain `,` or `:`. | ||
|`physicalNetworkName cannot contain `,` or `:` characters` |
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 does not render properly. You may need to escape the back-ticks.
modules/cudn-status-conditions.adoc
Outdated
|
||
|The optional fields, `subnets` and `ipam.mode`, have to be set together. | ||
|`Subnets is required with ipam.mode is Enabled or unset, and forbidden otherwise` | ||
|You must set the `subnets` field when the `ipam.mode` is `Enabled` or `Disabled`. |
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 not right.
|You must set the `subnets` field when the `ipam.mode` is `Enabled` or `Disabled`. | |
|You must set the `subnets` field when the `ipam.mode` is `Enabled` or the IPAM mode is unset (defaults to enabled). |
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.
Tried to reword this so we could get rid of the aside.
modules/cudn-status-conditions.adoc
Outdated
|`The ClusterUserDefinedNetwork "localnet-subnets-invalid-ipv4-cidr-fail" is invalid: spec.network.localnet.subnets[0]: Invalid value: "string": CIDR is invalid` | ||
|You must set an acceptable CIDR range for `spec.network.localnet.subnets` field. Acceptable values are IPv4 and IPv6 CIDR ranges which are not in use or reserved by {product-title}. | ||
|
||
|The `subnets` field is required when the `ipam.mode` is set to a value of `Disabled` or `Enabled`. |
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.
|The `subnets` field is required when the `ipam.mode` is set to a value of `Disabled` or `Enabled`. | |
|The `subnets` field is required when the `ipam.mode` is set to a value of `Enabled` or the IPAM mode is unset (defaults to enabled) |
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.
Worded it a little different then line 177 to see which one we prefer.
e332b7a
to
4172305
Compare
|Condition type | ||
3+|Reason, Message, Resolution | ||
|
||
.6+|`LocalnetInvalidSubnets` |
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.
Something is wrong with this table definition the columns doesnt seem aliened, please have a look at table 6 "Message, Resolution.." headers line:
https://github.com/openshift/openshift-docs/blob/4172305504eec2bd1142d427e3e0919bbe7cba9a/modules/cudn-status-conditions.adoc
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.
Yeah, I'm still trying to figure out the asciidoc markup on this one. Give me a little. This won't get past the docs team's review. Thank you
4172305
to
6988768
Compare
@JoeAldinger: all tests passed! Full PR test history. Your PR dashboard. 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-sigs/prow repository. I understand the commands that are listed here. |
Version(s):
4.19
Issue:
https://issues.redhat.com/browse/OSDOCS-14584
Link to docs preview:
QE review:
Additional information: