Skip to content

managed control plane #3895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kron4eg wants to merge 1 commit into
base: main
Choose a base branch
from
+2,879 −200
Draft

managed control plane #3895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 92 additions & 1 deletion docs/api_reference/v1beta2.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "v1beta2 API Reference"
date = 2025-12-10T15:13:37+02:00
date = 2025-12-15T11:32:46+02:00
weight = 11
+++
## v1beta2
Expand Down Expand Up @@ -38,6 +38,8 @@ weight = 11
* [HelmAuth](#helmauth)
* [HelmRelease](#helmrelease)
* [HelmValues](#helmvalues)
* [HetznerControlPlane](#hetznercontrolplane)
* [HetznerLoadBalancer](#hetznerloadbalancer)
* [HetznerSpec](#hetznerspec)
* [HostConfig](#hostconfig)
* [IPTables](#iptables)
Expand All @@ -50,19 +52,23 @@ weight = 11
* [MachineControllerConfig](#machinecontrollerconfig)
* [MetricsServer](#metricsserver)
* [NodeLocalDNS](#nodelocaldns)
* [NodeSet](#nodeset)
* [NodeSettingsSpec](#nodesettingsspec)
* [NoneSpec](#nonespec)
* [NutanixSpec](#nutanixspec)
* [OpenIDConnect](#openidconnect)
* [OpenIDConnectConfig](#openidconnectconfig)
* [OpenstackSpec](#openstackspec)
* [OperatingSystemManagerConfig](#operatingsystemmanagerconfig)
* [OperatingSystemSpec](#operatingsystemspec)
* [PodNodeSelector](#podnodeselector)
* [PodNodeSelectorConfig](#podnodeselectorconfig)
* [PodSecurityPolicy](#podsecuritypolicy)
* [ProviderSpec](#providerspec)
* [ProviderStaticNetworkConfig](#providerstaticnetworkconfig)
* [ProxyConfig](#proxyconfig)
* [RegistryConfiguration](#registryconfiguration)
* [SSHSpec](#sshspec)
* [StaticAuditLog](#staticauditlog)
* [StaticAuditLogConfig](#staticauditlogconfig)
* [StaticWorkersConfig](#staticworkersconfig)
Expand Down Expand Up @@ -322,6 +328,7 @@ ControlPlaneConfig defines control plane nodes
| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| hosts | Hosts array of all control plane hosts. | [][HostConfig](#hostconfig) | true |
| nodeSets | | [][NodeSet](#nodeset) | true |

[Back to Group](#v1beta2)

Expand Down Expand Up @@ -477,13 +484,38 @@ HelmValues configure inputs to `helm upgrade --install` command analog.

[Back to Group](#v1beta2)

### HetznerControlPlane

HetznerControlPlane control plane config on Hetzner

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| loadBalancer | LoadBalancer config of a loadbalancer | [HetznerLoadBalancer](#hetznerloadbalancer) | true |

[Back to Group](#v1beta2)

### HetznerLoadBalancer

HetznerLoadBalancer loadbalancer definition to create for kubeapi-server endpoint

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| name | Name of the loadbalancer to create. Default: \"<CLUSTER_NAME>-kubeapi\" | string | false |
| type | Type of the loadbalancer to create. Default: \"lb11\" | string | false |
| location | Location of the loadbalancer to create. Default: \"nbg1\" | string | false |
| publicIP | PublicIP indicates whether the loadbalancer should have a public IP assigned. Default: true | *bool | false |
| labels | Labels to be applied to the loadbalancer | map[string]string | false |

[Back to Group](#v1beta2)

### HetznerSpec

HetznerSpec defines the Hetzner cloud provider

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| networkID | NetworkID | string | false |
| controlPlane | ControlPlane configures | *[HetznerControlPlane](#hetznercontrolplane) | false |

[Back to Group](#v1beta2)

Expand Down Expand Up @@ -655,6 +687,35 @@ MetricsServer feature flag

[Back to Group](#v1beta2)

### NodeSet



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| name | | string | true |
| replicas | | int | true |
| generation | | int | false |
| nodeSettings | | [NodeSettingsSpec](#nodesettingsspec) | false |
| operatingSystem | | OperatingSystemName | true |
| operatingSystemSpec | | [OperatingSystemSpec](#operatingsystemspec) | false |
| ssh | | [SSHSpec](#sshspec) | true |
| cloudProviderSpec | | [json.RawMessage](https://golang.org/pkg/encoding/json/#RawMessage) | true |

[Back to Group](#v1beta2)

### NodeSettingsSpec



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| labels | | map[string]string | false |
| annotations | | map[string]string | false |
| taints | | [][corev1.Taint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#taint-v1-core) | false |

[Back to Group](#v1beta2)

### NoneSpec

NoneSpec defines a none provider
Expand Down Expand Up @@ -722,6 +783,16 @@ OperatingSystemManagerConfig configures kubermatic operating-system-manager depl

[Back to Group](#v1beta2)

### OperatingSystemSpec



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| distUpgradeOnBoot | | bool | false |

[Back to Group](#v1beta2)

### PodNodeSelector

PodNodeSelector feature flag
Expand Down Expand Up @@ -813,6 +884,26 @@ KubeOne and kubeadm are pulled from an image registry

[Back to Group](#v1beta2)

### SSHSpec



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| publicKeys | | []string | false |
| port | | int | false |
| username | | string | false |
| privateKeyFile | | string | false |
| certFile | | string | false |
| hostPublicKey | | []byte | false |
| agentSocket | | string | false |
| bastion | | string | false |
| bastionPort | | int | false |
| bastionUser | | string | false |
| bastionHostPublicKey | | []byte | false |

[Back to Group](#v1beta2)

### StaticAuditLog

StaticAuditLog feature flag
Expand Down
93 changes: 92 additions & 1 deletion docs/api_reference/v1beta3.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
+++
title = "v1beta3 API Reference"
date = 2025-12-10T15:13:37+02:00
date = 2025-12-15T11:32:46+02:00
weight = 11
+++
## v1beta3
Expand Down Expand Up @@ -38,6 +38,8 @@ weight = 11
* [HelmAuth](#helmauth)
* [HelmRelease](#helmrelease)
* [HelmValues](#helmvalues)
* [HetznerControlPlane](#hetznercontrolplane)
* [HetznerLoadBalancer](#hetznerloadbalancer)
* [HetznerSpec](#hetznerspec)
* [HostConfig](#hostconfig)
* [IPTables](#iptables)
Expand All @@ -50,18 +52,22 @@ weight = 11
* [MachineControllerConfig](#machinecontrollerconfig)
* [MetricsServer](#metricsserver)
* [NodeLocalDNS](#nodelocaldns)
* [NodeSet](#nodeset)
* [NodeSettingsSpec](#nodesettingsspec)
* [NoneSpec](#nonespec)
* [NutanixSpec](#nutanixspec)
* [OpenIDConnect](#openidconnect)
* [OpenIDConnectConfig](#openidconnectconfig)
* [OpenstackSpec](#openstackspec)
* [OperatingSystemManagerConfig](#operatingsystemmanagerconfig)
* [OperatingSystemSpec](#operatingsystemspec)
* [PodNodeSelector](#podnodeselector)
* [PodNodeSelectorConfig](#podnodeselectorconfig)
* [ProviderSpec](#providerspec)
* [ProviderStaticNetworkConfig](#providerstaticnetworkconfig)
* [ProxyConfig](#proxyconfig)
* [RegistryConfiguration](#registryconfiguration)
* [SSHSpec](#sshspec)
* [StaticAuditLog](#staticauditlog)
* [StaticAuditLogConfig](#staticauditlogconfig)
* [StaticWorkersConfig](#staticworkersconfig)
Expand Down Expand Up @@ -324,6 +330,7 @@ ControlPlaneConfig defines control plane nodes
| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| hosts | Hosts array of all control plane hosts. | [][HostConfig](#hostconfig) | true |
| nodeSets | | [][NodeSet](#nodeset) | true |

[Back to Group](#v1beta3)

Expand Down Expand Up @@ -479,13 +486,38 @@ HelmValues configure inputs to `helm upgrade --install` command analog.

[Back to Group](#v1beta3)

### HetznerControlPlane

HetznerControlPlane control plane config on Hetzner

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| loadBalancer | LoadBalancer config of a loadbalancer | [HetznerLoadBalancer](#hetznerloadbalancer) | true |

[Back to Group](#v1beta3)

### HetznerLoadBalancer

HetznerLoadBalancer loadbalancer definition to create for kubeapi-server endpoint

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| name | Name of the loadbalancer to create. Default: \"<CLUSTER_NAME>-kubeapi\" | string | false |
| type | Type of the loadbalancer to create. Default: \"lb11\" | string | false |
| location | Location of the loadbalancer to create. Default: \"nbg1\" | string | false |
| publicIP | PublicIP indicates whether the loadbalancer should have a public IP assigned. Default: true | *bool | false |
| labels | Labels to be applied to the loadbalancer | map[string]string | false |

[Back to Group](#v1beta3)

### HetznerSpec

HetznerSpec defines the Hetzner cloud provider

| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| networkID | NetworkID | string | false |
| controlPlane | ControlPlane configures | *[HetznerControlPlane](#hetznercontrolplane) | false |

[Back to Group](#v1beta3)

Expand Down Expand Up @@ -657,6 +689,35 @@ MetricsServer feature flag

[Back to Group](#v1beta3)

### NodeSet



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| name | | string | true |
| replicas | | int | true |
| generation | | int | false |
| nodeSettings | | [NodeSettingsSpec](#nodesettingsspec) | false |
| operatingSystem | | OperatingSystemName | true |
| operatingSystemSpec | | [OperatingSystemSpec](#operatingsystemspec) | false |
| ssh | | [SSHSpec](#sshspec) | true |
| cloudProviderSpec | | [json.RawMessage](https://golang.org/pkg/encoding/json/#RawMessage) | true |

[Back to Group](#v1beta3)

### NodeSettingsSpec



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| labels | | map[string]string | false |
| annotations | | map[string]string | false |
| taints | | [][corev1.Taint](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#taint-v1-core) | false |

[Back to Group](#v1beta3)

### NoneSpec

NoneSpec defines a none provider
Expand Down Expand Up @@ -724,6 +785,16 @@ OperatingSystemManagerConfig configures kubermatic operating-system-manager depl

[Back to Group](#v1beta3)

### OperatingSystemSpec



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| distUpgradeOnBoot | | bool | false |

[Back to Group](#v1beta3)

### PodNodeSelector

PodNodeSelector feature flag
Expand Down Expand Up @@ -802,6 +873,26 @@ KubeOne and kubeadm are pulled from an image registry

[Back to Group](#v1beta3)

### SSHSpec



| Field | Description | Scheme | Required |
| ----- | ----------- | ------ | -------- |
| publicKeys | | []string | false |
| port | | int | false |
| username | | string | false |
| privateKeyFile | | string | false |
| certFile | | string | false |
| hostPublicKey | | []byte | false |
| agentSocket | | string | false |
| bastion | | string | false |
| bastionPort | | int | false |
| bastionUser | | string | false |
| bastionHostPublicKey | | []byte | false |

[Back to Group](#v1beta3)

### StaticAuditLog

StaticAuditLog feature flag
Expand Down
Loading