fix: add kong config with nginx_worker_processes option (#1271)

* Add Kong nginx_worker_processes option

* fix: set default worker processes to 1

---------

Co-authored-by: Qiao Han <qiao@supabase.io>

Author: Wakeful-Cloud

internal/start/start.go

@@ -268,6 +268,22 @@ EOF
 	// Start Kong.
 	p.Send(utils.StatusMsg("Starting containers..."))
 	if !isContainerExcluded(utils.KongImage, excluded) {
+		env := []string{
+			"KONG_DATABASE=off",
+			"KONG_DECLARATIVE_CONFIG=/home/kong/kong.yml",
+			"KONG_DNS_ORDER=LAST,A,CNAME", // https://github.com/supabase/cli/issues/14
+			"KONG_PLUGINS=request-transformer,cors",
+			// Need to increase the nginx buffers in kong to avoid it rejecting the rather
+			// sizeable response headers azure can generate
+			// Ref: https://github.com/Kong/kong/issues/3974#issuecomment-482105126
+			"KONG_NGINX_PROXY_PROXY_BUFFER_SIZE=160k",
+			"KONG_NGINX_PROXY_PROXY_BUFFERS=64 160k",
+		}
+
+		if utils.Config.Kong.NginxWorkerProcesses != 0 {
+			env = append(env, fmt.Sprintf("KONG_NGINX_WORKER_PROCESSES=%d", utils.Config.Kong.NginxWorkerProcesses))
+		}
+
 		var kongConfigBuf bytes.Buffer
 
 		if err := kongConfigTemplate.Execute(&kongConfigBuf, kongConfig{
@@ -287,17 +303,7 @@ EOF
 			ctx,
 			container.Config{
 				Image: utils.KongImage,
-				Env: []string{
-					"KONG_DATABASE=off",
-					"KONG_DECLARATIVE_CONFIG=/home/kong/kong.yml",
-					"KONG_DNS_ORDER=LAST,A,CNAME", // https://github.com/supabase/cli/issues/14
-					"KONG_PLUGINS=request-transformer,cors",
-					// Need to increase the nginx buffers in kong to avoid it rejecting the rather
-					// sizeable response headers azure can generate
-					// Ref: https://github.com/Kong/kong/issues/3974#issuecomment-482105126
-					"KONG_NGINX_PROXY_PROXY_BUFFER_SIZE=160k",
-					"KONG_NGINX_PROXY_PROXY_BUFFERS=64 160k",
-				},
+				Env:   env,
 				Entrypoint: []string{"sh", "-c", `cat <<'EOF' > /home/kong/kong.yml && ./docker-entrypoint.sh kong docker-start
 ` + kongConfigBuf.String() + `
 EOF

internal/utils/config.go

@@ -89,6 +89,7 @@ type (
 		Api       api                 `toml:"api"`
 		Db        db                  `toml:"db" mapstructure:"db"`
 		Studio    studio              `toml:"studio"`
+		Kong      kong                `toml:"kong"`
 		Inbucket  inbucket            `toml:"inbucket"`
 		Storage   storage             `toml:"storage"`
 		Auth      auth                `toml:"auth" mapstructure:"auth"`
@@ -116,6 +117,10 @@ type (
 		Port uint `toml:"port"`
 	}
 
+	kong struct {
+		NginxWorkerProcesses uint `toml:"nginx_worker_processes"`
+	}
+
 	inbucket struct {
 		Port     uint `toml:"port"`
 		SmtpPort uint `toml:"smtp_port"`

internal/utils/templates/init_config.test.toml

@@ -25,6 +25,11 @@ major_version = 15
 # Port to use for Supabase Studio.
 port = 54323
 
+[kong]
+# Number of nginx workers for handling requests. Set this to 1 to minimize memory usage.
+# Omitting it or setting it to 0 will autodetect based on the number of CPU cores.
+nginx_worker_processes = 1
+
 # Email testing server. Emails sent with the local dev setup are not actually sent - rather, they
 # are monitored, and you can view the emails that would have been sent from the web interface.
 [inbucket]

internal/utils/templates/init_config.toml

@@ -25,6 +25,11 @@ major_version = 15
 # Port to use for Supabase Studio.
 port = 54323
 
+[kong]
+# Number of nginx workers for handling requests. Set this to 1 to minimize memory usage.
+# Omitting it or setting it to 0 will autodetect based on the number of CPU cores.
+nginx_worker_processes = 1
+
 # Email testing server. Emails sent with the local dev setup are not actually sent - rather, they
 # are monitored, and you can view the emails that would have been sent from the web interface.
 [inbucket]