fix(lint): skip POP-105 for GRPC probes (must use port numbers) - #579
Open
beltagyy wants to merge 1 commit into
Open
fix(lint): skip POP-105 for GRPC probes (must use port numbers)#579beltagyy wants to merge 1 commit into
beltagyy wants to merge 1 commit into
Conversation
Kubernetes GRPC health probes must use port numbers, not named ports. The API spec (v1.35+) enforces this: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#grpcaction-v1-core POP-105 flags probes that use port numbers with the message "uses a port#, prefer a named port". GRPC probes were incorrectly flagged because checkNamedProbe only exempted nil HTTP probes. Fix: checkNamedProbe now returns early when p.ProbeHandler.GRPC != nil, immediately before the HTTPGet-based port-number check. Adds "GRPCNoIssue" test case verifying no POP-105 is emitted for GRPC-based liveness and readiness probes with numeric ports. Fixes derailed#570
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
POP-105 flags probes that use port numbers with the message "Liveness uses a port#, prefer a named port".
Kubernetes GRPC probes must use port numbers — named ports are
disallowed by the API spec:
https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.35/#grpcaction-v1-core
This causes a false positive when scanning pods with GRPC
liveness/readiness probes. Issue #570 reported this.
Fix
In
checkNamedProbe, return early whenp.ProbeHandler.GRPC != nilbefore the HTTPGet-based port-number check.
Verification
GRPCNoIssuetest case (liveness+readiness with GRPC ports)internal/linttests passFixes #570