Merge pull request #512 from cloudfoundry/disable-tcp-router

ameowlia · web-flow · commit ed9ef715669d · 2025-09-04T12:53:57.000-04:00
add a flag to turn off tcp_router
diff --git a/jobs/tcp_router/monit b/jobs/tcp_router/monit
@@ -1,5 +1,7 @@
+<% unless p("tcp_router.disable") %>
 check process tcp_router
   with pidfile /var/vcap/sys/run/bpm/tcp_router/tcp_router.pid
   start program "/var/vcap/jobs/bpm/bin/bpm start tcp_router"
   stop program "/var/vcap/jobs/bpm/bin/bpm stop tcp_router"
   group vcap
+<% end %>
diff --git a/jobs/tcp_router/spec b/jobs/tcp_router/spec
@@ -3,7 +3,7 @@ name: tcp_router
 
 templates:
   tcp_router_ctl.erb: bin/tcp_router_ctl
-  haproxy_reloader: bin/haproxy_reloader
+  haproxy_reloader.erb: bin/haproxy_reloader
   bpm-pre-start.erb: bin/bpm-pre-start
   tcp_router.yml.erb: config/tcp_router.yml
   uaa_ca.crt.erb: config/certs/uaa/ca.crt
@@ -39,6 +39,9 @@ consumes:
     optional: true
 
 properties:
+  tcp_router.disable:
+    description: "Disable this monit job. It will not run."
+    default: false
   tcp_router.debug_address:
     description: "Address at which to serve debug info"
     default: "127.0.0.1:17002"
diff --git a/jobs/tcp_router/templates/bpm-pre-start.erb b/jobs/tcp_router/templates/bpm-pre-start.erb
@@ -1,4 +1,5 @@
 #!/bin/bash
+<% unless p("tcp_router.disable") %>
 
 set -eo pipefail
 
@@ -10,3 +11,4 @@ function copy_conf() {
 }
 
 copy_conf
+<% end %>
diff --git a/jobs/tcp_router/templates/bpm.yml.erb b/jobs/tcp_router/templates/bpm.yml.erb
@@ -24,5 +24,7 @@ bpm = {
   ]
 }
 
-YAML.dump(bpm)
+unless p("tcp_router.disable")
+  YAML.dump(bpm)
+end
 %>
diff --git a/jobs/tcp_router/templates/drain.erb b/jobs/tcp_router/templates/drain.erb
@@ -1,7 +1,7 @@
 #!/bin/bash
 # vim: set ft=sh
-
 set -e
+<% unless p("tcp_router.disable") %>
 
 pidfile=/var/vcap/sys/run/bpm/tcp_router/tcp_router.pid
 log_file=/var/vcap/sys/log/tcp_router/drain.log
@@ -33,3 +33,5 @@ else
   rm ${pidfile}
   echo 0
 fi
+
+<% end %>
diff --git a/jobs/tcp_router/templates/haproxy.conf.erb b/jobs/tcp_router/templates/haproxy.conf.erb
@@ -1,3 +1,4 @@
+<% unless p("tcp_router.disable") %>
 global
     log 127.0.0.1   syslog info
     daemon
@@ -28,3 +29,4 @@ listen health_check_https_url
     bind :<%= p("tcp_router.tls_health_check_port") %> ssl crt /var/vcap/jobs/tcp_router/config/certs/health.pem
     monitor-uri /health
     monitor fail if { env(IS_DRAINING) -m str true }
+<% end %>
diff --git a/jobs/tcp_router/templates/haproxy.conf.template.erb b/jobs/tcp_router/templates/haproxy.conf.template.erb
@@ -1,3 +1,4 @@
+<% unless p("tcp_router.disable") %>
 global
     log 127.0.0.1   syslog info
     daemon
@@ -28,3 +29,4 @@ listen health_check_https_url
     bind :<%= p("tcp_router.tls_health_check_port") %> ssl crt /var/vcap/jobs/tcp_router/config/certs/health.pem
     monitor-uri /health
     monitor fail if { env(IS_DRAINING) -m str true }
+<% end %>
diff --git a/jobs/tcp_router/templates/haproxy_reloader.erb b/jobs/tcp_router/templates/haproxy_reloader.erb
@@ -1,7 +1,7 @@
 #!/bin/bash
