You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: keps/sig-instrumentation/4827-component-statusz/README.md
+9-6Lines changed: 9 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,7 @@ Items marked with (R) are required *prior to targeting to a milestone / release*
83
83
-[x] (R) Graduation criteria is in place
84
84
-[ ] (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)
85
85
-[x] (R) Production readiness review completed
86
-
-[] (R) Production readiness review approved
86
+
-[x] (R) Production readiness review approved
87
87
-[x] "Implementation History" section is up-to-date for milestone
88
88
-[ ] User-facing documentation has been created in [kubernetes/website], for publication to [kubernetes.io]
89
89
-[ ] 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
160
160
161
161
3.**Premature Dependency on Unstable Format**
162
162
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
164
164
165
165
## Design Details
166
166
167
167
### Data Format and versioning
168
168
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.
170
170
171
171
### Authz and authn
172
172
@@ -178,8 +178,10 @@ Access to the endpoint will be limited to members of the `system:monitoring grou
178
178
179
179
#### Request
180
180
* Method: **GET**
181
-
* Endpoint: **/statusz/v1**
181
+
* Endpoint: **/statusz**
182
182
* Header: `Content-Type: text/plain`
183
+
* URL params:
184
+
* version: (Optional) An integer representing the desired response schema version. Defaults to 1.
0 commit comments