From 5925ec800d5c2c7450911b552115459c78417623 Mon Sep 17 00:00:00 2001 From: Dmitri Fedotov Date: Thu, 26 Sep 2024 15:01:45 +0300 Subject: [PATCH] make docs --- hack/api-reference/api.md | 90 +++++++++++++++++++ pkg/apis/metal/types_controlplane.go | 5 ++ pkg/apis/metal/v1alpha1/types_controlplane.go | 3 +- 3 files changed, 97 insertions(+), 1 deletion(-) diff --git a/hack/api-reference/api.md b/hack/api-reference/api.md index 10e7797..eaa7ff8 100644 --- a/hack/api-reference/api.md +++ b/hack/api-reference/api.md @@ -132,6 +132,20 @@ CloudControllerManagerConfig

CloudControllerManager contains configuration settings for the cloud-controller-manager.

+ + +loadBalancerConfig
+ + +LoadBalancerConfig + + + + +(Optional) +

LoadBalancerConfig contains configuration settings for the shoot loadbalancing.

+ +

InfrastructureConfig @@ -212,6 +226,39 @@ map[string]bool +

LoadBalancerConfig +

+

+(Appears on: +ControlPlaneConfig) +

+

+

LoadBalancerConfig contains configuration settings for the shoot loadbalancing.

+

+ + + + + + + + + + + + + +
FieldDescription
+metallbConfig
+ + +MetallbConfig + + +
+(Optional) +

MetallbConfig contains configuration settings for metallb.

+

MachineImage

@@ -410,6 +457,49 @@ map[string]string +

MetallbConfig +

+

+(Appears on: +LoadBalancerConfig) +

+

+

MetallbConfig contains configuration settings for metallb.

+

+ + + + + + + + + + + + + + + + + +
FieldDescription
+ipAddressPool
+ +[]string + +
+(Optional) +

IPAddressPool contains IP address pools for metallb.

+
+enableSpeaker
+ +bool + +
+(Optional) +

EnableSpeaker enables the metallb speaker.

+

RegionConfig

diff --git a/pkg/apis/metal/types_controlplane.go b/pkg/apis/metal/types_controlplane.go index d47f3c7..e166ef3 100644 --- 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 index dfb83be..f772829 100644 --- 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