Run make docs

ironcore-dev · Oct 16, 2024 · fc4af66 · fc4af66
1 parent 302524b
commit fc4af66
Show file tree

Hide file tree

Showing 3 changed files with 100 additions and 15 deletions.
diff --git a/hack/api-reference/api.md b/hack/api-reference/api.md
@@ -14,7 +14,7 @@ Resource Types:
 </li><li>
 <a href="#metal.provider.extensions.gardener.cloud/v1alpha1.ControlPlaneConfig">ControlPlaneConfig</a>
 </li><li>
-<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig</a>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.IgnitionConfig">IgnitionConfig</a>
 </li></ul>
 <h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.CloudProfileConfig">CloudProfileConfig
 </h3>
@@ -148,10 +148,14 @@ LoadBalancerConfig
 </tr>
 </tbody>
 </table>
-<h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig
+<h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.IgnitionConfig">IgnitionConfig
 </h3>
 <p>
-<p>InfrastructureConfig infrastructure configuration resource</p>
+(<em>Appears on:</em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.WorkerConfig">WorkerConfig</a>)
+</p>
+<p>
+<p>IgnitionConfig contains ignition settings.</p>
 </p>
 <table>
 <thead>
@@ -176,7 +180,32 @@ metal.provider.extensions.gardener.cloud/v1alpha1
 <code>kind</code></br>
 string
 </td>
-<td><code>InfrastructureConfig</code></td>
+<td><code>IgnitionConfig</code></td>
+</tr>
+<tr>
+<td>
+<code>raw</code></br>
+<em>
+string
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Raw contains an inline ignition config, which is merged with the config from the os extension.</p>
+</td>
+</tr>
+<tr>
+<td>
+<code>override</code></br>
+<em>
+bool
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Override configures, if ignition keys set by the os-extension are overridden
+by extra ignition.</p>
+</td>
 </tr>
 </tbody>
 </table>
@@ -344,6 +373,35 @@ map[string]bool
 </tr>
 </tbody>
 </table>
+<h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig
+</h3>
+<p>
+<p>InfrastructureConfig infrastructure configuration resource</p>
+</p>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>worker</code></br>
+<em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.WorkerConfig">
+map[string]./pkg/apis/metal/v1alpha1.WorkerConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>Worker contains settings per worker pool specific to the metal-operator</p>
+</td>
+</tr>
+</tbody>
+</table>
 <h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.InfrastructureStatus">InfrastructureStatus
 </h3>
 <p>
@@ -711,6 +769,39 @@ string
 </tr>
 </tbody>
 </table>
+<h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.WorkerConfig">WorkerConfig
+</h3>
+<p>
+(<em>Appears on:</em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.InfrastructureConfig">InfrastructureConfig</a>)
+</p>
+<p>
+<p>WorkerConfig contains settings per pool, which are specific to the metal-operator.</p>
+</p>
+<table>
+<thead>
+<tr>
+<th>Field</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>
+<code>extraIgnition</code></br>
+<em>
+<a href="#metal.provider.extensions.gardener.cloud/v1alpha1.IgnitionConfig">
+IgnitionConfig
+</a>
+</em>
+</td>
+<td>
+<em>(Optional)</em>
+<p>ExtraIgnition contains additional ignition configuration.</p>
+</td>
+</tr>
+</tbody>
+</table>
 <h3 id="metal.provider.extensions.gardener.cloud/v1alpha1.WorkerStatus">WorkerStatus
 </h3>
 <p>

diff --git a/hack/api-reference/config.md b/hack/api-reference/config.md
@@ -46,9 +46,7 @@ string
 <td>
 <code>clientConnection</code></br>
 <em>
-<a href="https://godoc.org/k8s.io/component-base/config/v1alpha1#ClientConnectionConfiguration">
-Kubernetes v1alpha1.ClientConnectionConfiguration
-</a>
+invalid type
 </em>
 </td>
 <td>
@@ -74,9 +72,7 @@ ETCD
 <td>
 <code>healthCheckConfig</code></br>
 <em>
-<a href="https://github.com/gardener/gardener/extensions/pkg/apis/config">
-github.com/gardener/gardener/extensions/pkg/apis/config/v1alpha1.HealthCheckConfig
-</a>
+invalid type
 </em>
 </td>
 <td>
@@ -209,9 +205,7 @@ string
 <td>
 <code>capacity</code></br>
 <em>
-<a href="https://godoc.org/k8s.io/apimachinery/pkg/api/resource#Quantity">
-k8s.io/apimachinery/pkg/api/resource.Quantity
-</a>
+invalid type
 </em>
 </td>
 <td>

diff --git 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"`
 }