Skip to content

fix: Address codebase TODOs in http.go and healthcheck.go #15218

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

Closed
vishnarac wants to merge 1 commit into from
+28 −7
Closed

fix: Address codebase TODOs in http.go and healthcheck.go #15218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions pkg/healthcheck/healthcheck.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,13 +168,11 @@ const (
keyKeyName = "tls.key"
)

// AllowedClockSkew sets the allowed skew in clock synchronization
// DefaultAllowedClockSkew sets the allowed skew in clock synchronization
// between the system running inject command and the node(s), being
// based on assumed node's heartbeat interval (5 minutes) plus default TLS
// clock skew allowance.
//
// TODO: Make this default value overridable, e.g. by CLI flag
const AllowedClockSkew = 5*time.Minute + tls.DefaultClockSkewAllowance
const DefaultAllowedClockSkew = 5*time.Minute + tls.DefaultClockSkewAllowance

var linkerdHAControlPlaneComponents = []string{
"linkerd-destination",
Expand Down Expand Up @@ -393,6 +391,7 @@ func (c *Category) WithHintBaseURL(hintBaseURL string) *Category {
// Options specifies configuration for a HealthChecker.
type Options struct {
IsMainCheckCommand bool
AllowedClockSkew time.Duration
ControlPlaneNamespace string
CNINamespace string
DataPlaneNamespace string
Expand Down Expand Up @@ -439,6 +438,10 @@ func NewHealthChecker(categoryIDs []CategoryID, options *Options) *HealthChecker
Options: options,
}

if hc.Options != nil && hc.Options.AllowedClockSkew == 0 {
hc.Options.AllowedClockSkew = DefaultAllowedClockSkew
}

hc.categories = hc.allCategories()

checkMap := map[CategoryID]struct{}{}
Expand Down Expand Up @@ -2670,7 +2673,7 @@ func (hc *HealthChecker) checkClockSkew(ctx context.Context) error {
// we want to check only KubeletReady condition and only execute if the node is ready
if condition.Type == corev1.NodeReady && condition.Status == corev1.ConditionTrue {
since := time.Since(condition.LastHeartbeatTime.Time)
if (since > AllowedClockSkew) || (since < -AllowedClockSkew) {
if (since > hc.AllowedClockSkew) || (since < -hc.AllowedClockSkew) {
clockSkewNodes = append(clockSkewNodes, node.Name)
}
}
Expand Down
22 changes: 20 additions & 2 deletions pkg/util/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,17 @@ const KB = 1024
const MB = KB * 1024

// ParseScheme converts a scheme string to protobuf
// TODO: validate scheme
func ParseScheme(scheme string) *httpPb.Scheme {
// Validate and sanitize input
scheme = strings.TrimSpace(scheme)
if scheme == "" {
return &httpPb.Scheme{
Type: &httpPb.Scheme_Unregistered{
Unregistered: "",
},
}
}

value, ok := httpPb.Scheme_Registered_value[strings.ToUpper(scheme)]
if ok {
return &httpPb.Scheme{
Expand All @@ -33,8 +42,17 @@ func ParseScheme(scheme string) *httpPb.Scheme {
}

// ParseMethod converts a method string to protobuf
// TODO: validate method
func ParseMethod(method string) *httpPb.HttpMethod {
// Validate and sanitize input
method = strings.TrimSpace(method)
if method == "" {
return &httpPb.HttpMethod{
Type: &httpPb.HttpMethod_Unregistered{
Unregistered: "",
},
}
}

value, ok := httpPb.HttpMethod_Registered_value[strings.ToUpper(method)]
if ok {
return &httpPb.HttpMethod{
Expand Down