diff --git a/pkg/machinery/config/schemas/config.schema.json b/pkg/machinery/config/schemas/config.schema.json
index 8563ab2c9a..8d739ba5d1 100644
--- a/pkg/machinery/config/schemas/config.schema.json
+++ b/pkg/machinery/config/schemas/config.schema.json
@@ -901,16 +901,16 @@
"stp": {
"$ref": "#/$defs/v1alpha1.STP",
"title": "stp",
- "description": "A bridge option.\nPlease see the official kernel documentation.\n",
- "markdownDescription": "A bridge option.\nPlease see the official kernel documentation.",
- "x-intellij-html-description": "\u003cp\u003eA bridge option.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
+ "description": "Enable STP on this bridge.\nPlease see the official kernel documentation.\n",
+ "markdownDescription": "Enable STP on this bridge.\nPlease see the official kernel documentation.",
+ "x-intellij-html-description": "\u003cp\u003eEnable STP on this bridge.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
},
"vlan": {
"$ref": "#/$defs/v1alpha1.BridgeVLAN",
"title": "vlan",
- "description": "A bridge option.\nPlease see the official kernel documentation.\n",
- "markdownDescription": "A bridge option.\nPlease see the official kernel documentation.",
- "x-intellij-html-description": "\u003cp\u003eA bridge option.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
+ "description": "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.\n",
+ "markdownDescription": "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.",
+ "x-intellij-html-description": "\u003cp\u003eEnable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.\u003c/p\u003e\n"
}
},
"additionalProperties": false,
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
index b957bcaed0..52c3ae1ecf 100644
--- a/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
+++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_types.go
@@ -1997,11 +1997,11 @@ type Bridge struct {
// description: The interfaces that make up the bridge.
BridgedInterfaces []string `yaml:"interfaces"`
// description: |
- // A bridge option.
+ // Enable STP on this bridge.
// Please see the official kernel documentation.
BridgeSTP *STP `yaml:"stp,omitempty"`
// description: |
- // A bridge option.
+ // Enable VLAN-awareness on this bridge.
// Please see the official kernel documentation.
BridgeVLAN *BridgeVLAN `yaml:"vlan,omitempty"`
}
diff --git a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
index 9875c4311f..7035ffd379 100644
--- a/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
+++ b/pkg/machinery/config/types/v1alpha1/v1alpha1_types_doc.go
@@ -3018,15 +3018,15 @@ func (Bridge) Doc() *encoder.Doc {
Name: "stp",
Type: "STP",
Note: "",
- Description: "A bridge option.\nPlease see the official kernel documentation.",
- Comments: [3]string{"" /* encoder.HeadComment */, "A bridge option." /* encoder.LineComment */, "" /* encoder.FootComment */},
+ Description: "Enable STP on this bridge.\nPlease see the official kernel documentation.",
+ Comments: [3]string{"" /* encoder.HeadComment */, "Enable STP on this bridge." /* encoder.LineComment */, "" /* encoder.FootComment */},
},
{
Name: "vlan",
Type: "BridgeVLAN",
Note: "",
- Description: "A bridge option.\nPlease see the official kernel documentation.",
- Comments: [3]string{"" /* encoder.HeadComment */, "A bridge option." /* encoder.LineComment */, "" /* encoder.FootComment */},
+ Description: "Enable VLAN-awareness on this bridge.\nPlease see the official kernel documentation.",
+ Comments: [3]string{"" /* encoder.HeadComment */, "Enable VLAN-awareness on this bridge." /* encoder.LineComment */, "" /* encoder.FootComment */},
},
},
}
diff --git a/website/content/v1.9/reference/configuration/v1alpha1/config.md b/website/content/v1.9/reference/configuration/v1alpha1/config.md
index d1956eac30..283e334f1b 100644
--- a/website/content/v1.9/reference/configuration/v1alpha1/config.md
+++ b/website/content/v1.9/reference/configuration/v1alpha1/config.md
@@ -200,7 +200,7 @@ network:
# interfaces:
# - enxda4042ca9a51
# - enxae2a6774c259
- # # A bridge option.
+ # # Enable STP on this bridge.
# stp:
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
@@ -771,7 +771,7 @@ machine:
# interfaces:
# - enxda4042ca9a51
# - enxae2a6774c259
- # # A bridge option.
+ # # Enable STP on this bridge.
# stp:
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
@@ -882,7 +882,7 @@ interfaces:
# interfaces:
# - enxda4042ca9a51
# - enxae2a6774c259
- # # A bridge option.
+ # # Enable STP on this bridge.
# stp:
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
@@ -1002,7 +1002,7 @@ machine:
# interfaces:
# - enxda4042ca9a51
# - enxae2a6774c259
- # # A bridge option.
+ # # Enable STP on this bridge.
# stp:
# enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
@@ -1094,7 +1094,7 @@ bridge:
interfaces:
- enxda4042ca9a51
- enxae2a6774c259
- # A bridge option.
+ # Enable STP on this bridge.
stp:
enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
{{< /highlight >}} | |
@@ -1352,7 +1352,7 @@ machine:
interfaces:
- enxda4042ca9a51
- enxae2a6774c259
- # A bridge option.
+ # Enable STP on this bridge.
stp:
enabled: true # Whether Spanning Tree Protocol (STP) is enabled.
{{< /highlight >}}
@@ -1361,8 +1361,8 @@ machine:
| Field | Type | Description | Value(s) |
|-------|------|-------------|----------|
|`interfaces` |[]string |The interfaces that make up the bridge. | |
-|`stp` |STP |A bridge option.
Please see the official kernel documentation.A bridge option.
Please see the official kernel documentation.Enable STP on this bridge.
Please see the official kernel documentation.Enable VLAN-awareness on this bridge.
Please see the official kernel documentation.