docs: include allowSchedulingOnControlPlanes on talosctl gen config output

Include a description and a commented-out example for the `cluster.allowSchedulingOnControlPlanes` field on `talosctl gen config ...` output.

Closes siderolabs/talos#7313.

Signed-off-by: Utku Ozdemir <utku.ozdemir@siderolabs.com>
This commit is contained in:
Utku Ozdemir 2023-06-12 15:29:00 +02:00
parent c74d937280
commit e5a36268b6
No known key found for this signature in database
GPG Key ID: 65933E76F0549B0D
3 changed files with 7 additions and 1 deletions

View File

@ -1051,6 +1051,8 @@ type ClusterConfig struct {
// - yes
// - false
// - no
// examples:
// - value: true
AllowSchedulingOnControlPlanes *bool `yaml:"allowSchedulingOnControlPlanes,omitempty"`
}

View File

@ -523,6 +523,8 @@ func init() {
ClusterConfigDoc.Fields[24].Note = ""
ClusterConfigDoc.Fields[24].Description = "Allows running workload on control-plane nodes."
ClusterConfigDoc.Fields[24].Comments[encoder.LineComment] = "Allows running workload on control-plane nodes."
ClusterConfigDoc.Fields[24].AddExample("", true)
ClusterConfigDoc.Fields[24].Values = []string{
"true",
"yes",

View File

@ -642,7 +642,9 @@ inlineManifests:
adminKubeconfig:
certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year).
{{< /highlight >}}</details> | |
|`allowSchedulingOnControlPlanes` |bool |Allows running workload on control-plane nodes. |`true`<br />`yes`<br />`false`<br />`no`<br /> |
|`allowSchedulingOnControlPlanes` |bool |Allows running workload on control-plane nodes. <details><summary>Show example(s)</summary>{{< highlight yaml >}}
allowSchedulingOnControlPlanes: true
{{< /highlight >}}</details> |`true`<br />`yes`<br />`false`<br />`no`<br /> |