+<% unless p("tcp_router.disable") %>
 
 set -e
-
 # ignore the SIGUSR2 signal in case we were reconfiguring haproxy while a SIGUSR2 event came in,
 # we don't want to abort this process
 trap "echo Ignoring SIGUSR2" SIGUSR2
@@ -44,3 +44,4 @@ trap cleanup EXIT INT TERM
 "${DAEMON}" -f "${CONFIG}" -p "${HAPROXY_PID_FILE}" -x "${HAPROXY_SOCKET_FILE}" -D -sf "$(cat ${HAPROXY_PID_FILE})" 0<&- &>> "${LOGFILE}"
 
 echo "$(date --rfc-3339=ns) done" >> "${LOGFILE}"
+<% end %>
diff --git a/jobs/tcp_router/templates/post-start.erb b/jobs/tcp_router/templates/post-start.erb
@@ -1,5 +1,5 @@
 #!/bin/bash
-
+<% unless p("tcp_router.disable") %>
 LOG_DIR=/var/vcap/sys/log/tcp_router
 source /var/vcap/packages/routing_utils/syslog_utils.sh
 <% lb_delay = p("tcp_router.load_balancer_healthy_threshold") %>
@@ -9,3 +9,4 @@ tee_output_to_sys_log "${LOG_DIR}" "post-start"
 echo "Waiting <%= lb_delay %> seconds to allow load balancer to consider tcp_router healthy..."
 sleep <%= lb_delay %>
 echo "tcp_tcp_router is ready."
+<% end %>
diff --git a/jobs/tcp_router/templates/pre-start.erb b/jobs/tcp_router/templates/pre-start.erb
@@ -1,4 +1,6 @@
 #!/bin/bash -e
-
+<% unless p("tcp_router.disable") %>
 # This pre-start script runs (1) config validation and (2) creates frontend certs on the VM (if any)
 /var/vcap/packages/tcp_router/bin/config-validator -config /var/vcap/jobs/tcp_router/config/tcp_router.yml -enable-cert-creation true
+<% end %>
+
diff --git a/jobs/tcp_router/templates/routing_api_ca_certificate.crt.erb b/jobs/tcp_router/templates/routing_api_ca_certificate.crt.erb
@@ -10,5 +10,7 @@
     raise RuntimeError, 'Routing API server ca certificate not found in properties nor in routing_api Link. This value can be specified using the routing_api.ca_cert property.'
   end
 
-  server_ca_cert
+  unless p("tcp_router.disable")
+    server_ca_cert
+  end
 -%>
diff --git a/jobs/tcp_router/templates/routing_api_client_certificate.crt.erb b/jobs/tcp_router/templates/routing_api_client_certificate.crt.erb
@@ -10,5 +10,7 @@
     raise RuntimeError, 'Routing API client certificate not found in properties nor in routing_api Link. This value can be specified using the routing_api.client_cert property.'
   end
 
-  client_cert
+  unless p("tcp_router.disable")
+    client_cert
+  end
 -%>
diff --git a/jobs/tcp_router/templates/routing_api_client_private.key.erb b/jobs/tcp_router/templates/routing_api_client_private.key.erb
@@ -10,5 +10,7 @@
     raise RuntimeError, 'Routing API client private key not found in properties nor in routing_api Link. This value can be specified using the routing_api.client_private_key property.'
   end
 
-  client_private_key
+  unless p("tcp_router.disable")
+    client_private_key
+  end
 -%>
diff --git a/jobs/tcp_router/templates/tcp_router.yml.erb b/jobs/tcp_router/templates/tcp_router.yml.erb
@@ -1,3 +1,4 @@
+<% unless p("tcp_router.disable") %>
 <%
 
 def routing_api_port
@@ -104,3 +105,4 @@ frontend_tls:
     private_key: |
 <%= cert_pair['private_key'].to_s.lines.map { |line| "      #{line.rstrip}" }.join("\n") %>
 <% end -%>
+<% end %>
diff --git a/jobs/tcp_router/templates/tcp_router_backend_ca.crt.erb b/jobs/tcp_router/templates/tcp_router_backend_ca.crt.erb
@@ -1 +1,3 @@
+<% unless p("tcp_router.disable") %>
 <%= p('tcp_router.backend_tls.ca_cert', "") -%>
