Skip to content

Commit 875dc3f

Browse files
authored
KEP-1753: Deprecate dynamic log sanitization (#3096)
* Rehome KEP-1753 for deprecation SIG Instrumentation is leading the deprecation of this feature as we own some of the code. We started it, we'll finish it :) * Update KEP-1753 metadata for deprecation * Update KEP-1753 with deprecation notice
1 parent d452a4b commit 875dc3f

File tree

2 files changed

+21
-6
lines changed

2 files changed

+21
-6
lines changed

keps/sig-security/1753-logs-sanitization/README.md renamed to keps/sig-instrumentation/1753-logs-sanitization/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
- [Goals](#goals)
88
- [Non-Goals](#non-goals)
99
- [Proposal](#proposal)
10+
- [Deprecation](#deprecation)
1011
- [Risks and Mitigations](#risks-and-mitigations)
1112
- [Performance overhead](#performance-overhead)
1213
- [Design Details](#design-details)
@@ -105,6 +106,16 @@ We also propose to implement a small library which could use the above informati
105106

106107
Finally we propose to integrate this library with the klog logging library used by Kubernetes in a way that when enabled the log entries which contain information marked as sensitive will be redacted from the logs.
107108

109+
### Deprecation
110+
111+
Dynamic log sanitization was added as an experimental alpha feature under SIG Instrumentation in the 1.20 release. When it was introduced, the SIG had some reservations about the feature and its performance, but concluded that an alpha POC would be low risk. We encouraged exploring alternatives, and that eventually resulted in the implementation of static analysis as part of our presubmit CI to ensure secrets are not being logged. This alternative implementation has graduated to stable in the 1.23 cycle.
112+
113+
During SIG Instrumentation's Dec. 9 meeting, we discussed the support burden of this feature and the issues this may cause in blocking other new logging improvements. Hence, we would like to deprecate the feature in the 1.24 cycle. Since this is an alpha feature, this means it will be entirely removed.
114+
115+
Note that [data policy tags](#source-code-tags) will not be deprecated or removed, as they are currently in use by [KEP-1933] and may be used by other automated tools in the future.
116+
117+
[KEP-1933]: /keps/sig-security/1933-secret-logging-static-analysis/README.md
118+
108119
### Risks and Mitigations
109120

110121
#### Performance overhead
@@ -231,6 +242,7 @@ To address them we propose:
231242

232243
* 2020-05-08 - Original Proposal
233244
* 2020-08-07 - Merged as provisional
245+
* 2021-12-23 - Marked for deprecation
234246

235247
## Drawbacks
236248

keps/sig-security/1753-logs-sanitization/kep.yaml renamed to keps/sig-instrumentation/1753-logs-sanitization/kep.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@ authors:
44
- "@44past4"
55
- "@immutableT"
66
- "@PurelyApplied"
7-
owning-sig: sig-security
7+
owning-sig: sig-instrumentation
88
participating-sigs:
9-
- sig-instrumentation
10-
status: implementable
9+
- sig-security
10+
status: implemented (alpha)
1111
creation-date: 2020-05-07
12-
last-updated: 2020-10-14
13-
stage: alpha
14-
latest-milestone: "1.19"
12+
stage: alpha (deprecated)
13+
latest-milestone: "1.24"
14+
milestone:
15+
alpha: "v1.19"
16+
deprecated: "v1.24"
17+
removed: "v1.24"
1518
reviewers:
1619
- "@ehashman"
1720
approvers:

0 commit comments

Comments
 (0)