Skip to content

Commit a9c36f7

Browse files
committed
update rollback testing and add reviewers
Signed-off-by: Sally O'Malley <[email protected]>
1 parent d1a701c commit a9c36f7

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

keps/sig-instrumentation/2831-kubelet-tracing/README.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -211,14 +211,19 @@ spans propagated from kubelet to API server match what is expected from the requ
211211

212212
##### Unit tests
213213

214-
- `k8s.io/component-base/traces`: no test grid results - k8s.io/component-base/traces/config_test.go
214+
- https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/config/validation/validation_test.go#L503-#L532
215+
- https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/cri/remote/remote_runtime_test.go#L65-#L97
216+
- https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiserver/pkg/server/options/tracing_test.go
217+
- https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/component-base/tracing/api/v1/config_test.go
215218

216219
##### Integration tests
217220

218-
An integration test will verify that spans exported by the kubelet match what is
219-
expected from the request. We will also add an integration test that verifies
221+
Integration tests verify that spans exported by the kubelet match what is
222+
expected from the request. Also an integration test that verifies
220223
spans propagated from kubelet to API server match what is expected from the request.
221224

225+
- _component-base tracing/api/v1 integration test_ https://github.com/kubernetes/kubernetes/blob/master/test/integration/apiserver/tracing/tracing_test.go
226+
222227
##### e2e tests
223228

224229
- A test with kubelet-tracing & apiserver-tracing enabled to ensure no issues are introduced, regardless
@@ -230,18 +235,14 @@ Alpha
230235

231236
- [X] Implement tracing of incoming and outgoing gRPC, HTTP requests in the kubelet
232237
- [X] Integration testing of tracing
233-
- _component-base tracing/api/v1 integration test_ https://github.com/kubernetes/kubernetes/blob/master/test/integration/apiserver/tracing/tracing_test.go
234238
- [X] Unit testing of kubelet tracing and tracing configuration
235-
- https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/apis/config/validation/validation_test.go#L503-#L532
236-
- https://github.com/kubernetes/kubernetes/blob/master/pkg/kubelet/cri/remote/remote_runtime_test.go#L65-#L97
237-
- https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apiserver/pkg/server/options/tracing_test.go
238-
- https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/component-base/tracing/api/v1/config_test.go
239239

240240
Beta
241241

242242
- [X] OpenTelemetry reaches GA
243243
- [X] Publish examples of how to use the OT Collector with kubernetes
244244
- [X] Allow time for feedback
245+
- [ ] Test and document results of upgrade and rollback while feature-gate is enabled.
245246
- [ ] Add top level traces to connect spans in sync loops, incoming requests, and outgoing requests.
246247
- [ ] Unit/integration test to verify connected traces in kubelet.
247248
- [ ] Revisit the format used to export spans.
@@ -283,7 +284,7 @@ GA
283284
of a node? **No, restarting the kubelet with feature-gate disabled will disable tracing**
284285

285286
##### Does enabling the feature change any default behavior?
286-
No. The feature is disabled unlesss the feature gate is enabled and the TracingConfiguration is populated in Kubelet Configuration.
287+
No. The feature is disabled unless the feature gate is enabled and the TracingConfiguration is populated in Kubelet Configuration.
287288
When the feature is enabled, it doesn't change behavior from the users' perspective; it only adds tracing telemetry.
288289

289290
##### Can the feature be disabled once it has been enabled (i.e. can we roll back the enablement)?
@@ -293,8 +294,8 @@ GA
293294
It will start generating and exporting traces again.
294295

295296
##### Are there any tests for feature enablement/disablement?
296-
Unit tests switching feature gates will be added. Manual testing of disabling, reenabling the feature on nodes, ensuring the kubelet comes up w/out error will
297-
also be performed.
297+
Enabling and disabling kubelet tracing is an in-memory switch. Explicit enablement/disablement tests will not provide value so will not be added.
298+
Manual testing of disabling, reenabling the feature on nodes, ensuring the kubelet comes up w/out error will be performed and documented.
298299

299300
### Rollout, Upgrade and Rollback Planning
300301

@@ -344,7 +345,7 @@ _This section must be completed when targeting beta graduation to a release._
344345
##### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
345346

346347
- [] Metrics
347-
- Metric name: tbd
348+
- Metric name: tbd [opentelemetry-go issue #2547](https://github.com/open-telemetry/opentelemetry-go/issues/2547)
348349
- Components exposing the metric: kubelet
349350

350351
##### Are there any missing metrics that would be useful to have to improve observability

keps/sig-instrumentation/2831-kubelet-tracing/kep.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,11 @@ status: implementable
1212
creation-date: 2021-07-21
1313
reviewers:
1414
- "@dashpole"
15+
- "@ehashman"
1516
- "@wojtek-t"
1617
approvers:
1718
- "@dashpole"
19+
- "@ehashman"
1820
- "@wojtek-t"
1921
see-also:
2022
- "https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/647-apiserver-tracing"

0 commit comments

Comments
 (0)