+<% end %>
diff --git a/jobs/tcp_router/templates/tcp_router_backend_client_cert_and_key.pem.erb b/jobs/tcp_router/templates/tcp_router_backend_client_cert_and_key.pem.erb
@@ -1,2 +1,4 @@
+<% unless p("tcp_router.disable") %>
 <%= p('tcp_router.backend_tls.client_cert', "") %>
 <%= p('tcp_router.backend_tls.client_key', "") -%>
+<% end %>
diff --git a/jobs/tcp_router/templates/tcp_router_ctl.erb b/jobs/tcp_router/templates/tcp_router_ctl.erb
@@ -1,7 +1,7 @@
 #!/bin/bash
+<% unless p("tcp_router.disable") %>
 
 set -eo pipefail
-
 CONF_DIR=/var/vcap/data/tcp_router/config
 HAPROXY_PID_FILE="${CONF_DIR}/haproxy.pid"
 PATH=/var/vcap/packages/haproxy/bin:$PATH
@@ -90,3 +90,5 @@ exec /var/vcap/packages/tcp_router/bin/cf-tcp-router\
 while kill -0 "$(cat ${HAPROXY_PID_FILE})"; do
   sleep 1
 done
+
+<% end %>
diff --git a/jobs/tcp_router/templates/tcp_router_health_check_certificate.pem.erb b/jobs/tcp_router/templates/tcp_router_health_check_certificate.pem.erb
@@ -1,6 +1,8 @@
+<% unless p("tcp_router.disable") %>
 <% if_p("tcp_router.tls_health_check_key") do |key| -%>
 <%= key %>
 <% end.else { raise RuntimeError, "Please set tcp_router.tls_health_check_key in the tcp_router's job properties." } -%>
 <% if_p("tcp_router.tls_health_check_cert") do |cert| -%>
 <%= cert %>
 <% end.else { raise RuntimeError, "Please set tcp_router.tls_health_check_cert in the tcp_router's job properties." } -%>
+<% end %>
diff --git a/spec/haproxy_config_spec.rb b/spec/haproxy_config_spec.rb
@@ -22,6 +22,29 @@
     }
   end
 
+  describe 'bin/haproxy_reloader' do
+    context "bin/haproxy_reloader" do
+
+      let(:template) { tcp_router_job.template("bin/haproxy_reloader") }
+
+      it 'contains information' do
+        rendered_template = template.render(properties)
+        expect(rendered_template).to include("starting haproxy_reloader")
+      end
+
+      describe 'when tcp_router is disabled' do
+        before do
+          properties['tcp_router']['disable'] = true
+        end
+
+        it 'is empty' do
+          rendered_template = template.render(properties)
+          expect(rendered_template).to_not include("starting haproxy_reloader")
+        end
+      end
+    end
+  end
+
   ['haproxy.conf', 'haproxy.conf.template'].each do |file|
     context "config/#{file}" do
       let(:template) { tcp_router_job.template("config/#{file}") }
@@ -83,6 +106,16 @@
           end
         end
       end
+
+      context 'when tcp_router is disabled' do
+          before do
+            properties['tcp_router']['disable'] = true
+          end
+
+          it 'is empty' do
+            expect(template.render(properties).strip.chomp).to eq("")
+          end
+      end
     end
   end
 end
diff --git a/spec/tcp_router_templates_spec.rb b/spec/tcp_router_templates_spec.rb

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#!/bin/bash`
	`2`	`+<% unless p("tcp_router.disable") %>`
`2`	`3`
`3`	`4`	`set -eo pipefail`
`4`	`5`
`@@ -10,3 +11,4 @@ function copy_conf() {`
`10`	`11`	`}`
`11`	`12`
`12`	`13`	`copy_conf`
	`14`	`+<% end %>`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,7 @@ bpm = {`
`24`	`24`	`]`
`25`	`25`	`}`
`26`	`26`
`27`		`-YAML.dump(bpm)`
	`27`	`+unless p("tcp_router.disable")`
	`28`	`+ YAML.dump(bpm)`
	`29`	`+end`
`28`	`30`	`%>`