Add support for field TransparentProxy to SvcDefaults and ProxyDefaults #485

thisisnotashwin · 2021-04-14T21:04:48Z

Changes proposed in this PR:

Add support for the new Transparent Proxy field on ServiceDefaults and ProxyDefaults. Something to note here is that currently, the state/config_entry.go always sets a zero value for the field if it is set to a nil value when it gets returned from Consul. Hence a lot of text fixtures needed to be updated to ensure that they explicitly expect the TransparentProxy to be set. Additionally, if the incoming CRD does not have the value set, we explicitly set the value to its zero value so that MatchesConsul returns true.
This will be fixed in Consul before the next beta release potentially and parts of the fixture can be reverted.
Update the webhook versions from v1beta1 to v1 and v1beta1 support is deprecated in Kubernetes 1.16+

How I've tested this PR: Added some test. Successful acceptance test when the CRDs were updated in helm.

How I expect reviewers to test this PR: Code Review.

Checklist:

Tests added
CHANGELOG entry added (HashiCorp engineers only, community PRs should not add a changelog entry)

…th checks (#472) remove health checks controller and use endpoints controller for health checks.

- Update the spec of ServiceDefaults and ProxyDefaults to support transparent proxy changes that are introduced as a part of Consul 1.10

lkysow · 2021-04-21T15:44:45Z

api/v1alpha1/proxydefaults_types_test.go

+				TransparentProxy: &capi.TransparentProxyConfig{
+					OutboundListenerPort: 0,
+				},


This is the zero field issue?

lkysow · 2021-04-21T15:47:55Z

api/v1alpha1/servicedefaults_types.go

-	// Valid values are "http" and "http2", defaults to "http".
-	Protocol string `json:"protocol,omitempty"`
+	// TransparentProxy controls configuration specific to proxies in transparent mode.
+	TransparentProxy *TransparentProxyConfig `json:"transparentProxy,omitempty"`


nit: looks like our other config entries don't suffix Config for the helper structs so maybe we can just use TransparentProxy and swap MeshGatewayConfig to MeshGateway

Updated ExposeConfig to Expose as well!!

lkysow · 2021-04-21T15:50:04Z

api/v1alpha1/types.go

@@ -30,6 +30,37 @@ const (
 	MeshGatewayModeRemote MeshGatewayMode = "remote"
 )

+// ExposeConfig describes HTTP paths to expose through Envoy outside of Connect.


nit: looks like the MeshGateway stuff above here isn't used at all and can be deleted

lkysow · 2021-04-21T15:50:13Z

api/v1alpha1/types.go

@@ -39,8 +70,8 @@ type MeshGatewayConfig struct {
 }

 // toConsul returns the MeshGatewayConfig for the entry
-func (m MeshGatewayConfig) toConsul() capi.MeshGatewayConfig {
-	mode := capi.MeshGatewayMode(m.Mode)
+func (in MeshGatewayConfig) toConsul() capi.MeshGatewayConfig {


lkysow · 2021-04-21T15:50:24Z

api/v1alpha1/types.go

 	}
 	return nil
 }

+// toConsul returns the ExposeConfig for the entry


can kill these doc blocks, none of the other entries have them for toConsul

- Remove unused contstants for MeshGateway modes.

ndhanushkodi

Looks great Ashwin!! Just had some non-blocking questions!

ndhanushkodi · 2021-04-22T05:35:41Z

config/crd/bases/consul.hashicorp.com_proxydefaults.yaml

+                description: TransparentProxy controls configuration specific to proxies in transparent mode.
+                properties:
+                  outboundListenerPort:
+                    description: The port of the listener where outbound application traffic is being redirected to.


Do you think we should add something like "this would not typically be set via the CRD, but this field exists to match the config-entry", or is it not worth it with the validation error?

When a user does try to explicitly set this field, a validation error is returned from the webhook 😄
The error message returned by the webhook is: Invalid value: v1alpha1.TransparentProxy{OutboundListenerPort:}: use the annotation consul.hashicorp.com/transparent-proxy-outbound-listener-port to configure the Outbound Listener Port

Yeah I had noticed that, and that should be enough :)

ndhanushkodi · 2021-04-22T05:36:01Z

config/crd/bases/consul.hashicorp.com_servicedefaults.yaml

