Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document log sanitization feature #24845

Merged
merged 3 commits into from
Nov 24, 2020
Merged

Document log sanitization feature #24845

merged 3 commits into from
Nov 24, 2020

Conversation

serathius
Copy link
Contributor

@serathius serathius commented Nov 2, 2020 •
edited
Loading

@k8sio-netlify-preview-bot
Copy link
Collaborator

k8sio-netlify-preview-bot commented Nov 2, 2020 •
edited
Loading

Deploy preview for kubernetes-io-vnext-staging processing.

Building with commit a65e139

https://app.netlify.com/sites/kubernetes-io-vnext-staging/deploys/5fbbd66fb458ae000790856a

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Nov 2, 2020
@k8s-ci-robot k8s-ci-robot added language/en Issues or PRs related to English language size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Nov 2, 2020
@serathius serathius mentioned this pull request Nov 2, 2020
Closed
@annajung
Copy link
Contributor

annajung commented Nov 2, 2020

/milestone 1.20
/sig intrumentation
/cc @somtochiama
/hold pending kubernetes/enhancements#1753 (comment)

@k8s-ci-robot
Copy link
Contributor

@annajung: The label(s) sig/intrumentation cannot be applied, because the repository doesn't have them

In response to this:

/milestone 1.20
/sig intrumentation
/cc @somtochiama
/hold pending kubernetes/enhancements#1753 (comment)

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 2, 2020
@k8s-ci-robot k8s-ci-robot added this to the 1.20 milestone Nov 2, 2020
@annajung
Copy link
Contributor

annajung commented Nov 2, 2020

/sig instrumentation

@k8s-ci-robot k8s-ci-robot added the sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. label Nov 2, 2020
@sftim sftim marked this pull request as draft November 2, 2020 23:59
@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 2, 2020
@annajung
Copy link
Contributor

annajung commented Nov 5, 2020

/assign @somtochiama

@sftim
Copy link
Contributor

sftim commented Nov 10, 2020

Hi @serathius

The earlier you can provide (some / most of) the content for documenting this feature, the earlier that SIG Docs can get reviewing. We'd really appreciate a chance to get as much reviewing done as we can before KubeCon.

@annajung
Copy link
Contributor

/hold cancel
k/k prs merged

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 13, 2020
@somtochiama
Copy link
Member

Heyy @serathius,
The docs deadline is on the 23rd of November and we would appreciate it if you could add some content to the PR so we could get started reviewing! Thank you.

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Nov 20, 2020
@serathius serathius marked this pull request as ready for review November 20, 2020 14:11
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 20, 2020
@serathius
Copy link
Contributor Author

@somtochiama @sftim PTAL

@annajung
Copy link
Contributor

page preview https://deploy-preview-24845--kubernetes-io-vnext-staging.netlify.app/docs/concepts/cluster-administration/system-logs/#log-sanitization

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: dc7c3c987abe9add84b608fcdfa978b5a7ffd060

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2020
@sftim
Copy link
Contributor

sftim commented Nov 23, 2020

@serathius I'm guessing this is good to review? If so, please would you also revise the PR description so that it's completely clear.

@serathius
Copy link
Contributor Author

serathius commented Nov 23, 2020 •
edited
Loading

done

irvifa
irvifa reviewed Nov 23, 2020
View reviewed changes
Copy link
Member

@irvifa irvifa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/label tide/merge-method-squash
/lgtm

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Nov 23, 2020
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 23, 2020
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 5d338c630ae992d321490db49d2e81158adbc71d

kbhawkey
kbhawkey reviewed Nov 23, 2020
View reviewed changes
content/en/docs/concepts/cluster-administration/system-logs.md
If enabled all log arguments are inspected for fields tagged as sensitive data (e.g. passwords, keys, tokens) and logging of these fields will be prevented.

List of components currently supporting log sanitization:
* {{< glossary_tooltip term_id="kube-controller-manager" text="kube-controller-manager" >}}
Copy link
Contributor

@kbhawkey kbhawkey Nov 23, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Line 102, wording
The --experimental-logging-sanitization flag enables the klog sanitization filter.

nit: It does not make sense to repeat or overuse the tooltips in this section.
Instead you could list the tools:
kube-apiserver
kube-controller-manager
...

nit: Wording in note, Line 111:
The Log sanitization filter does not prevent user workload logs from leaking sensitive data.

@dashpole
Copy link
Contributor

/lgtm
from sig-instrumentation

@reylejano
Copy link
Member

/lgtm

irvifa
irvifa reviewed Nov 24, 2020
View reviewed changes
Copy link
Member

@irvifa irvifa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can revise later perhaps since it’s already the deadline
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: irvifa

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 24, 2020
@k8s-ci-robot k8s-ci-robot merged commit d7a3f5d into kubernetes:dev-1.20 Nov 24, 2020
rf232 added a commit to rf232/website that referenced this pull request Nov 24, 2020
@rf232
Small wording update on Log sanitization docs
1de3ac5 
Follow up to PR kubernetes#24845, following the remarks kbhawkey had
@rf232 rf232 mentioned this pull request Nov 24, 2020
Merged
@kbhawkey
Copy link
Contributor

👋 @irvifa ,
Sometimes it is good to ask before approving? This is a team effort. Thank you!

@irvifa
Copy link
Member

irvifa commented Nov 24, 2020

@kbhawkey thanks for the reminder will do it next time

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@irvifa irvifa irvifa left review comments

@kbhawkey kbhawkey kbhawkey left review comments

@44past4 44past4 Awaiting requested review from 44past4

@dims dims Awaiting requested review from dims

@somtochiama somtochiama Awaiting requested review from somtochiama

Assignees

@dashpole dashpole

@irvifa irvifa

@annajung annajung

@somtochiama somtochiama

@reylejano reylejano

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Milestone
1.20
Development

Successfully merging this pull request may close these issues.