Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OSDOCS-14584:updates CUDN invalid scenarios tables #93300

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions modules/cudn-status-conditions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,123 @@ h|Message
|`Network allocation failed for at least one node: [<node_name>], check UDN events for more info.`

|===

.Invalid `mtu` scenarios types for the `ClusterUserDefinedNetwork` CR
[cols="2a,2a,3a,3a",options="header"]
|===

|Condition type
3+|Reason, Message, Resolution

.6+|`invalid mtu`
3+|One of the following messages is returned when the `mtu` is set incorrect:
h|Reason
h|Message
h|Resolution

|The `mtu` is set higher than `65536`.
|`spec.network.localnet.mtu` in body should be less than or equal to `65536`.
|You must the `mtu` lower than `65536`.

|The `mtu` is set lower than `576`.
|`spec.network.localnet.mtu` in body should be greater than or equal to `576`.
|You must set the `mtu` higher than `576`

|The `mtu` must be at least `1280` when using the IPv6 subnet.
|`MTU should be greater than or equal to 1280 when an IPv6 subnet is used`
|You must set the `mtu` higher than or equal to `1280` when you have an IPv6 subnet defined on your user-defined network configuration.
|===

.Invalid `PhysicalNetworkName` scenarios types for the `ClusterUserDefinedNetwork` CR
[cols="2a,2a,3a,3a",options="header"]
|===

|Condition type
3+|Reason, Message, Resolution

.6+|`invalid PhysicalNetworkName`
3+|One of the following messages is returned when the `PhysicalNetworkName` is set incorrect:
h|Reason
h|Message
h|Resolution

|The name of the physical network is not set.
|`spec.network.localnet.physicalNetworkName: Required value`
|You must set the `physicalNetworkName` field.

|The name of the physical network does not meet minimum length requirements.
|`spec.network.localnet.physicalNetworkName in body should be at least 1 chars long`
|You must set physical network name to be at least one character in length.

|The name of the physical network exceeds the maximum character limit of 253.
|`spec.network.localnet.physicalNetworkName: Too long: may not be more than 253 bytes`
|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`.
|You must remove the `,` or `:` from the physical network name.
|===

.Invalid `role` scenarios types for the `ClusterUserDefinedNetwork` CR
[cols="2a,2a,3a,3a",options="header"]
|===

|Condition type
3+|Reason, Message, Resolution

.6+|`role unset` or `role is primary`
3+|One of the following messages is returned when the `spec.network.localnet.role` is set incorrect:
h|Reason
h|Message
h|Resolution

|The `role` field must be set for your localnet topology.
|`spec.network.localnet.role: Required value`
|You must set the `role` field.

|`Primary` is not a supported value for the Localnet topology.
|`spec.network.localnet.role: Unsupported value: "Primary": supported values: "Secondary"`
|You must set the `role` for your Localnet topology to `Secondary`-the accepted value.
|===

.Invalid `subnets` and `ipam` scenarios types for the `ClusterUserDefinedNetwork` CR
[cols="2a,2a,3a,3a,",options="header"]
|===

|Condition type
3+|Reason, Message, Resolution

.6+|`LocalnetInvalidSubnets`
Copy link

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

Copy link
Contributor Author

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

3+|One of the following messages is returned when either the `spec.network.localnet.subnets` or `spec.network.localnet.ipam` is set incorrect:
h|Reason
h|Message
h|Resolution

|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 when the IPAM mode is unset as it defaults to `Enabled`.

|The `spec.network.localnet.subnets` must have an acceptable value when using this optional field.
|`The ClusterUserDefinedNetwork "localnet-empty-subnets-fail" is invalid: spec.network.localnet.subnets: Invalid value: 0: spec.network.localnet.subnets in body should have at least 1 items`
|You must set an acceptable value for `spec.network.localnet.subnets`. Acceptable values are IPv4 and IPv6 Classless Inter-Domain Routing (CIDR) ranges that do not overlap with any CIDR ranges used by {product-title}.

|The `subnet` field must be set when using the optional `spec.network.localnet.excludeSubnets` field.
|`excludeSubnets must be unset when subnets is unset`
|You must set the `spec.network.localnet.subnets` field when using the `spec.network.localnet.excludeSubnet` field.

|The CIDR range is invalid.
|`aaThe 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}.

|You must set the `subnets` field when the `ipam.mode` is `Enabled` or when the IPAM mode is unset because the default value is `Enabled`.
|`Subnets is required with ipam.mode is Enabled or unset, and forbidden otherwise`.
|You must set the `spec.network.localnet.subnets` field unless the `spec.network.localnet.ipam.mode` is explicitly disabled..

|Setting two CIDR ranges for `spec.network.localnet.subnets` field requires that one be IPv4 and the other be a IPv6.
|`Invalid value...When 2 CIDRs are set, they must be from different IP families`.
|You must change one of your CIDR ranges to a different IP family.

|The `spec.network.localnet.ipam.mode` is `Disabled` but the ``spec.network.localnet.lifecycle` has a value of `Persistent`.
|`lifecycle Persistent is only supported when ipam.mode is Enabled`
|You must set the `ipam.mode` to `Enabled` when the optional field `lifecycle` has a value of `Persistent`.
|===