make docs

ironcore-dev · Sep 26, 2024 · 5925ec8 · 5925ec8
1 parent 961d5b3
commit 5925ec8
Show file tree

Hide file tree

Showing 3 changed files with 97 additions and 1 deletion.
diff --git a/hack/api-reference/api.md b/hack/api-reference/api.md
@@ -132,6 +132,20 @@ CloudControllerManagerConfig
 <p>CloudControllerManager contains configuration settings for the cloud-controller-manager.</p>
 </td>
 </tr>
+<tr>
+<td>
+<code>loadBalancerConfig</code></br>
+<em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.LoadBalancerConfig">
+LoadBalancerConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>LoadBalancerConfig contains configuration settings for the shoot loadbalancing.</p>
+</td>
+</tr>
 </tbody>
 </table>
 <h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig
@@ -212,6 +226,39 @@ map[string]bool
 <tbody>
 </tbody>
 </table>
+<h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.LoadBalancerConfig">LoadBalancerConfig
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.ControlPlaneConfig">ControlPlaneConfig</a>)
+</p>
+<p>
+<p>LoadBalancerConfig contains configuration settings for the shoot loadbalancing.</p>
+</p>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>metallbConfig</code></br>
+<em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.MetallbConfig">
+MetallbConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>MetallbConfig contains configuration settings for metallb.</p>
+</td>
+</tr>
+</tbody>
+</table>
 <h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.MachineImage">MachineImage
 </h3>
 <p>
@@ -410,6 +457,49 @@ map[string]string
 </tr>
 </tbody>
 </table>
+<h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.MetallbConfig">MetallbConfig
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.LoadBalancerConfig">LoadBalancerConfig</a>)
+</p>
+<p>
+<p>MetallbConfig contains configuration settings for metallb.</p>
+</p>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>ipAddressPool</code></br>
+<em>
+[]string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>IPAddressPool contains IP address pools for metallb.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>enableSpeaker</code></br>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>EnableSpeaker enables the metallb speaker.</p>
+</td>
+</tr>
+</tbody>
+</table>
 <h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.RegionConfig">RegionConfig
 </h3>
 <p>

diff --git a/pkg/apis/metal/types_controlplane.go b/pkg/apis/metal/types_controlplane.go
@@ -29,10 +29,15 @@ type CloudControllerManagerConfig struct {
 
 // LoadBalancerConfig contains configuration settings for the shoot loadbalancing.
 type LoadBalancerConfig struct {
+	// MetallbConfig contains configuration settings for metallb.
 	MetallbConfig *MetallbConfig
 }
 
+// MetallbConfig contains configuration settings for metallb.
 type MetallbConfig struct {
+	// IPAddressPool contains IP address pools for metallb.
 	IPAddressPool []string
+
+	// EnableSpeaker enables the metallb speaker.
 	EnableSpeaker bool
 }
diff --git a/pkg/apis/metal/v1alpha1/types_controlplane.go b/pkg/apis/metal/v1alpha1/types_controlplane.go
@@ -32,11 +32,12 @@ type CloudControllerManagerConfig struct {
 
 // LoadBalancerConfig contains configuration settings for the shoot loadbalancing.
 type LoadBalancerConfig struct {
+	// MetallbConfig contains configuration settings for metallb.
 	// +optional
 	MetallbConfig *MetallbConfig `json:"metallbConfig,omitempty"`
 }
 
-// LoadBalancerConfig contains configuration settings for metallb.
+// MetallbConfig contains configuration settings for metallb.
 type MetallbConfig struct {
 	// IPAddressPool contains IP address pools for metallb.
 	// +optional