Add documentation to inform users that Transparent Proxy and Mesh should

not be set via the CRD

api/v1alpha1/proxydefaults_types.go

@@ -63,6 +63,8 @@ type ProxyDefaultsSpec struct {
 	// Expose controls the default expose path configuration for Envoy.
 	Expose Expose `json:"expose,omitempty"`
 	// TransparentProxy controls configuration specific to proxies in transparent mode.
+	// Note: This cannot be set using the CRD and should be set using annotations on the
+	// services that are part of the mesh.
 	TransparentProxy *TransparentProxy `json:"transparentProxy,omitempty"`
 }
 

api/v1alpha1/servicedefaults_types.go

@@ -58,12 +58,16 @@ type ServiceDefaultsSpec struct {
 	// to be changed to a non-connect value when federating with an external system.
 	ExternalSNI string `json:"externalSNI,omitempty"`
 	// TransparentProxy controls configuration specific to proxies in transparent mode.
+	// Note: This cannot be set using the CRD and should be set using annotations on the
+	// services that are part of the mesh.
 	TransparentProxy *TransparentProxy `json:"transparentProxy,omitempty"`
-	// Mode can be one of direct or transparent. transparent represents that inbound and outbound
-	// and outbound application traffic is being captured and redirected through the proxy. This
-	// mode does not enable the traffic redirection itself. Instead it signals Consul to configure
-	// Envoy as if traffic is already being redirected. direct represents that the proxy's
-	// listeners must be dialed directly by the local application and other proxies.
+	// Mode can be one of "direct" or "transparent". "transparent" represents that inbound and outbound
+	// application traffic is being captured and redirected through the proxy. This mode does not
+	// enable the traffic redirection itself. Instead it signals Consul to configure Envoy as if
+	// traffic is already being redirected. "direct" represents that the proxy's listeners must be
+	// dialed directly by the local application and other proxies.
+	// Note: This cannot be set using the CRD and should be set using annotations on the
+	// services that are part of the mesh.
 	Mode *ProxyMode `json:"mode,omitempty"`
 	// UpstreamConfig controls default configuration settings that apply across all upstreams,
 	// and per-upstream configuration overrides. Note that per-upstream configuration applies

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

@@ -82,7 +82,7 @@ spec:
                     type: string
                 type: object
               transparentProxy:
-                description: TransparentProxy controls configuration specific to proxies in transparent mode.
+                description: 'TransparentProxy controls configuration specific to proxies in transparent mode. Note: This cannot be set using the CRD and should be set using annotations on the services that are part of the mesh.'
                 properties:
                   outboundListenerPort:
                     description: The port of the listener where outbound application traffic is being redirected to.

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

@@ -81,13 +81,13 @@ spec:
                     type: string
                 type: object
               mode:
-                description: Mode can be one of direct or transparent. transparent represents that inbound and outbound and outbound application traffic is being captured and redirected through the proxy. This mode does not enable the traffic redirection itself. Instead it signals Consul to configure Envoy as if traffic is already being redirected. direct represents that the proxy's listeners must be dialed directly by the local application and other proxies.
+                description: 'Mode can be one of "direct" or "transparent". "transparent" represents that inbound and outbound application traffic is being captured and redirected through the proxy. This mode does not enable the traffic redirection itself. Instead it signals Consul to configure Envoy as if traffic is already being redirected. "direct" represents that the proxy''s listeners must be dialed directly by the local application and other proxies. Note: This cannot be set using the CRD and should be set using annotations on the services that are part of the mesh.'
                 type: string
               protocol:
                 description: Protocol sets the protocol of the service. This is used by Connect proxies for things like observability features and to unlock usage of the service-splitter and service-router config entries for a service.
                 type: string
               transparentProxy:
-                description: TransparentProxy controls configuration specific to proxies in transparent mode.
+                description: 'TransparentProxy controls configuration specific to proxies in transparent mode. Note: This cannot be set using the CRD and should be set using annotations on the services that are part of the mesh.'
                 properties:
                   outboundListenerPort:
                     description: The port of the listener where outbound application traffic is being redirected to.