Skip to content

Commit 4174afc

Browse files
tengqmtengqm
committed
Fix generator for kcm config reference v1alpha1
1 parent 95c79cb commit 4174afc

File tree

2 files changed

+204
-2
lines changed

2 files changed

+204
-2
lines changed

‎genref/config.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,9 @@ apis:
114114
path: config/v1alpha1
115115
includes:
116116
- k8s.io/cloud-provider/controllers/service/config/v1alpha1
117-
# - k8s.io/cloud-provider/controllers/node/config/v1alpha1
117+
- k8s.io/cloud-provider/controllers/node/config/v1alpha1
118118
- k8s.io/cloud-provider/config/v1alpha1
119+
- k8s.io/component-base/config/v1alpha1
119120
- k8s.io/controller-manager/config/v1alpha1
120121

121122
- name: kube-proxy-config

‎genref/output/md/kube-controller-manager-config.v1alpha1.md

Lines changed: 202 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,207 @@ auto_generated: true
1616

1717

1818

19+
## `ClientConnectionConfiguration` {#ClientConnectionConfiguration}
20+
21+
22+
**Appears in:**
23+
24+
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
25+
26+
27+
<p>ClientConnectionConfiguration contains details for constructing a client.</p>
28+
29+
30+
<table class="table">
31+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
32+
<tbody>
33+
34+
35+
<tr><td><code>kubeconfig</code> <B>[Required]</B><br/>
36+
<code>string</code>
37+
</td>
38+
<td>
39+
<p>kubeconfig is the path to a KubeConfig file.</p>
40+
</td>
41+
</tr>
42+
<tr><td><code>acceptContentTypes</code> <B>[Required]</B><br/>
43+
<code>string</code>
44+
</td>
45+
<td>
46+
<p>acceptContentTypes defines the Accept header sent by clients when connecting to a server, overriding the
47+
default value of 'application/json'. This field will control all connections to the server used by a particular
48+
client.</p>
49+
</td>
50+
</tr>
51+
<tr><td><code>contentType</code> <B>[Required]</B><br/>
52+
<code>string</code>
53+
</td>
54+
<td>
55+
<p>contentType is the content type used when sending data to the server from this client.</p>
56+
</td>
57+
</tr>
58+
<tr><td><code>qps</code> <B>[Required]</B><br/>
59+
<code>float32</code>
60+
</td>
61+
<td>
62+
<p>qps controls the number of queries per second allowed for this connection.</p>
63+
</td>
64+
</tr>
65+
<tr><td><code>burst</code> <B>[Required]</B><br/>
66+
<code>int32</code>
67+
</td>
68+
<td>
69+
<p>burst allows extra queries to accumulate when a client is exceeding its rate.</p>
70+
</td>
71+
</tr>
72+
</tbody>
73+
</table>
74+
75+
## `DebuggingConfiguration` {#DebuggingConfiguration}
76+
77+
78+
**Appears in:**
79+
80+
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
81+
82+
83+
<p>DebuggingConfiguration holds configuration for Debugging related features.</p>
84+
85+
86+
<table class="table">
87+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
88+
<tbody>
89+
90+
91+
<tr><td><code>enableProfiling</code> <B>[Required]</B><br/>
92+
<code>bool</code>
93+
</td>
94+
<td>
95+
<p>enableProfiling enables profiling via web interface host:port/debug/pprof/</p>
96+
</td>
97+
</tr>
98+
<tr><td><code>enableContentionProfiling</code> <B>[Required]</B><br/>
99+
<code>bool</code>
100+
</td>
101+
<td>
102+
<p>enableContentionProfiling enables block profiling, if
103+
enableProfiling is true.</p>
104+
</td>
105+
</tr>
106+
</tbody>
107+
</table>
108+
109+
## `LeaderElectionConfiguration` {#LeaderElectionConfiguration}
110+
111+
112+
**Appears in:**
113+
114+
- [GenericControllerManagerConfiguration](#controllermanager-config-k8s-io-v1alpha1-GenericControllerManagerConfiguration)
115+
116+
117+
<p>LeaderElectionConfiguration defines the configuration of leader election
118+
clients for components that can run with leader election enabled.</p>
119+
120+
121+
<table class="table">
122+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
123+
<tbody>
124+
125+
126+
<tr><td><code>leaderElect</code> <B>[Required]</B><br/>
127+
<code>bool</code>
128+
</td>
129+
<td>
130+
<p>leaderElect enables a leader election client to gain leadership
131+
before executing the main loop. Enable this when running replicated
132+
components for high availability.</p>
133+
</td>
134+
</tr>
135+
<tr><td><code>leaseDuration</code> <B>[Required]</B><br/>
136+
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
137+
</td>
138+
<td>
139+
<p>leaseDuration is the duration that non-leader candidates will wait
140+
after observing a leadership renewal until attempting to acquire
141+
leadership of a led but unrenewed leader slot. This is effectively the
142+
maximum duration that a leader can be stopped before it is replaced
143+
by another candidate. This is only applicable if leader election is
144+
enabled.</p>
145+
</td>
146+
</tr>
147+
<tr><td><code>renewDeadline</code> <B>[Required]</B><br/>
148+
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
149+
</td>
150+
<td>
151+
<p>renewDeadline is the interval between attempts by the acting master to
152+
renew a leadership slot before it stops leading. This must be less
153+
than or equal to the lease duration. This is only applicable if leader
154+
election is enabled.</p>
155+
</td>
156+
</tr>
157+
<tr><td><code>retryPeriod</code> <B>[Required]</B><br/>
158+
<a href="https://pkg.go.dev/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"><code>meta/v1.Duration</code></a>
159+
</td>
160+
<td>
161+
<p>retryPeriod is the duration the clients should wait between attempting
162+
acquisition and renewal of a leadership. This is only applicable if
163+
leader election is enabled.</p>
164+
</td>
165+
</tr>
166+
<tr><td><code>resourceLock</code> <B>[Required]</B><br/>
167+
<code>string</code>
168+
</td>
169+
<td>
170+
<p>resourceLock indicates the resource object type that will be used to lock
171+
during leader election cycles.</p>
172+
</td>
173+
</tr>
174+
<tr><td><code>resourceName</code> <B>[Required]</B><br/>
175+
<code>string</code>
176+
</td>
177+
<td>
178+
<p>resourceName indicates the name of resource object that will be used to lock
179+
during leader election cycles.</p>
180+
</td>
181+
</tr>
182+
<tr><td><code>resourceNamespace</code> <B>[Required]</B><br/>
183+
<code>string</code>
184+
</td>
185+
<td>
186+
<p>resourceName indicates the namespace of resource object that will be used to lock
187+
during leader election cycles.</p>
188+
</td>
189+
</tr>
190+
</tbody>
191+
</table>
192+
193+
## `NodeControllerConfiguration` {#NodeControllerConfiguration}
194+
195+
196+
**Appears in:**
197+
198+
- [CloudControllerManagerConfiguration](#cloudcontrollermanager-config-k8s-io-v1alpha1-CloudControllerManagerConfiguration)
199+
200+
201+
<p>NodeControllerConfiguration contains elements describing NodeController.</p>
202+
203+
204+
<table class="table">
205+
<thead><tr><th width="30%">Field</th><th>Description</th></tr></thead>
206+
<tbody>
207+
208+
209+
<tr><td><code>ConcurrentNodeSyncs</code> <B>[Required]</B><br/>
210+
<code>int32</code>
211+
</td>
212+
<td>
213+
<p>ConcurrentNodeSyncs is the number of workers
214+
concurrently synchronizing nodes</p>
215+
</td>
216+
</tr>
217+
</tbody>
218+
</table>
219+
19220
## `ServiceControllerConfiguration` {#ServiceControllerConfiguration}
20221

21222

@@ -78,7 +279,7 @@ both in cloud controller manager and kube-controller manager.</p>
78279
</td>
79280
</tr>
80281
<tr><td><code>NodeController</code> <B>[Required]</B><br/>
81-
<code>k8s.io/cloud-provider/controllers/node/config/v1alpha1.NodeControllerConfiguration</code>
282+
<a href="#NodeControllerConfiguration"><code>NodeControllerConfiguration</code></a>
82283
</td>
83284
<td>
84285
<p>NodeController holds configuration for node controller

0 commit comments

Comments
 (0)