+                description: TransparentProxy controls configuration specific to proxies in transparent mode.
+                properties:
+                  outboundListenerPort:
+                    description: The port of the listener where outbound application traffic is being redirected to.


Same q as above :)

same answer as above ;)

ndhanushkodi · 2021-04-22T05:37:56Z

connect-inject/endpoints_controller_test.go

@@ -560,6 +560,7 @@ func TestReconcileCreateEndpoint(t *testing.T) {
 						DestinationServiceID:   "pod1-service-created",
 						LocalServiceAddress:    "",
 						LocalServicePort:       0,
+						TransparentProxy:       &api.TransparentProxyConfig{},


Are these necessary if empty?

Unfortunately, not in this case as it expects a pointer. An empty value would equate to a nil and not an empty field. this should be fixed in the future and we should be able to revert this change when Consul returns a nil value when provided a nil value.

Ah sweet, I wasn't sure if this fell under that case, thanks for the explanation!!

Base automatically changed from feature-tproxy to master April 14, 2021 23:03

thisisnotashwin force-pushed the cluster-resource branch 2 times, most recently from 654a3b2 to 92f8fe0 Compare April 16, 2021 13:13

remove health checks controller and use endpoints controller for heal…

9671d04

…th checks (#472) remove health checks controller and use endpoints controller for health checks.

thisisnotashwin force-pushed the cluster-resource branch 2 times, most recently from cd9bf12 to 71099b6 Compare April 19, 2021 16:07

thisisnotashwin closed this Apr 19, 2021

thisisnotashwin reopened this Apr 19, 2021

thisisnotashwin force-pushed the cluster-resource branch 8 times, most recently from 8bddde2 to 1bdf2ad Compare April 20, 2021 21:17

Update ProxyDefaults and ServiceDefaults with Transparent Proxy

52f4fb9

- Update the spec of ServiceDefaults and ProxyDefaults to support transparent proxy changes that are introduced as a part of Consul 1.10

thisisnotashwin force-pushed the cluster-resource branch from 1bdf2ad to 52f4fb9 Compare April 20, 2021 21:18

thisisnotashwin changed the title ~~Add Cluster config-entry~~ Add support for field TransparentProxy to SvcDefaults and ProxyDefaults Apr 20, 2021

thisisnotashwin requested review from lkysow, a team and ndhanushkodi and removed request for a team April 20, 2021 21:40

thisisnotashwin marked this pull request as ready for review April 20, 2021 21:40

thisisnotashwin added type/enhancement New feature or request theme/crds theme/tproxy Items related to transparent proxy labels Apr 20, 2021

lkysow approved these changes Apr 21, 2021

View reviewed changes

Ashwin Venkatesh added 2 commits April 21, 2021 12:09

Remove Config suffix from v1alpha1 structs

3bda16a

- Remove unused contstants for MeshGateway modes.

Error out from the webhook if TransparentProxy field is explicitly set.

aa29b42

ndhanushkodi approved these changes Apr 22, 2021

View reviewed changes

thisisnotashwin merged commit 2e98ec9 into master Apr 22, 2021

thisisnotashwin deleted the cluster-resource branch April 22, 2021 14:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for field TransparentProxy to SvcDefaults and ProxyDefaults #485

Add support for field TransparentProxy to SvcDefaults and ProxyDefaults #485

thisisnotashwin commented Apr 14, 2021 •

edited

Loading

lkysow Apr 21, 2021

thisisnotashwin Apr 21, 2021

lkysow Apr 21, 2021

thisisnotashwin Apr 21, 2021

lkysow Apr 21, 2021

lkysow Apr 21, 2021

lkysow Apr 21, 2021

ndhanushkodi left a comment

ndhanushkodi Apr 22, 2021

thisisnotashwin Apr 22, 2021

ndhanushkodi Apr 22, 2021

ndhanushkodi Apr 22, 2021

thisisnotashwin Apr 22, 2021

ndhanushkodi Apr 22, 2021

thisisnotashwin Apr 22, 2021

ndhanushkodi Apr 22, 2021

Add support for field TransparentProxy to SvcDefaults and ProxyDefaults #485

Add support for field TransparentProxy to SvcDefaults and ProxyDefaults #485

Conversation

thisisnotashwin commented Apr 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ndhanushkodi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thisisnotashwin commented Apr 14, 2021 •

edited

Loading