Skip to content

Commit e35b408

Browse files
committed
address comments
1 parent 5d7d1d4 commit e35b408

File tree

1 file changed

+9
-6
lines changed
  • keps/sig-instrumentation/4827-component-statusz

1 file changed

+9
-6
lines changed

keps/sig-instrumentation/4827-component-statusz/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Items marked with (R) are required *prior to targeting to a milestone / release*
8383
- [x] (R) Graduation criteria is in place
8484
- [ ] (R) [all GA Endpoints](https://github.com/kubernetes/community/pull/1806) must be hit by [Conformance Tests](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/conformance-tests.md)
8585
- [x] (R) Production readiness review completed
86-
- [ ] (R) Production readiness review approved
86+
- [x] (R) Production readiness review approved
8787
- [x] "Implementation History" section is up-to-date for milestone
8888
- [ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
8989
- [ ] Supporting documentation—e.g., additional design documents, links to mailing list discussions/SIG meetings, relevant PRs/issues, release notes
@@ -160,13 +160,13 @@ We are proposing to add a new endpoint, /statusz on all core Kubernetes componen
160160

161161
3. **Premature Dependency on Unstable Format**
162162

163-
The alpha release will explicitly support plain text format only, making it clear that the output is not intended for parsing or automated monitoring. The feature will be secured behind a feature gate that is disabled by default, ensuring users opt-in consciously. Also, the endpoint will be implemented with versioned URLs to facilitate future transitions to structured formats without breaking existing integrations, once the usage patterns and requirements are better understood
163+
The alpha release will explicitly support plain text format only, making it clear that the output is not intended for parsing or automated monitoring. The feature will be secured behind a feature gate that is disabled by default, ensuring users opt-in consciously. Also, the endpoint will support specifying a version as a query parameter to facilitate future transitions to structured schema changes without breaking existing integrations, once the usage patterns and requirements are better understood
164164

165165
## Design Details
166166

167167
### Data Format and versioning
168168

169-
Initially, the statusz page will exclusively support a plain text format for responses. We will implement these endpoints using versioned URLs, like /statusz/v1, to ensure future compatibility. By using versioned URLs, like /statusz/v2, we can evolve the endpoint and introduce changes to the response schema without impacting clients relying on previous versions, ensuring backward compatibility.
169+
Initially, the statusz page will exclusively support a plain text format for responses. This endpoint will support specifying a version param, like /statusz?version=2, to ensure future compatibility. Through this, we can evolve the endpoint and introduce changes to the response schema without impacting clients relying on previous versions, ensuring backward compatibility.
170170

171171
### Authz and authn
172172

@@ -178,8 +178,10 @@ Access to the endpoint will be limited to members of the `system:monitoring grou
178178

179179
#### Request
180180
* Method: **GET**
181-
* Endpoint: **/statusz/v1**
181+
* Endpoint: **/statusz**
182182
* Header: `Content-Type: text/plain`
183+
* URL params:
184+
* version: (Optional) An integer representing the desired response schema version. Defaults to 1.
183185
* Body: empty
184186

185187
#### Response fields
@@ -203,6 +205,7 @@ Minimum Compatibility version: 1.30.0
203205
204206
List of useful endpoints
205207
--------------
208+
configz:/configz
206209
healthz:/healthz
207210
livez:/livez
208211
metrics:/metrics
@@ -260,12 +263,12 @@ The primary purpose of the statusz page is to provide information about the indi
260263

261264
### Feature Enablement and Rollback
262265

263-
We will target this feature behind a flag `ComponentStatuszFeatureGate`
266+
We will target this feature behind a flag `ComponentStatusz`
264267

265268
###### How can this feature be enabled / disabled in a live cluster?
266269

267270
- [x] Feature gate (also fill in values in `kep.yaml`)
268-
- Feature gate name: ComponentStatuszFeatureGate
271+
- Feature gate name: ComponentStatusz
269272
- Components depending on the feature gate:
270273
- apiserver
271274
- kubelet

0 commit comments

Comments
 (0)