diff --git a/.gitignore b/.gitignore index 7c197b50e318..f18f2f3026f8 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ commercial_package .vale/styles/OpenShiftAsciiDoc .vale/styles/RedHat .vale/styles/AsciiDocDITA/ +.claude diff --git a/modules/nw-multus-bond-cni-object.adoc b/modules/nw-multus-bond-cni-object.adoc index 1badd2e215d4..76a94c4279ac 100644 --- a/modules/nw-multus-bond-cni-object.adoc +++ b/modules/nw-multus-bond-cni-object.adoc @@ -18,7 +18,7 @@ The following table describes the configuration parameters for the Bond CNI plug |`name` |`string` -|Specifies the name given to this CNI network attachment definition. This name is used to identify and reference the interface within the container. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`cniVersion` |`string` @@ -34,7 +34,7 @@ The following table describes the configuration parameters for the Bond CNI plug |`mtu` |`integer` -|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`. +|Optional: Specifies the maximum transmission unit (MTU) of the bond. The default is `1500`. |`failOverMac` |`integer` @@ -42,7 +42,7 @@ The following table describes the configuration parameters for the Bond CNI plug |`mode` |`string` -|Specifies the bonding policy. +|Specifies the bonding policy. |`linksInContainer` |`boolean` @@ -66,15 +66,15 @@ The following example configures a secondary network named `bond-net1`: [source,json] ---- { - "type": "bond", + "type": "bond", "cniVersion": "0.3.1", "name": "bond-net1", - "mode": "active-backup", - "failOverMac": 1, - "linksInContainer": true, + "mode": "active-backup", + "failOverMac": 1, + "linksInContainer": true, "miimon": "100", "mtu": 1500, - "links": [ + "links": [ {"name": "net1"}, {"name": "net2"} ], diff --git a/modules/nw-multus-bridge-object.adoc b/modules/nw-multus-bridge-object.adoc index c864498a0d8c..de441cffe02c 100644 --- a/modules/nw-multus-bridge-object.adoc +++ b/modules/nw-multus-bridge-object.adoc @@ -21,7 +21,8 @@ ifndef::microshift[] |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. + endif::microshift[] ifdef::microshift[] diff --git a/modules/nw-multus-dummy-device-object.adoc b/modules/nw-multus-dummy-device-object.adoc index 20fcafb31322..bff7a7d4f05b 100644 --- a/modules/nw-multus-dummy-device-object.adoc +++ b/modules/nw-multus-dummy-device-object.adoc @@ -6,7 +6,7 @@ [id="nw-multus-dummy-device-object_{context}"] = Configuration for a dummy device additional network -[role="_abstract"] +[role="_abstract"] The dummy CNI plugin functions like a loopback device. The plugin is a virtual interface, and you can use the plugin to route the packets to a designated IP address. Unlike a loopback device, the IP address is arbitrary and is not restricted to the `127.0.0.0/8` address range. The dummy device CNI plugin JSON configuration object describes the configuration parameters for the dummy CNI plugin. The following table details these parameters: @@ -21,7 +21,7 @@ The dummy device CNI plugin JSON configuration object describes the configuratio |`name` |`string` -|The value for the `name` parameter that you previously specified for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-host-device-object.adoc b/modules/nw-multus-host-device-object.adoc index 12914bfd9c7c..483254d3a696 100644 --- a/modules/nw-multus-host-device-object.adoc +++ b/modules/nw-multus-host-device-object.adoc @@ -26,7 +26,7 @@ The following table details the configuration parameters: |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-ipvlan-object.adoc b/modules/nw-multus-ipvlan-object.adoc index df3f428f133d..6bc912e236d9 100644 --- a/modules/nw-multus-ipvlan-object.adoc +++ b/modules/nw-multus-ipvlan-object.adoc @@ -23,7 +23,7 @@ The IPVLAN CNI plugin JSON configuration object describes the configuration para |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-macvlan-object.adoc b/modules/nw-multus-macvlan-object.adoc index f66bb519b6db..3bb9a7534059 100644 --- a/modules/nw-multus-macvlan-object.adoc +++ b/modules/nw-multus-macvlan-object.adoc @@ -20,7 +20,7 @@ The MACVLAN CNI plugin JSON configuration object describes the configuration par |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-tap-object.adoc b/modules/nw-multus-tap-object.adoc index 9894338437cf..d60c8a086858 100644 --- a/modules/nw-multus-tap-object.adoc +++ b/modules/nw-multus-tap-object.adoc @@ -19,7 +19,7 @@ The TAP CNI plugin JSON configuration object describes the configuration paramet |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string` diff --git a/modules/nw-multus-vlan-object.adoc b/modules/nw-multus-vlan-object.adoc index b34e4598846a..dfdb6c87c9df 100644 --- a/modules/nw-multus-vlan-object.adoc +++ b/modules/nw-multus-vlan-object.adoc @@ -21,7 +21,7 @@ The VLAN CNI plugin JSON configuration object describes the configuration parame |`name` |`string` -|The value for the `name` parameter you provided previously for the CNO configuration. +|The mandatory, unique identifier assigned to this CNI network attachment definition. It is used by the container runtime to select the correct network configuration and serves as the key for persistent resource state management, such as IP address allocations. |`type` |`string`