Skip to content

Commit 2b54106

Browse files
author
Han Kang
committed
update kep with additional information
1 parent 6ede6f1 commit 2b54106

File tree

1 file changed

+9
-11
lines changed
  • keps/sig-instrumentation/3466-kubernetes-component-health-slis

1 file changed

+9
-11
lines changed

keps/sig-instrumentation/3466-kubernetes-component-health-slis/README.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -250,13 +250,15 @@ without any issues.
250250

251251
##### Integration tests
252252

253-
- [ ] ensure existence of healthcheck endpoint (beta requirement)
253+
- [ X ] ensure existence of healthcheck endpoint (beta requirement)
254254

255255
- <test>: <link to test coverage>
256256

257257
##### e2e tests
258258

259-
- [ ] ensure existence of healthcheck endpoint (beta requirement)
259+
Given this feature is purely in-memory, no enablement/disablement tests are needed.
260+
261+
- [ X ] ensure existence of healthcheck endpoint (beta requirement)
260262

261263
- <test>: <link to test coverage>
262264

@@ -345,10 +347,6 @@ We will target this feature behind a flag `ComponentSLIs`
345347
+ controller-manager
346348
+ kube-proxy
347349

348-
###### Are there any tests for feature enablement/disablement?
349-
350-
Given this feature is purely in-memory, no enablement/disablement tests are needed.
351-
352350
###### Does enabling the feature change any default behavior?
353351

354352
Yes it will expose a new metrics endpoint.
@@ -363,7 +361,7 @@ It will expose the metrics endpoint again
363361

364362
###### Are there any tests for feature enablement/disablement?
365363

366-
We intend to add them with our e2e tests.
364+
Given this feature is purely in-memory, no enablement/disablement tests are needed.
367365

368366
### Rollout, Upgrade and Rollback Planning
369367

@@ -396,7 +394,7 @@ They can check their prometheus scrape configs.
396394

397395
###### How can someone using this feature know that it is working for their instance?
398396

399-
They can curl the apiserver's `metrics/slis` endpoint.
397+
They can curl any of the kubernetes components's (except etcd) `metrics/slis` endpoint.
400398

401399
###### What are the reasonable SLOs (Service Level Objectives) for the enhancement?
402400

@@ -466,9 +464,9 @@ details). For now, we leave it here.
466464

467465
###### How does this feature react if the API server and/or etcd is unavailable?
468466

469-
If apiserver is unavailable, then you will not be able to ingest the metrics from the apiserver.
470-
However, the failure of etcd should allow you to scrape the metrics from apiserver, so long as
471-
it is otherwise healthy.
467+
If component is unavailable, then you will not be able to ingest the metrics from the component.
468+
However, in the case of the apiserver, the failure of etcd should allow you to scrape the metrics
469+
from component, so long as it is otherwise healthy.
472470

473471
###### What are other known failure modes?
474472

0 commit comments

Comments
 (0)