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

Update documentation for CNI plugin logging #2418

Closed
jdn5126 opened this issue Jun 13, 2023 · 2 comments
Closed

Update documentation for CNI plugin logging #2418

jdn5126 opened this issue Jun 13, 2023 · 2 comments

Comments

@jdn5126
Copy link
Contributor

jdn5126 commented Jun 13, 2023

What would you like to be added:
Clarify in https://github.com/aws/amazon-vpc-cni-k8s#aws_vpc_k8s_plugin_log_file that since CNI is exec'ed by the container-runtime in k8s 1.24+, setting the log file to stdout or stderr will redirect to stdout/stderr for container-runtime process (usually containerd), NOT aws-node pod.

Also, fix the logic in https://github.com/aws/amazon-vpc-cni-k8s/blob/master/pkg/utils/logger/zaplogger.go#L130 to handle the string "stderr".

Also, clarify that stderr is an accepted value for https://github.com/aws/amazon-vpc-cni-k8s#aws_vpc_k8s_cni_log_file and that stdout/stderr will show up in the aws-node pod logs since aws-k8s-agent (IPAMD) process runs in the pod.

Why is this needed:
To improve readability and reduce confusion for customers.

@jdn5126
Copy link
Contributor Author

jdn5126 commented Jun 13, 2023

Also, clarify at https://github.com/aws/amazon-vpc-cni-k8s#aws_vpc_k8s_cni_log_file that /host/ is the container file system path, while /var/log/... is the node path.

Also, clarify that setting https://github.com/aws/amazon-vpc-cni-k8s#aws_vpc_k8s_plugin_log_file to the empty string redirects logs to stderr, and that comes from upstream k8s practices

@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant