From fc4af669060763578e52047b12729f2bc3599dc7 Mon Sep 17 00:00:00 2001 From: Nuckal777 Date: Wed, 16 Oct 2024 09:25:57 +0200 Subject: [PATCH] Run make docs --- hack/api-reference/api.md | 99 ++++++++++++++++++- hack/api-reference/config.md | 12 +-- .../metal/v1alpha1/types_infrastructure.go | 4 +- 3 files changed, 100 insertions(+), 15 deletions(-) diff --git a/hack/api-reference/api.md b/hack/api-reference/api.md index b1a150a..7039e87 100644 --- a/hack/api-reference/api.md +++ b/hack/api-reference/api.md @@ -14,7 +14,7 @@ Resource Types:
  • ControlPlaneConfig
  • -InfrastructureConfig +IgnitionConfig

    • CloudProfileConfig

    @@ -148,10 +148,14 @@ LoadBalancerConfig -

    InfrastructureConfig +

    IgnitionConfig

    -

    InfrastructureConfig infrastructure configuration resource

    +(Appears on: +WorkerConfig) +

    +

    +

    IgnitionConfig contains ignition settings.

    @@ -176,7 +180,32 @@ metal.provider.extensions.gardener.cloud/v1alpha1 kind
    string - + + + + + + + + +
    InfrastructureConfigIgnitionConfig
    +raw
    + +string + +    		 +(Optional) +

    Raw contains an inline ignition config, which is merged with the config from the os extension.

    +
    +override
    + +bool + +    		 +(Optional) +

    Override configures, if ignition keys set by the os-extension are overridden +by extra ignition.

    +
    @@ -344,6 +373,35 @@ map[string]bool +

    InfrastructureConfig +

    +

    +

    InfrastructureConfig infrastructure configuration resource

    +

    + + + + + + + + + + + + + +
    FieldDescription
    +worker
    + + +map[string]./pkg/apis/metal/v1alpha1.WorkerConfig + + +    		 +(Optional) +

    Worker contains settings per worker pool specific to the metal-operator

    +

    InfrastructureStatus

    @@ -711,6 +769,39 @@ string +

    WorkerConfig +

    +

    +(Appears on: +InfrastructureConfig) +

    +

    +

    WorkerConfig contains settings per pool, which are specific to the metal-operator.

    +

    + + + + + + + + + + + + + +
    FieldDescription
    +extraIgnition
    + + +IgnitionConfig + + +    		 +(Optional) +

    ExtraIgnition contains additional ignition configuration.

    +

    WorkerStatus

    diff --git a/hack/api-reference/config.md b/hack/api-reference/config.md index 453983f..45f76ef 100644 --- a/hack/api-reference/config.md +++ b/hack/api-reference/config.md @@ -46,9 +46,7 @@ string clientConnection
    - -Kubernetes v1alpha1.ClientConnectionConfiguration - +invalid type @@ -74,9 +72,7 @@ ETCD healthCheckConfig
    - -github.com/gardener/gardener/extensions/pkg/apis/config/v1alpha1.HealthCheckConfig - +invalid type @@ -209,9 +205,7 @@ string capacity
    - -k8s.io/apimachinery/pkg/api/resource.Quantity - +invalid type diff --git a/pkg/apis/metal/v1alpha1/types_infrastructure.go b/pkg/apis/metal/v1alpha1/types_infrastructure.go index 1811fbd..a97247b 100644 --- a/pkg/apis/metal/v1alpha1/types_infrastructure.go +++ b/pkg/apis/metal/v1alpha1/types_infrastructure.go @@ -15,8 +15,8 @@ type IgnitionConfig struct { // +optional Raw string `json:"raw,omitempty"` - // Override configures, if ignition keys set by the os-extension can be merged - // with extra ignition. + // Override configures, if ignition keys set by the os-extension are overridden + // by extra ignition. // +optional Override bool `json:"override,omitempty"` }