NET-6663 Set gateway-kind in Workload metadata when it represents a x…

…Gateway Pod (#3365)

Set gateway-kind in Workload metadata when it represents a xGateway Pod

By setting the gateway-kind annotation on the Pods for a MeshGateway, we indicate to the Pod controller in consul-k8s that the Pod represents a mesh gateway (or api/terminating in the future). The Pod controller then passes this along as metadata on the Workload that it creates in Consul.

The end result is that the sidecar and gateway proxy controllers can determine which Workloads they should generate ProxyStateTemplates for.

control-plane/connect-inject/constants/constants.go

@@ -27,6 +27,10 @@ const (
 	// ProxyDefaultHealthPort is the default HTTP health check port for the proxy.
 	ProxyDefaultHealthPort = 21000
 
+	// MetaGatewayKind is the meta key name for indicating which kind of gateway a Pod is for, if any.
+	// The value should be one of "mesh", "api", or "terminating".
+	MetaGatewayKind = "gateway-kind"
+
 	// MetaKeyManagedBy is the meta key name for indicating which Kubernetes controller manages a Consul resource.
 	MetaKeyManagedBy = "managed-by"
 

control-plane/connect-inject/controllers/pod/pod_controller.go

@@ -664,10 +664,16 @@ func parseLocality(node corev1.Node) *pbcatalog.Locality {
 
 func metaFromPod(pod corev1.Pod) map[string]string {
 	// TODO: allow custom workload metadata
-	return map[string]string{
+	meta := map[string]string{
 		constants.MetaKeyKubeNS:    pod.GetNamespace(),
 		constants.MetaKeyManagedBy: constants.ManagedByPodValue,
 	}
+
+	if gatewayKind := pod.Annotations[constants.AnnotationGatewayKind]; gatewayKind != "" {
+		meta[constants.MetaGatewayKind] = gatewayKind
+	}
+
+	return meta
 }
 
 // getHealthStatusFromPod checks the Pod for a "Ready" condition that is true.

control-plane/gateways/deployment.go

@@ -10,10 +10,12 @@ import (
 	"k8s.io/utils/pointer"
 
 	meshv2beta1 "github.com/hashicorp/consul-k8s/control-plane/api/mesh/v2beta1"
+	"github.com/hashicorp/consul-k8s/control-plane/connect-inject/constants"
 )
 
 const (
-	globalDefaultInstances int32 = 1
+	globalDefaultInstances    int32 = 1
+	meshGatewayAnnotationKind       = "mesh-gateway"
 )
 
 func (b *meshGatewayBuilder) Deployment() (*appsv1.Deployment, error) {
@@ -65,7 +67,8 @@ func (b *meshGatewayBuilder) deploymentSpec() (*appsv1.DeploymentSpec, error) {
 			ObjectMeta: metav1.ObjectMeta{
 				Labels: b.Labels(),
 				Annotations: map[string]string{
-					"consul.hashicorp.com/mesh-inject": "false",
+					constants.AnnotationMeshInject:  "false",
+					constants.AnnotationGatewayKind: meshGatewayAnnotationKind,
 				},
 			},
 			Spec: corev1.PodSpec{

control-plane/gateways/deployment_test.go

@@ -16,6 +16,7 @@ import (
 	pbmesh "github.com/hashicorp/consul/proto-public/pbmesh/v2beta1"
 
 	meshv2beta1 "github.com/hashicorp/consul-k8s/control-plane/api/mesh/v2beta1"
+	"github.com/hashicorp/consul-k8s/control-plane/connect-inject/constants"
 )
 
 func Test_meshGatewayBuilder_Deployment(t *testing.T) {
@@ -72,7 +73,8 @@ func Test_meshGatewayBuilder_Deployment(t *testing.T) {
 								"mesh.consul.hashicorp.com/managed-by": "consul-k8s",
 							},
 							Annotations: map[string]string{
-								"consul.hashicorp.com/mesh-inject": "false",
+								constants.AnnotationMeshInject:  "false",
+								constants.AnnotationGatewayKind: meshGatewayAnnotationKind,
 							},
 						},
 						Spec: corev1.PodSpec{
@@ -316,7 +318,8 @@ func Test_meshGatewayBuilder_Deployment(t *testing.T) {
 								"mesh.consul.hashicorp.com/managed-by": "consul-k8s",
 							},
 							Annotations: map[string]string{
-								"consul.hashicorp.com/mesh-inject": "false",
+								constants.AnnotationMeshInject:  "false",
+								constants.AnnotationGatewayKind: meshGatewayAnnotationKind,
 							},
 						},
 						Spec: corev1.PodSpec{