Skip to content

Adds fields for PassiveHealthCheck on IngressGateway #2796

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

Merged
missylbytes merged 8 commits into from
Aug 29, 2023
Merged

Adds fields for PassiveHealthCheck on IngressGateway #2796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c0dce33
Adds fields for PassiveHealthCheck on IngressGateway
missylbytes Aug 18, 2023
0610f33
some cleanup
missylbytes Aug 18, 2023
d11b634
adds changelog
missylbytes Aug 23, 2023
42e4b7d
address PR comments
missylbytes Aug 24, 2023
8a228c9
ran make ctrl-manifests
missylbytes Aug 28, 2023
b9a8f85
Update .changelog/2796.txt
missylbytes Aug 29, 2023
37379ec
Adds example for interval value in passiveHealthCheck
missylbytes Aug 29, 2023
60c9285
update changelog message
missylbytes Aug 29, 2023
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
3 changes: 3 additions & 0 deletions .changelog/2796.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
ingress-gateway: Adds missing PassiveHealthCheck to IngressGateways CRD and updates missing fields on ServiceDefaults CRD
```
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/bases/job-client/job.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

apiVersion: batch/v1
kind: Job
metadata:
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/bases/job-client/service.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

apiVersion: v1
kind: Service
metadata:
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/bases/job-client/serviceaccount.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

apiVersion: v1
kind: ServiceAccount
metadata:
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/cases/jobs/job-client-inject-grace-period-0s/kustomization.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0


resources:
- ../../../bases/job-client
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/cases/jobs/job-client-inject-grace-period-0s/patch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

apiVersion: batch/v1
kind: Job
metadata:
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/cases/jobs/job-client-inject-grace-period-10s/kustomization.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0


resources:
- ../../../bases/job-client
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/cases/jobs/job-client-inject-grace-period-10s/patch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

apiVersion: batch/v1
kind: Job
metadata:
Expand Down
3 changes: 3 additions & 0 deletions acceptance/tests/fixtures/cases/jobs/job-client-inject/patch.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0

apiVersion: batch/v1
kind: Job
metadata:
Expand Down
78 changes: 78 additions & 0 deletions charts/consul/templates/crd-ingressgateways.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,43 @@ spec:
while waiting for a connection to be established.
format: int32
type: integer
passiveHealthCheck:
description: PassiveHealthCheck configuration determines how upstream
proxy instances will be monitored for removal from the load
balancing pool.
properties:
baseEjectionTime:
description: The base time that a host is ejected for. The
real time is equal to the base time multiplied by the number
of times the host has been ejected and is capped by max_ejection_time
(Default 300s). Defaults to 30s.
type: string
enforcingConsecutive5xx:
description: EnforcingConsecutive5xx is the % chance that
a host will be actually ejected when an outlier status is
detected through consecutive 5xx. This setting can be used
Comment thread
t-eckert marked this conversation as resolved.
to disable ejection or to ramp it up slowly. Ex. Setting
this to 10 will make it a 10% chance that the host will
be ejected.
format: int32
type: integer
interval:
Copy link
Copy Markdown
Contributor

@t-eckert t-eckert Aug 23, 2023

Choose a reason for hiding this comment

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

How is this string to be formatted?

Copy link
Copy Markdown
Contributor Author

@missylbytes missylbytes Aug 24, 2023

Choose a reason for hiding this comment

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

I'm not sure what would actually apply here: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#format
I think this is just "basic string"

Copy link
Copy Markdown
Contributor

@t-eckert t-eckert Aug 29, 2023

Choose a reason for hiding this comment

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

For this, I would add an example. I think the answer is something like "10s" as the way the input should be formatted.

Copy link
Copy Markdown
Contributor Author

@missylbytes missylbytes Aug 29, 2023

Choose a reason for hiding this comment

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

done

description: Interval between health check analysis sweeps.
Each sweep may remove hosts or return hosts to the pool.
Ex. setting this to "10s" will set the interval to 10 seconds.
type: string
maxEjectionPercent:
description: The maximum % of an upstream cluster that can
be ejected due to outlier detection. Defaults to 10% but
will eject at least one host regardless of the value.
format: int32
type: integer
maxFailures:
description: MaxFailures is the count of consecutive failures
that results in a host being removed from the pool.
format: int32
type: integer
type: object
type: object
listeners:
description: Listeners declares what ports the ingress gateway should
Expand Down Expand Up @@ -160,6 +197,47 @@ spec:
service is located. Partitioning is a Consul Enterprise
feature.
type: string
passiveHealthCheck:
description: PassiveHealthCheck configuration determines
how upstream proxy instances will be monitored for removal
from the load balancing pool.
properties:
baseEjectionTime:
description: The base time that a host is ejected
for. The real time is equal to the base time multiplied
by the number of times the host has been ejected
and is capped by max_ejection_time (Default 300s).
Defaults to 30s.
type: string
enforcingConsecutive5xx:
description: EnforcingConsecutive5xx is the % chance
that a host will be actually ejected when an outlier
status is detected through consecutive 5xx. This
setting can be used to disable ejection or to ramp
it up slowly. Ex. Setting this to 10 will make it
a 10% chance that the host will be ejected.
format: int32
type: integer
interval:
description: Interval between health check analysis
sweeps. Each sweep may remove hosts or return hosts
to the pool. Ex. setting this to "10s" will set
the interval to 10 seconds.
type: string
maxEjectionPercent:
description: The maximum % of an upstream cluster
that can be ejected due to outlier detection. Defaults
to 10% but will eject at least one host regardless
of the value.
format: int32
type: integer
maxFailures:
description: MaxFailures is the count of consecutive
failures that results in a host being removed from
the pool.
format: int32
type: integer
type: object
requestHeaders:
description: Allow HTTP header manipulation to be configured.
properties:
Expand Down
19 changes: 10 additions & 9 deletions charts/consul/templates/crd-proxydefaults.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,15 +163,6 @@ spec:
type: string
type: array
type: object
prioritizeByLocality:
description: PrioritizeByLocality contains the configuration for
locality aware routing.
properties:
mode:
description: Mode specifies the behavior of PrioritizeByLocality
routing. Valid values are "", "none", and "failover".
type: string
type: object
meshGateway:
description: MeshGateway controls the default mesh gateway configuration
for this service.
Expand Down Expand Up @@ -204,6 +195,16 @@ spec:
your services secure, we recommend using "strict" mode whenever
possible and enabling "permissive" mode only when necessary.'
type: string
prioritizeByLocality:
description: PrioritizeByLocality controls whether the locality of
services within the local partition will be used to prioritize connectivity.
properties:
mode:
description: 'Mode specifies the type of prioritization that will
be performed when selecting nodes in the local partition. Valid
values are: "" (default "none"), "none", and "failover".'
type: string
type: object
Copy link
Copy Markdown
Member

@zalimeni zalimeni Aug 29, 2023

Choose a reason for hiding this comment

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

Just wanted to add that this should be fine; I didn’t understand how to properly generate changes to this CRD in my first PR updating it and was going to circle back to fix this.

transparentProxy:
description: 'TransparentProxy controls configuration specific to
proxies in transparent mode. Note: This cannot be set using the
Expand Down
10 changes: 8 additions & 2 deletions charts/consul/templates/crd-routeretryfilters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.9.2
controller-gen.kubebuilder.io/version: v0.8.0
creationTimestamp: null
name: routeretryfilters.consul.hashicorp.com
labels:
Expand Down Expand Up @@ -53,7 +53,7 @@ spec:
metadata:
type: object
spec:
description: RouteRetryFilterSpec defines the desired state of RouteRetryFilter
description: RouteRetryFilterSpec defines the desired state of RouteRetryFilter.
properties:
numRetries:
format: int32
Expand Down Expand Up @@ -114,4 +114,10 @@ spec:
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []
{{- end }}
10 changes: 8 additions & 2 deletions charts/consul/templates/crd-routetimeoutfilters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.9.2
controller-gen.kubebuilder.io/version: v0.8.0
Comment thread
missylbytes marked this conversation as resolved.
creationTimestamp: null
name: routetimeoutfilters.consul.hashicorp.com
labels:
Expand Down Expand Up @@ -54,7 +54,7 @@ spec:
metadata:
type: object
spec:
description: RouteTimeoutFilterSpec defines the desired state of RouteTimeoutFilter
description: RouteTimeoutFilterSpec defines the desired state of RouteTimeoutFilter.
properties:
idleTimeout:
description: A Duration represents the elapsed time between two instants
Expand Down Expand Up @@ -112,4 +112,10 @@ spec:
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []
{{- end }}
13 changes: 10 additions & 3 deletions charts/consul/templates/crd-servicedefaults.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,18 +294,22 @@ spec:
The real time is equal to the base time multiplied by
the number of times the host has been ejected and is
capped by max_ejection_time (Default 300s). Defaults
to 30000ms or 30s.
to 30s.
type: string
enforcingConsecutive5xx:
description: EnforcingConsecutive5xx is the % chance that
a host will be actually ejected when an outlier status
is detected through consecutive 5xx. This setting can
be used to disable ejection or to ramp it up slowly.
Ex. Setting this to 10 will make it a 10% chance that
the host will be ejected.
format: int32
type: integer
interval:
description: Interval between health check analysis sweeps.
Each sweep may remove hosts or return hosts to the pool.
Ex. setting this to "10s" will set the interval to 10
seconds.
type: string
maxEjectionPercent:
description: The maximum % of an upstream cluster that
Expand Down Expand Up @@ -411,19 +415,22 @@ spec:
The real time is equal to the base time multiplied
by the number of times the host has been ejected and
is capped by max_ejection_time (Default 300s). Defaults
to 30000ms or 30s.
to 30s.
type: string
enforcingConsecutive5xx:
description: EnforcingConsecutive5xx is the % chance
that a host will be actually ejected when an outlier
status is detected through consecutive 5xx. This setting
can be used to disable ejection or to ramp it up slowly.
Ex. Setting this to 10 will make it a 10% chance that
the host will be ejected.
format: int32
type: integer
interval:
description: Interval between health check analysis
sweeps. Each sweep may remove hosts or return hosts
to the pool.
to the pool. Ex. setting this to "10s" will set the
interval to 10 seconds.
type: string
maxEjectionPercent:
description: The maximum % of an upstream cluster that
Expand Down
6 changes: 5 additions & 1 deletion control-plane/api/v1alpha1/ingressgateway_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ package v1alpha1
import (
"encoding/json"
"fmt"

"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/hashicorp/consul-k8s/control-plane/api/common"
Expand Down Expand Up @@ -77,6 +76,9 @@ type IngressServiceConfig struct {
// will be allowed at a single point in time. Use this to limit HTTP/2 traffic,
// since HTTP/2 has many requests per connection.
MaxConcurrentRequests *uint32 `json:"maxConcurrentRequests,omitempty"`
// PassiveHealthCheck configuration determines how upstream proxy instances will
// be monitored for removal from the load balancing pool.
PassiveHealthCheck *PassiveHealthCheck `json:"passiveHealthCheck,omitempty"`
}

type GatewayTLSConfig struct {
Expand Down Expand Up @@ -364,6 +366,7 @@ func (in IngressService) toConsul() capi.IngressService {
MaxConnections: in.MaxConnections,
MaxPendingRequests: in.MaxPendingRequests,
MaxConcurrentRequests: in.MaxConcurrentRequests,
PassiveHealthCheck: in.PassiveHealthCheck.toConsul(),
}
}

Expand Down Expand Up @@ -468,5 +471,6 @@ func (in *IngressServiceConfig) toConsul() *capi.IngressServiceConfig {
MaxConnections: in.MaxConnections,
MaxPendingRequests: in.MaxPendingRequests,
MaxConcurrentRequests: in.MaxConcurrentRequests,
PassiveHealthCheck: in.PassiveHealthCheck.toConsul(),
}
}
37 changes: 37 additions & 0 deletions control-plane/api/v1alpha1/ingressgateway_types_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"github.com/stretchr/testify/require"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/pointer"
)

func TestIngressGateway_MatchesConsul(t *testing.T) {
Expand Down Expand Up @@ -70,6 +71,17 @@ func TestIngressGateway_MatchesConsul(t *testing.T) {
MaxConnections: &defaultMaxConnections,
MaxPendingRequests: &defaultMaxPendingRequests,
MaxConcurrentRequests: &defaultMaxConcurrentRequests,
PassiveHealthCheck: &PassiveHealthCheck{
Interval: metav1.Duration{
Duration: 2 * time.Second,
},
MaxFailures: uint32(20),
EnforcingConsecutive5xx: pointer.Uint32(100),
MaxEjectionPercent: pointer.Uint32(10),
BaseEjectionTime: &metav1.Duration{
Duration: 10 * time.Second,
},
},
},
Listeners: []IngressListener{
{
Expand Down Expand Up @@ -170,6 +182,13 @@ func TestIngressGateway_MatchesConsul(t *testing.T) {
MaxConnections: &defaultMaxConnections,
MaxPendingRequests: &defaultMaxPendingRequests,
MaxConcurrentRequests: &defaultMaxConcurrentRequests,
PassiveHealthCheck: &capi.PassiveHealthCheck{
Interval: 2 * time.Second,
MaxFailures: uint32(20),
EnforcingConsecutive5xx: pointer.Uint32(100),
MaxEjectionPercent: pointer.Uint32(10),
BaseEjectionTime: pointer.Duration(10 * time.Second),
},
},
Listeners: []capi.IngressListener{
{
Expand Down Expand Up @@ -332,6 +351,17 @@ func TestIngressGateway_ToConsul(t *testing.T) {
MaxConnections: &defaultMaxConnections,
MaxPendingRequests: &defaultMaxPendingRequests,
MaxConcurrentRequests: &defaultMaxConcurrentRequests,
PassiveHealthCheck: &PassiveHealthCheck{
Interval: metav1.Duration{
Duration: 2 * time.Second,
},
MaxFailures: uint32(20),
EnforcingConsecutive5xx: pointer.Uint32(100),
MaxEjectionPercent: pointer.Uint32(10),
BaseEjectionTime: &metav1.Duration{
Duration: 10 * time.Second,
},
},
},
Listeners: []IngressListener{
{
Expand Down Expand Up @@ -431,6 +461,13 @@ func TestIngressGateway_ToConsul(t *testing.T) {
MaxConnections: &defaultMaxConnections,
MaxPendingRequests: &defaultMaxPendingRequests,
MaxConcurrentRequests: &defaultMaxConcurrentRequests,
PassiveHealthCheck: &capi.PassiveHealthCheck{
Interval: 2 * time.Second,
MaxFailures: uint32(20),
EnforcingConsecutive5xx: pointer.Uint32(100),
MaxEjectionPercent: pointer.Uint32(10),
BaseEjectionTime: pointer.Duration(10 * time.Second),
},
},
Listeners: []capi.IngressListener{
{
Expand Down
Loading