mirror of
				https://github.com/siderolabs/talos.git
				synced 2025-11-04 10:21:13 +01:00 
			
		
		
		
	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:
		
							parent
							
								
									c74d937280
								
							
						
					
					
						commit
						e5a36268b6
					
				@ -1051,6 +1051,8 @@ type ClusterConfig struct {
 | 
				
			|||||||
	//     - yes
 | 
						//     - yes
 | 
				
			||||||
	//     - false
 | 
						//     - false
 | 
				
			||||||
	//     - no
 | 
						//     - no
 | 
				
			||||||
 | 
						//   examples:
 | 
				
			||||||
 | 
						//     - value: true
 | 
				
			||||||
	AllowSchedulingOnControlPlanes *bool `yaml:"allowSchedulingOnControlPlanes,omitempty"`
 | 
						AllowSchedulingOnControlPlanes *bool `yaml:"allowSchedulingOnControlPlanes,omitempty"`
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
@ -523,6 +523,8 @@ func init() {
 | 
				
			|||||||
	ClusterConfigDoc.Fields[24].Note = ""
 | 
						ClusterConfigDoc.Fields[24].Note = ""
 | 
				
			||||||
	ClusterConfigDoc.Fields[24].Description = "Allows running workload on control-plane nodes."
 | 
						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].Comments[encoder.LineComment] = "Allows running workload on control-plane nodes."
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
						ClusterConfigDoc.Fields[24].AddExample("", true)
 | 
				
			||||||
	ClusterConfigDoc.Fields[24].Values = []string{
 | 
						ClusterConfigDoc.Fields[24].Values = []string{
 | 
				
			||||||
		"true",
 | 
							"true",
 | 
				
			||||||
		"yes",
 | 
							"yes",
 | 
				
			||||||
 | 
				
			|||||||
@ -642,7 +642,9 @@ inlineManifests:
 | 
				
			|||||||
adminKubeconfig:
 | 
					adminKubeconfig:
 | 
				
			||||||
    certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year).
 | 
					    certLifetime: 1h0m0s # Admin kubeconfig certificate lifetime (default is 1 year).
 | 
				
			||||||
{{< /highlight >}}</details> | |
 | 
					{{< /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 /> |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
				
			|||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user