feat: Configure proxy pod to exit 0 on SIGTERM

GoogleCloudPlatform · Sep 14, 2023 · 46070ad · 46070ad
1 parent e4d0382
commit 46070ad
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 11 deletions.
diff --git a/internal/workload/podspec_updates.go b/internal/workload/podspec_updates.go
@@ -48,10 +48,6 @@ const (
 	// DefaultHealthCheckPort is the used by the proxy to expose prometheus
 	// and kubernetes health checks.
 	DefaultHealthCheckPort int32 = 9801
-
-	// DefaultAdminPort is the used by the proxy to expose prometheus
-	// and kubernetes health checks.
-	DefaultAdminPort int32 = 9802
 )
 
 var l = logf.Log.WithName("internal.workload")
@@ -815,6 +811,9 @@ func (s *updateState) addHealthCheck(p *cloudsqlapi.AuthProxyWorkload, c *corev1
 	s.addProxyContainerEnvVar(p, "CSQL_PROXY_HTTP_PORT", fmt.Sprintf("%d", port))
 	s.addProxyContainerEnvVar(p, "CSQL_PROXY_HTTP_ADDRESS", "0.0.0.0")
 	s.addProxyContainerEnvVar(p, "CSQL_PROXY_HEALTH_CHECK", "true")
+	// For graceful exits as a sidecar, the proxy should exit with exit code 0
+	// when it receives a SIGTERM.
+	s.addProxyContainerEnvVar(p, "CSQL_PROXY_EXIT_ZERO_ON_SIGTERM", "true")
 }
 
 func (s *updateState) addAdminServer(p *cloudsqlapi.AuthProxyWorkload) {

diff --git a/internal/workload/podspec_updates_test.go b/internal/workload/podspec_updates_test.go
@@ -535,11 +535,12 @@ func TestProxyCLIArgs(t *testing.T) {
 				}},
 			},
 			wantWorkloadEnv: map[string]string{
-				"CSQL_PROXY_STRUCTURED_LOGS": "true",
-				"CSQL_PROXY_HEALTH_CHECK":    "true",
-				"CSQL_PROXY_HTTP_PORT":       fmt.Sprintf("%d", workload.DefaultHealthCheckPort),
-				"CSQL_PROXY_HTTP_ADDRESS":    "0.0.0.0",
-				"CSQL_PROXY_USER_AGENT":      "cloud-sql-proxy-operator/dev",
+				"CSQL_PROXY_STRUCTURED_LOGS":      "true",
+				"CSQL_PROXY_HEALTH_CHECK":         "true",
+				"CSQL_PROXY_EXIT_ZERO_ON_SIGTERM": "true",
+				"CSQL_PROXY_HTTP_PORT":            fmt.Sprintf("%d", workload.DefaultHealthCheckPort),
+				"CSQL_PROXY_HTTP_ADDRESS":         "0.0.0.0",
+				"CSQL_PROXY_USER_AGENT":           "cloud-sql-proxy-operator/dev",
 			},
 		},
 		{
@@ -691,7 +692,6 @@ func TestProxyCLIArgs(t *testing.T) {
 			},
 		},
 		{
-			desc: "No admin port enabled when AdminServerSpec is nil",
 			proxySpec: cloudsqlapi.AuthProxyWorkloadSpec{
 				AuthProxyContainer: &cloudsqlapi.AuthProxyContainerSpec{},
 				Instances: []cloudsqlapi.InstanceSpec{{
@@ -705,7 +705,6 @@ func TestProxyCLIArgs(t *testing.T) {
 			wantWorkloadEnv: map[string]string{
 				"CSQL_PROXY_HEALTH_CHECK": "true",
 			},
-			dontWantEnvSet: []string{"CSQL_PROXY_DEBUG", "CSQL_PROXY_ADMIN_PORT"},
 		},
 		{
 			desc: "port conflict with other instance causes error",