chore: remove gobgp-grpc-server-enabled feature flag

Remove the gobgp-grpc-server-enabled feature flag and its companion
gobgp-grpc-port configuration. The embedded GoBGP gRPC API server was
never enabled in production and is not used by the controller-runtime
reconciler, which communicates via the in-process BgpServer Go object.

- Remove viper defaults, env var bindings, and CLI flags for both
  --gobgp-grpc-server-enabled and --gobgp-grpc-port
- Remove port validation and conditional gRPC listen address logic
  from validateConfig and runCmd
- Simplify NewRuntimeFactory to accept only listenPort and localAddress
- Remove GRPCListenAddress from server.Config and its buildServerOptions
  conditional
- Remove defaultGrpcPort constant from main.go
- Remove 8 grpc-related tests and update remaining tests to drop
  GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED env var references
- Remove both flags from configuration.md docs and CLI example
- The gRPC health check server (--grpc-health-port) is unaffected

Author: privateip

cmd/galactic-router/main.go

@@ -28,8 +28,6 @@ const (
 	resourceBGPVRFInstances   = "bgpvrfinstances"
 	resourceSecrets           = "secrets"
 	resourceNodes             = "nodes"
-
-	defaultGrpcPort = 50051
 )
 
 func main() {

cmd/galactic-router/root.go

@@ -47,8 +47,6 @@ const (
 func newViper() *viper.Viper {
 	v := viper.New()
 	v.SetDefault("galactic_router.bgp_listen_port", 179)
-	v.SetDefault("galactic_router.gobgp_grpc_port", defaultGrpcPort)
-	v.SetDefault("galactic_router.gobgp_grpc_server_enabled", false)
 	v.SetDefault("galactic_router.metrics_port", 8080)
 	v.SetDefault("galactic_router.grpc_health_port", 5000)
 	v.SetDefault("galactic_router.gc_namespace", "default")
@@ -68,10 +66,6 @@ func newViper() *viper.Viper {
 	//nolint:errcheck
 	v.BindEnv("galactic_router.bgp_local_address", "GALACTIC_ROUTER_BGP_LOCAL_ADDRESS")
 	//nolint:errcheck
-	v.BindEnv("galactic_router.gobgp_grpc_server_enabled", "GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED")
-	//nolint:errcheck
-	v.BindEnv("galactic_router.gobgp_grpc_port", "GALACTIC_ROUTER_GOBGP_GRPC_PORT")
-	//nolint:errcheck
 	v.BindEnv("galactic_router.metrics_port", "GALACTIC_ROUTER_METRICS_PORT")
 	//nolint:errcheck
 	v.BindEnv("galactic_router.grpc_health_port", "GALACTIC_ROUTER_GRPC_HEALTH_PORT")
@@ -99,12 +93,6 @@ func bindFlags(cmd *cobra.Command, v *viper.Viper) { //nolint:lll // cobra flag
 	cmd.Flags().StringP("bgp-local-address", "",
 		v.GetString("galactic_router.bgp_local_address"),
 		"Source address for outgoing BGP TCP connections")
-	cmd.Flags().BoolP("gobgp-grpc-server-enabled", "",
-		v.GetBool("galactic_router.gobgp_grpc_server_enabled"),
-		"Enable the embedded GoBGP gRPC API server")
-	cmd.Flags().IntP("gobgp-grpc-port", "",
-		v.GetInt("galactic_router.gobgp_grpc_port"),
-		"Port for the GoBGP gRPC API server")
 	cmd.Flags().IntP("metrics-port", "",
 		v.GetInt("galactic_router.metrics_port"),
 		"Port for the controller-runtime metrics server")
@@ -128,7 +116,6 @@ func validateConfig(v *viper.Viper) error {
 	nodeName := v.GetString("galactic_router.node_name")
 	routerRole := v.GetString("galactic_router.router_role")
 	bgpListenPort := v.GetInt("galactic_router.bgp_listen_port")
-	grpcPort := v.GetInt("galactic_router.gobgp_grpc_port")
 	metricsPort := v.GetInt("galactic_router.metrics_port")
 	grpcHealthPort := v.GetInt("galactic_router.grpc_health_port")
 
@@ -144,9 +131,6 @@ func validateConfig(v *viper.Viper) error {
 	if bgpListenPort < -1 || bgpListenPort > 65535 {
 		return fmt.Errorf("GALACTIC_ROUTER_BGP_LISTEN_PORT must be -1 or a valid port number, got %d", bgpListenPort)
 	}
-	if grpcPort < 1 || grpcPort > 65535 {
-		return fmt.Errorf("GALACTIC_ROUTER_GOBGP_GRPC_PORT must be a valid port number (1-65535), got %d", grpcPort)
-	}
 	if metricsPort < 1 || metricsPort > 65535 {
 		return fmt.Errorf("GALACTIC_ROUTER_METRICS_PORT must be a valid port number (1-65535), got %d", metricsPort)
 	}
@@ -167,21 +151,13 @@ func runCmd(v *viper.Viper) error {
 	routerRole := v.GetString("galactic_router.router_role")
 	bgpListenPort := v.GetInt("galactic_router.bgp_listen_port")
 	bgpLocalAddr := v.GetString("galactic_router.bgp_local_address")
-	grpcEnabled := v.GetBool("galactic_router.gobgp_grpc_server_enabled")
-	grpcPort := v.GetInt("galactic_router.gobgp_grpc_port")
 	metricsPort := v.GetInt("galactic_router.metrics_port")
 	grpcHealthPort := v.GetInt("galactic_router.grpc_health_port")
 
-	// Construct gRPC listen address.
-	var grpcListenAddress string
-	if grpcEnabled {
-		grpcListenAddress = fmt.Sprintf(":%d", grpcPort)
-	}
-
 	var factory galacticruntime.RuntimeFactory
 	switch routerRole {
 	case "tenant":
-		factory = gobgp.NewRuntimeFactory(int32(bgpListenPort), bgpLocalAddr, grpcListenAddress)
+		factory = gobgp.NewRuntimeFactory(int32(bgpListenPort), bgpLocalAddr)
 	case roleFabric:
 		factory = frr.NewRuntimeFactory()
 	}

cmd/galactic-router/root_test.go

@@ -32,12 +32,6 @@ func TestFlagDefaults(t *testing.T) {
 	if v.GetInt("galactic_router.bgp_listen_port") != 179 {
 		t.Errorf("bgp_listen_port default = %d, want 179", v.GetInt("galactic_router.bgp_listen_port"))
 	}
-	if v.GetInt("galactic_router.gobgp_grpc_port") != defaultGrpcPort {
-		t.Errorf("gobgp_grpc_port default = %d, want %d", v.GetInt("galactic_router.gobgp_grpc_port"), defaultGrpcPort)
-	}
-	if v.GetBool("galactic_router.gobgp_grpc_server_enabled") != false {
-		t.Errorf("gobgp_grpc_server_enabled default = %v, want false", v.GetBool("galactic_router.gobgp_grpc_server_enabled"))
-	}
 	if v.GetInt("galactic_router.metrics_port") != 8080 {
 		t.Errorf("metrics_port default = %d, want 8080", v.GetInt("galactic_router.metrics_port"))
 	}
@@ -57,53 +51,13 @@ func TestRequiredFlags(t *testing.T) {
 func TestEnvVarDefaults(t *testing.T) {
 	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
 	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "false")
 
 	v := cmdWithViper(t)
 	if err := validateConfig(v); err != nil {
 		t.Errorf("validateConfig with valid env vars: %v", err)
 	}
 }
 
-func TestGRPCPortEnvVar(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
-	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "true")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "9999")
-
-	v := cmdWithViper(t)
-	if err := validateConfig(v); err != nil {
-		t.Errorf("validateConfig with GALACTIC_ROUTER_GOBGP_GRPC_PORT=9999: %v", err)
-	}
-}
-
-func TestFlagOverridesEnv(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "9999")
-
-	v := cmdWithViper(t)
-	// Simulate a flag override by setting the viper key directly (v.Set
-	// has higher precedence than env vars in viper).
-	v.Set("galactic_router.gobgp_grpc_port", 12345)
-	if got := v.GetInt("galactic_router.gobgp_grpc_port"); got != 12345 {
-		t.Errorf("flag override: got %d, want 12345", got)
-	}
-}
-
-func TestEnvVarOnly(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "env-node")
-	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "true")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "7777")
-
-	v := cmdWithViper(t)
-	if v.GetString("galactic_router.node_name") != "env-node" {
-		t.Errorf("node_name from env = %q, want %q", v.GetString("galactic_router.node_name"), "env-node")
-	}
-	if v.GetInt("galactic_router.gobgp_grpc_port") != 7777 {
-		t.Errorf("gobgp_grpc_port from env = %d, want 7777", v.GetInt("galactic_router.gobgp_grpc_port"))
-	}
-}
-
 func TestInvalidRouterRole(t *testing.T) {
 	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
 	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "invalid")
@@ -115,32 +69,6 @@ func TestInvalidRouterRole(t *testing.T) {
 	}
 }
 
-func TestGRPCPortOverflow(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
-	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "true")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "70000")
-
-	v := cmdWithViper(t)
-	err := validateConfig(v)
-	if err == nil {
-		t.Error("validateConfig with port 70000 returned nil error")
-	}
-}
-
-func TestGRPCPortZero(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
-	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "true")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "0")
-
-	v := cmdWithViper(t)
-	err := validateConfig(v)
-	if err == nil {
-		t.Error("validateConfig with port 0 returned nil error")
-	}
-}
-
 func TestBGPListenPortMinusOne(t *testing.T) {
 	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
 	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
@@ -188,7 +116,6 @@ func TestValidRoles(t *testing.T) {
 		t.Run(role, func(t *testing.T) {
 			t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
 			t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", role)
-			t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "false")
 
 			v := cmdWithViper(t)
 			// Verify the role is read correctly.
@@ -225,33 +152,6 @@ func TestGRPCHealthPortOverride(t *testing.T) {
 	}
 }
 
-func TestGRPCServerEnabled(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
-	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "true")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "50051")
-
-	v := cmdWithViper(t)
-	if !v.GetBool("galactic_router.gobgp_grpc_server_enabled") {
-		t.Error("gobgp_grpc_server_enabled should be true")
-	}
-	if v.GetInt("galactic_router.gobgp_grpc_port") != 50051 {
-		t.Errorf("gobgp_grpc_port = %d, want 50051", v.GetInt("galactic_router.gobgp_grpc_port"))
-	}
-}
-
-func TestGRPCServerDisabled(t *testing.T) {
-	t.Setenv("GALACTIC_ROUTER_NODE_NAME", "test-node")
-	t.Setenv("GALACTIC_ROUTER_ROUTER_ROLE", "tenant")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED", "false")
-	t.Setenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT", "9999")
-
-	v := cmdWithViper(t)
-	if v.GetBool("galactic_router.gobgp_grpc_server_enabled") {
-		t.Error("gobgp_grpc_server_enabled should be false")
-	}
-}
-
 func TestVersionFlag(t *testing.T) {
 	if metadata.Version == "" {
 		t.Error("metadata.Version should not be empty")
@@ -264,8 +164,6 @@ func TestDefaults(t *testing.T) {
 	_ = os.Unsetenv("GALACTIC_ROUTER_ROUTER_ROLE")
 	_ = os.Unsetenv("GALACTIC_ROUTER_BGP_LISTEN_PORT")
 	_ = os.Unsetenv("GALACTIC_ROUTER_BGP_LOCAL_ADDRESS")
-	_ = os.Unsetenv("GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED")
-	_ = os.Unsetenv("GALACTIC_ROUTER_GOBGP_GRPC_PORT")
 	_ = os.Unsetenv("GALACTIC_ROUTER_METRICS_PORT")
 	_ = os.Unsetenv("GALACTIC_ROUTER_GRPC_HEALTH_PORT")
 
@@ -274,12 +172,6 @@ func TestDefaults(t *testing.T) {
 	if v.GetInt("galactic_router.bgp_listen_port") != 179 {
 		t.Errorf("bgp_listen_port = %d, want 179", v.GetInt("galactic_router.bgp_listen_port"))
 	}
-	if v.GetInt("galactic_router.gobgp_grpc_port") != defaultGrpcPort {
-		t.Errorf("gobgp_grpc_port = %d, want %d", v.GetInt("galactic_router.gobgp_grpc_port"), defaultGrpcPort)
-	}
-	if v.GetBool("galactic_router.gobgp_grpc_server_enabled") != false {
-		t.Error("gobgp_grpc_server_enabled default should be false")
-	}
 	if v.GetInt("galactic_router.metrics_port") != 8080 {
 		t.Errorf("metrics_port = %d, want 8080", v.GetInt("galactic_router.metrics_port"))
 	}

docs/router/configuration.md

@@ -11,8 +11,6 @@ or a combination of both. CLI flags take precedence over environment variables.
 | Router role | `GALACTIC_ROUTER_ROUTER_ROLE` | `--router-role` | _(required)_ |
 | BGP listen port | `GALACTIC_ROUTER_BGP_LISTEN_PORT` | `--bgp-listen-port` | `179` |
 | BGP local address | `GALACTIC_ROUTER_BGP_LOCAL_ADDRESS` | `--bgp-local-address` | `""` |
-| GoBGP gRPC server | `GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED` | `--gobgp-grpc-server-enabled` | `false` |
-| GoBGP gRPC port | `GALACTIC_ROUTER_GOBGP_GRPC_PORT` | `--gobgp-grpc-port` | `50051` |
 | Metrics port | `GALACTIC_ROUTER_METRICS_PORT` | `--metrics-port` | `8080` |
 | gRPC health port | `GALACTIC_ROUTER_GRPC_HEALTH_PORT` | `--grpc-health-port` | `5000` |
 
@@ -62,23 +60,6 @@ selects the default source address.
 **Type:** string
 **Default:** `""` (empty)
 
-### `--gobgp-grpc-server-enabled` / `GALACTIC_ROUTER_GOBGP_GRPC_SERVER_ENABLED`
-
-Enable the embedded GoBGP gRPC API server. When enabled, the gRPC server
-listens on the port specified by `--gobgp-grpc-port`.
-
-**Type:** boolean
-**Default:** `false`
-
-### `--gobgp-grpc-port` / `GALACTIC_ROUTER_GOBGP_GRPC_PORT`
-
-TCP port for the GoBGP gRPC API server. Only used when
-`--gobgp-grpc-server-enabled` is `true`.
-
-**Type:** integer
-**Default:** `50051`
-**Valid values:** `1`–`65535`
-
 ### `--metrics-port` / `GALACTIC_ROUTER_METRICS_PORT`
 
 TCP port for the controller-runtime metrics HTTP server. Exposes Prometheus
@@ -130,8 +111,6 @@ args:
   - --node-name=$(GALACTIC_ROUTER_NODE_NAME)
   - --router-role=tenant
   - --metrics-port=9090
-  - --gobgp-grpc-server-enabled=true
-  - --gobgp-grpc-port=50051
 env:
   - name: GALACTIC_ROUTER_NODE_NAME
     valueFrom:

internal/runtime/gobgp/runtime.go

@@ -53,11 +53,11 @@ type GoBGPRuntime struct {
 // Pass -1 to disable inbound connections (outbound-only mode).
 // localAddress, if non-empty, is bound as the source address for outgoing BGP
 // TCP connections (sets Transport.LocalAddress on every peer).
-func NewRuntimeFactory(listenPort int32, localAddress string, grpcListenAddress string) runtime.RuntimeFactory {
+func NewRuntimeFactory(listenPort int32, localAddress string) runtime.RuntimeFactory {
 	return func(key types.NamespacedName) (runtime.RouterRuntime, error) {
 		return &GoBGPRuntime{
 			key:             key,
-			server:          newServer(Config{GRPCListenAddress: grpcListenAddress}),
+			server:          newServer(Config{}),
 			listenPort:      listenPort,
 			localAddress:    localAddress,
 			establishedAt:   make(map[string]time.Time),

internal/runtime/gobgp/server.go

@@ -23,9 +23,6 @@ type Config struct {
 	// LogLevel controls GoBGP's internal log verbosity.
 	// Valid values: debug, info, warn, error, panic. Defaults to panic.
 	LogLevel string
-	// GRPCListenAddress is the TCP address the GoBGP gRPC API listens on.
-	// An empty string (default) disables the gRPC server entirely.
-	GRPCListenAddress string
 }
 
 // Server wraps an embedded GoBGP BgpServer.
@@ -89,9 +86,6 @@ func (s *Server) buildServerOptions() []gobgpserver.ServerOption {
 	levelVar.Set(level)
 	logger := slog.New(slog.NewTextHandler(io.Discard, &slog.HandlerOptions{Level: levelVar}))
 	opts := []gobgpserver.ServerOption{gobgpserver.LoggerOption(logger, levelVar)}
-	if s.cfg.GRPCListenAddress != "" {
-		opts = append(opts, gobgpserver.GrpcListenAddress(s.cfg.GRPCListenAddress))
-	}
 	return opts
 }