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.

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

docs: Update the mutual authentication key format #27640

Merged
merged 1 commit into from
Aug 23, 2023
Merged

docs: Update the mutual authentication key format #27640

merged 1 commit into from
Aug 23, 2023

Conversation

haiyuewa
Copy link
Contributor

The commit 31592e7 ("auth: optimize log output for pending auth") adds new field 'key' to beautify the log message.

So update the authentication key format according to the real log message captured:
2023-08-23T10:22:04.308373113+08:00 level=debug msg="Policy is requiring authentication" key="localIdentity=13137, remoteIdentity=43715, remoteNodeID=54264, authType=spire" subsys=auth
2023-08-23T10:22:04.313513823+08:00 level=debug msg="Validating Server SNI" SNI ID=43715 subsys=auth
2023-08-23T10:22:04.313513823+08:00 level=debug msg="Validated certificate" subsys=auth uri-san="[spiffe://spiffe.cilium/identity/43715]"
2023-08-23T10:22:04.314043168+08:00 level=debug msg="Successfully authenticated" key="localIdentity=13137, remoteIdentity=43715, remoteNodeID=54264, authType=spire" remote_node_ip=10.10.10.1 subsys=auth

The commit 31592e7 ("auth: optimize log output for pending auth")
adds new field 'key' to beautify the log message.

So update the authentication key format according to the real log
message captured:
	2023-08-23T10:22:04.308373113+08:00 level=debug msg="Policy is requiring authentication" key="localIdentity=13137, remoteIdentity=43715, remoteNodeID=54264, authType=spire" subsys=auth
	2023-08-23T10:22:04.313513823+08:00 level=debug msg="Validating Server SNI" SNI ID=43715 subsys=auth
	2023-08-23T10:22:04.313513823+08:00 level=debug msg="Validated certificate" subsys=auth uri-san="[spiffe://spiffe.cilium/identity/43715]"
	2023-08-23T10:22:04.314043168+08:00 level=debug msg="Successfully authenticated" key="localIdentity=13137, remoteIdentity=43715, remoteNodeID=54264, authType=spire" remote_node_ip=10.10.10.1 subsys=auth

Signed-off-by: Haiyue Wang <haiyue.wang@intel.com>
@haiyuewa haiyuewa requested review from a team as code owners August 23, 2023 03:14
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Aug 23, 2023
@github-actions github-actions bot added the kind/community-contribution This was a contribution made by a community member. label Aug 23, 2023
@joestringer joestringer added release-note/misc This PR makes changes that have no direct user impact. needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Aug 23, 2023
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Aug 23, 2023
@joestringer
Copy link
Member

/test

Copy link
Member

@mhofstetter mhofstetter left a comment

Choose a reason for hiding this comment

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

thanks @haiyuewa

@mhofstetter mhofstetter added area/servicemesh GH issues or PRs regarding servicemesh feature/authentication kind/cleanup This includes no functional changes. area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. labels Aug 23, 2023
Copy link
Contributor

@zacharysarah zacharysarah left a comment

Choose a reason for hiding this comment

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

LGTM

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Aug 23, 2023
@borkmann borkmann merged commit 21964b6 into cilium:main Aug 23, 2023
57 checks passed
@haiyuewa haiyuewa deleted the sync-auth-key-format-log branch August 23, 2023 06:59
@tklauser tklauser mentioned this pull request Aug 24, 2023
9 tasks
@tklauser tklauser added backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. and removed needs-backport/1.14 This PR / issue needs backporting to the v1.14 branch labels Aug 24, 2023
@joestringer joestringer added backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. and removed backport-pending/1.14 The backport for Cilium 1.14.x for this PR is in progress. labels Aug 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/servicemesh GH issues or PRs regarding servicemesh backport-done/1.14 The backport for Cilium 1.14.x for this PR is done. feature/authentication kind/cleanup This includes no functional changes. kind/community-contribution This was a contribution made by a community member. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants