Net 6289 improve consul api gateway annotations #3437

sarahalsmiller · 2024-01-05T17:25:02Z

Changes proposed in this PR

Add annotations to the API Gateway that ensure

How I've tested this PR

Local unit tests
Local kind install

How I expect reviewers to test this PR

Local kind install
CI Passes

Checklist

[ X ] Tests added
CHANGELOG entry added

sarahalsmiller · 2024-01-05T17:25:07Z

References NET-6289-Improve-Consul-API-Gateway-annotations](#3171

nathancoleman

Thanks for pushing this across the finish line!

.changelog/3437.txt

cli/cmd/proxy/list/command.go

cli/cmd/proxy/list/command_test.go

jm96441n · 2024-01-08T21:12:40Z

cli/cmd/proxy/list/command.go

-
-		// Fallback to "Sidecar" as a default
-		if proxyType == "" {
+		default:


this is a nice clean up for this switch statement

t-eckert · 2024-01-16T19:23:04Z

cli/cmd/proxy/list/command.go

+	// TODO this block can be deleted if and when we decide we are ok with no longer listing pods of people using previous API Gateway
+	// versions.


It might be worth signing this with your GitHub id so people know who wrote it (without using Git blame).

t-eckert · 2024-01-16T19:25:17Z

cli/cmd/proxy/list/command.go

+	namespacedName := func(pod v1.Pod) string {
+		return pod.Namespace + pod.Name
+	}


Probably fine in this context, but this has the same name as a struct in Kubernetes that is structured somewhat differently. If you wanted to leverage this struct, it might be more "idiomatic". Because it has a string method itself, the behavior will be identical when used with formatting or with string().

https://github.com/kubernetes/apimachinery/blob/master/pkg/types/namespacedname.go

Again, not a blocker, just a little note.

t-eckert

This is such a great quality of life improvement!

cli/cmd/proxy/list/command.go

nathancoleman · 2024-01-16T21:16:20Z

control-plane/connect-inject/controllers/endpoints/endpoints_controller.go

 func isGateway(pod corev1.Pod) bool {
 	anno, ok := pod.Annotations[constants.AnnotationGatewayKind]
-	return ok && anno != ""
+	return ok && anno != "" && anno != apiGateway


Nice catch!

… act on gateway

…ateway pods

…eway This makes api-gateway behave the same as ingress, mesh and terminating gateways; however, it won't pick up pods created by the legacy consul-api-gateway controller.

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

* Add api-gateway to allow list for gateway-kind annotation * Update godoc for AnnotationGatewayKind to list correct allowable values * Exclude api-gateway kind when checking if endpoints controller should act on gateway * Add gateway-kind and gateway-consul-service-name annotations to API gateway pods * Add appropriate component label to api-gateway pods * Update consul-k8s CLI to rely on standard component label for api-gateway This makes api-gateway behave the same as ingress, mesh and terminating gateways; however, it won't pick up pods created by the legacy consul-api-gateway controller. * add backwards compatabiilty, additional tests * add changelog * Update .changelog/3437.txt Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> * Update cli/cmd/proxy/list/command.go Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> * Update cli/cmd/proxy/list/command_test.go Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> * Update cli/cmd/proxy/list/command_test.go Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> * Update cli/cmd/proxy/list/command.go Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> * cleanup * Update cli/cmd/proxy/list/command.go Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com> --------- Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

…ase/1.2.x (#3627) Net 6289 improve consul api gateway annotations (#3437) * Add api-gateway to allow list for gateway-kind annotation * Update godoc for AnnotationGatewayKind to list correct allowable values * Exclude api-gateway kind when checking if endpoints controller should act on gateway * Add gateway-kind and gateway-consul-service-name annotations to API gateway pods * Add appropriate component label to api-gateway pods * Update consul-k8s CLI to rely on standard component label for api-gateway This makes api-gateway behave the same as ingress, mesh and terminating gateways; however, it won't pick up pods created by the legacy consul-api-gateway controller. * add backwards compatabiilty, additional tests * add changelog * Update .changelog/3437.txt * Update cli/cmd/proxy/list/command.go * Update cli/cmd/proxy/list/command_test.go * Update cli/cmd/proxy/list/command_test.go * Update cli/cmd/proxy/list/command.go * cleanup * Update cli/cmd/proxy/list/command.go --------- Co-authored-by: sarahalsmiller <100602640+sarahalsmiller@users.noreply.github.com> Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

sarahalsmiller added the backport/1.3.x label Jan 5, 2024

sarahalsmiller marked this pull request as ready for review January 8, 2024 17:01

nathancoleman requested changes Jan 8, 2024

View reviewed changes

sarahalsmiller requested a review from nathancoleman January 8, 2024 17:52

sarahalsmiller force-pushed the NET-6289-Improve-Consul-API-Gateway-annotations branch from a767518 to 15d073b Compare January 8, 2024 17:52

jm96441n reviewed Jan 8, 2024

View reviewed changes

sarahalsmiller force-pushed the NET-6289-Improve-Consul-API-Gateway-annotations branch from cd77a71 to 4fc14d1 Compare January 11, 2024 19:09

t-eckert reviewed Jan 16, 2024

View reviewed changes

t-eckert approved these changes Jan 16, 2024

View reviewed changes

nathancoleman approved these changes Jan 16, 2024

View reviewed changes

nathancoleman and others added 14 commits January 16, 2024 15:30

Add api-gateway to allow list for gateway-kind annotation

0648657

Update godoc for AnnotationGatewayKind to list correct allowable values

d19290d

Exclude api-gateway kind when checking if endpoints controller should…

c2bed3e

… act on gateway

Add gateway-kind and gateway-consul-service-name annotations to API g…

98b2dd9

…ateway pods

Add appropriate component label to api-gateway pods

529f201

Update consul-k8s CLI to rely on standard component label for api-gat…

27a0f8b

…eway This makes api-gateway behave the same as ingress, mesh and terminating gateways; however, it won't pick up pods created by the legacy consul-api-gateway controller.

add backwards compatabiilty, additional tests

13dea3a

add changelog

4130d8d

Update .changelog/3437.txt

b8b567f

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

Update cli/cmd/proxy/list/command.go

5842d3e

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

Update cli/cmd/proxy/list/command_test.go

7921127

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

Update cli/cmd/proxy/list/command_test.go

2c0babc

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

Update cli/cmd/proxy/list/command.go

3768796

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

cleanup

67bef5a

sarahalsmiller force-pushed the NET-6289-Improve-Consul-API-Gateway-annotations branch from 4fc14d1 to 67bef5a Compare January 16, 2024 21:30

Update cli/cmd/proxy/list/command.go

650f49c

Co-authored-by: Nathan Coleman <nathan.coleman@hashicorp.com>

sarahalsmiller merged commit a5fe410 into main Jan 16, 2024
31 of 48 checks passed

sarahalsmiller deleted the NET-6289-Improve-Consul-API-Gateway-annotations branch January 16, 2024 22:16

hc-github-team-consul-core mentioned this pull request Jan 16, 2024

Backport of Net 6289 improve consul api gateway annotations into release/1.3.x #3479

Merged

1 task

nathancoleman mentioned this pull request Jan 29, 2024

NET-6289 Include standard gateway annotations on API gateway pods #3171

Closed

2 tasks

missylbytes added the backport/1.2.x This release branch is no longer active. label Feb 13, 2024

hc-github-team-consul-core mentioned this pull request Feb 13, 2024

Backport of Net 6289 improve consul api gateway annotations into release/1.2.x #3627

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Net 6289 improve consul api gateway annotations #3437

Net 6289 improve consul api gateway annotations #3437

sarahalsmiller commented Jan 5, 2024

sarahalsmiller commented Jan 5, 2024

nathancoleman left a comment

jm96441n Jan 8, 2024

t-eckert Jan 16, 2024

t-eckert Jan 16, 2024

t-eckert left a comment

nathancoleman Jan 16, 2024

		// TODO this block can be deleted if and when we decide we are ok with no longer listing pods of people using previous API Gateway
		// versions.

Net 6289 improve consul api gateway annotations #3437

Net 6289 improve consul api gateway annotations #3437

Conversation

sarahalsmiller commented Jan 5, 2024

Changes proposed in this PR

How I've tested this PR

How I expect reviewers to test this PR

Checklist

sarahalsmiller commented Jan 5, 2024

nathancoleman left a comment

Choose a reason for hiding this comment

jm96441n Jan 8, 2024

Choose a reason for hiding this comment

t-eckert Jan 16, 2024

Choose a reason for hiding this comment

t-eckert Jan 16, 2024

Choose a reason for hiding this comment

t-eckert left a comment

Choose a reason for hiding this comment

nathancoleman Jan 16, 2024

Choose a reason for hiding this comment