Merge pull request #1143 from RakhithaRR/gateway-org

Author: CrowleyRajapakse

.github/workflows/operator-integration-test.yml

@@ -292,6 +292,9 @@ jobs:
                       # Graceful shutdown timeout
                       shutdown_timeout: 15s
 
+                      # Unique identifier for the gateway instance
+                      gateway_id: "platform-gateway-id"
+
                     # Policy xDS Server configuration
                     policy_server:
                       # Enable or disable the policy xDS server

gateway/configs/config-template.toml

@@ -9,6 +9,9 @@ api_port = 9090
 xds_port = 18000
 # Graceful shutdown timeout
 shutdown_timeout = "15s"
+# Unique identifier for the gateway instance (used in persistent storage)
+# It is recommended to use a uuid_v7 for this to improve db efficiency.
+gateway_id = "platform-gateway-id"
 
 [controller.admin_server]
 # Dedicated admin/debug HTTP server for config dump and xDS sync endpoints

gateway/configs/config.toml

@@ -13,6 +13,9 @@ gateway_host = "*"
 [router.access_logs]
 enabled = true
 
+[controller.server]
+gateway_id = "platform-gateway-id"
+
 [controller.auth.basic]
 enabled = true
 

gateway/gateway-controller/cmd/controller/main.go

@@ -61,6 +61,7 @@ func toBackendConfig(cfg *config.Config) storage.BackendConfig {
 			ConnMaxIdleTime: pg.ConnMaxIdleTime,
 			ApplicationName: pg.ApplicationName,
 		},
+		GatewayID: cfg.Controller.Server.GatewayID,
 	}
 }
 

gateway/gateway-controller/pkg/config/config.go

@@ -176,6 +176,7 @@ type ServerConfig struct {
 	APIPort         int           `koanf:"api_port"`
 	XDSPort         int           `koanf:"xds_port"`
 	ShutdownTimeout time.Duration `koanf:"shutdown_timeout"`
+	GatewayID       string        `koanf:"gateway_id"`
 }
 
 // AdminServerConfig holds controller admin HTTP server configuration.
@@ -457,6 +458,7 @@ func defaultConfig() *Config {
 				APIPort:         9090,
 				XDSPort:         18000,
 				ShutdownTimeout: 15 * time.Second,
+				GatewayID:       constants.PlatformGatewayId,
 			},
 			AdminServer: AdminServerConfig{
 				Enabled:    true,
@@ -810,6 +812,10 @@ func (c *Config) Validate() error {
 		return fmt.Errorf("server.xds_port must be between 1 and 65535, got: %d", c.Controller.Server.XDSPort)
 	}
 
+	if strings.TrimSpace(c.Controller.Server.GatewayID) == "" {
+		return fmt.Errorf("server.gateway_id is required and cannot be empty")
+	}
+
 	if c.Controller.AdminServer.Enabled {
 		if c.Controller.AdminServer.Port < 1 || c.Controller.AdminServer.Port > 65535 {
 			return fmt.Errorf("admin_server.port must be between 1 and 65535, got: %d", c.Controller.AdminServer.Port)

gateway/gateway-controller/pkg/config/config_test.go

@@ -33,8 +33,9 @@ func validConfig() *Config {
 	return &Config{
 		Controller: Controller{
 			Server: ServerConfig{
-				APIPort: 8080,
-				XDSPort: 18000,
+				APIPort:   8080,
+				XDSPort:   18000,
+				GatewayID: constants.PlatformGatewayId,
 			},
 			Storage: StorageConfig{
 				Type: "memory",

gateway/gateway-controller/pkg/constants/constants.go

@@ -19,6 +19,7 @@
 package constants
 
 const (
+	PlatformGatewayId = "platform-gateway-id"
 	// XDS/Envoy Constants
 	TransportSocketPrefix   = "ts"
 	LoadBalancerIDKey       = "lb_id"

gateway/gateway-controller/pkg/storage/factory.go

@@ -31,6 +31,7 @@ type BackendConfig struct {
 	Type       string
 	SQLitePath string
 	Postgres   PostgresConnectionConfig
+	GatewayID  string
 }
 
 // NewStorage creates the configured persistent storage backend.
@@ -45,7 +46,7 @@ func NewStorage(cfg BackendConfig, logger *slog.Logger) (Storage, error) {
 			return nil, err
 		}
 
-		store := newSQLStore(backend.db, backend.logger, "sqlite")
+		store := newSQLStore(backend.db, backend.logger, "sqlite", cfg.GatewayID)
 		store.rebindQuery = func(query string) string { return query }
 		store.isConfigUniqueViolation = isUniqueConstraintError
 		store.isCertificateUniqueViolation = isCertificateUniqueConstraintError
@@ -59,7 +60,7 @@ func NewStorage(cfg BackendConfig, logger *slog.Logger) (Storage, error) {
 			return nil, err
 		}
 
-		store := newSQLStore(backend.db, backend.logger, "postgres")
+		store := newSQLStore(backend.db, backend.logger, "postgres", cfg.GatewayID)
 		store.rebindQuery = func(query string) string { return sqlx.Rebind(sqlx.DOLLAR, query) }
 		store.isConfigUniqueViolation = isPostgresUniqueConstraintError
 		store.isCertificateUniqueViolation = isPostgresCertificateUniqueConstraintError

gateway/gateway-controller/pkg/storage/gateway-controller-db.postgres.sql

@@ -1,43 +1,48 @@
 -- PostgreSQL Schema for Gateway-Controller API Configurations
--- Version: 6
+-- Version: 8
 
 -- Main table for deployments
 CREATE TABLE IF NOT EXISTS deployments (
     id TEXT PRIMARY KEY,
+    gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id',
     display_name TEXT NOT NULL,
     version TEXT NOT NULL,
     context TEXT NOT NULL,
     kind TEXT NOT NULL,
-    handle TEXT NOT NULL UNIQUE,
+    handle TEXT NOT NULL,
     status TEXT NOT NULL CHECK(status IN ('pending', 'deployed', 'failed')),
     created_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
     updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
     deployed_at TIMESTAMPTZ,
     deployed_version BIGINT NOT NULL DEFAULT 0,
-    UNIQUE(display_name, version)
+    UNIQUE(display_name, version, gateway_id),
+    UNIQUE(handle, gateway_id)
 );
 
-CREATE INDEX IF NOT EXISTS idx_name_version ON deployments(display_name, version);
 CREATE INDEX IF NOT EXISTS idx_status ON deployments(status);
 CREATE INDEX IF NOT EXISTS idx_context ON deployments(context);
 CREATE INDEX IF NOT EXISTS idx_kind ON deployments(kind);
+CREATE INDEX IF NOT EXISTS idx_deployments_gateway_id ON deployments(gateway_id);
 
 -- Table for custom TLS certificates
 CREATE TABLE IF NOT EXISTS certificates (
     id TEXT PRIMARY KEY,
-    name TEXT NOT NULL UNIQUE,
+    gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id',
+    name TEXT NOT NULL,
     certificate BYTEA NOT NULL,
     subject TEXT NOT NULL,
     issuer TEXT NOT NULL,
     not_before TIMESTAMPTZ NOT NULL,
     not_after TIMESTAMPTZ NOT NULL,
     cert_count INTEGER NOT NULL DEFAULT 1,
     created_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP
+    updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    UNIQUE(name, gateway_id)
 );
 
 CREATE INDEX IF NOT EXISTS idx_cert_name ON certificates(name);
 CREATE INDEX IF NOT EXISTS idx_cert_expiry ON certificates(not_after);
+CREATE INDEX IF NOT EXISTS idx_certificates_gateway_id ON certificates(gateway_id);
 
 -- Table for deployment-specific configurations
 CREATE TABLE IF NOT EXISTS deployment_configs (
@@ -50,17 +55,21 @@ CREATE TABLE IF NOT EXISTS deployment_configs (
 -- LLM Provider Templates table
 CREATE TABLE IF NOT EXISTS llm_provider_templates (
     id TEXT PRIMARY KEY,
-    handle TEXT NOT NULL UNIQUE,
+    gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id',
+    handle TEXT NOT NULL,
     configuration TEXT NOT NULL,
     created_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
-    updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP
+    updated_at TIMESTAMPTZ NOT NULL DEFAULT CURRENT_TIMESTAMP,
+    UNIQUE(handle, gateway_id)
 );
 
 CREATE INDEX IF NOT EXISTS idx_template_handle ON llm_provider_templates(handle);
+CREATE INDEX IF NOT EXISTS idx_llm_provider_templates_gateway_id ON llm_provider_templates(gateway_id);
 
 -- Table for API keys
 CREATE TABLE IF NOT EXISTS api_keys (
     id TEXT PRIMARY KEY,
+    gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id',
     name TEXT NOT NULL,
     api_key TEXT NOT NULL UNIQUE,
     masked_api_key TEXT NOT NULL,
@@ -78,7 +87,7 @@ CREATE TABLE IF NOT EXISTS api_keys (
     index_key TEXT NULL,
     display_name TEXT NOT NULL DEFAULT '',
     FOREIGN KEY (apiId) REFERENCES deployments(id) ON DELETE CASCADE,
-    UNIQUE (apiId, name)
+    UNIQUE (apiId, name, gateway_id)
 );
 
 CREATE INDEX IF NOT EXISTS idx_api_key ON api_keys(api_key);
@@ -89,10 +98,83 @@ CREATE INDEX IF NOT EXISTS idx_created_by ON api_keys(created_by);
 CREATE INDEX IF NOT EXISTS idx_api_key_source ON api_keys(source);
 CREATE INDEX IF NOT EXISTS idx_api_key_external_ref ON api_keys(external_ref_id);
 CREATE INDEX IF NOT EXISTS idx_api_key_index_key ON api_keys(index_key);
+CREATE INDEX IF NOT EXISTS idx_api_keys_gateway_id ON api_keys(gateway_id);
 CREATE UNIQUE INDEX IF NOT EXISTS idx_unique_external_api_key
     ON api_keys(apiId, index_key)
     WHERE source = 'external' AND index_key IS NOT NULL;
 
+-- Migration-safe column additions for existing deployments
+ALTER TABLE deployments ADD COLUMN IF NOT EXISTS gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id';
+ALTER TABLE certificates ADD COLUMN IF NOT EXISTS gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id';
+ALTER TABLE llm_provider_templates ADD COLUMN IF NOT EXISTS gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id';
+ALTER TABLE api_keys ADD COLUMN IF NOT EXISTS gateway_id TEXT NOT NULL DEFAULT 'platform-gateway-id';
+
+ALTER TABLE deployments DROP CONSTRAINT IF EXISTS deployments_display_name_version_key;
+ALTER TABLE deployments DROP CONSTRAINT IF EXISTS deployments_handle_key;
+ALTER TABLE certificates DROP CONSTRAINT IF EXISTS certificates_name_key;
+ALTER TABLE llm_provider_templates DROP CONSTRAINT IF EXISTS llm_provider_templates_handle_key;
+ALTER TABLE api_keys DROP CONSTRAINT IF EXISTS api_keys_apiid_name_key;
+
+DO $$
+BEGIN
+    IF NOT EXISTS (
+        SELECT 1 FROM pg_constraint WHERE conname = 'deployments_display_name_version_gateway_id_key'
+    ) THEN
+        ALTER TABLE deployments
+            ADD CONSTRAINT deployments_display_name_version_gateway_id_key
+            UNIQUE (display_name, version, gateway_id);
+    END IF;
+END $$;
+
+DO $$
+BEGIN
+    IF NOT EXISTS (
+        SELECT 1 FROM pg_constraint WHERE conname = 'deployments_handle_gateway_id_key'
+    ) THEN
+        ALTER TABLE deployments
+            ADD CONSTRAINT deployments_handle_gateway_id_key
+            UNIQUE (handle, gateway_id);
+    END IF;
+END $$;
+
+DO $$
+BEGIN
+    IF NOT EXISTS (
+        SELECT 1 FROM pg_constraint WHERE conname = 'certificates_name_gateway_id_key'
+    ) THEN
+        ALTER TABLE certificates
+            ADD CONSTRAINT certificates_name_gateway_id_key
+            UNIQUE (name, gateway_id);
+    END IF;
+END $$;
+
+DO $$
+BEGIN
+    IF NOT EXISTS (
+        SELECT 1 FROM pg_constraint WHERE conname = 'llm_provider_templates_handle_gateway_id_key'
+    ) THEN
+        ALTER TABLE llm_provider_templates
+            ADD CONSTRAINT llm_provider_templates_handle_gateway_id_key
+            UNIQUE (handle, gateway_id);
+    END IF;
+END $$;
+
+DO $$
+BEGIN
+    IF NOT EXISTS (
+        SELECT 1 FROM pg_constraint WHERE conname = 'api_keys_apiid_name_gateway_id_key'
+    ) THEN
+        ALTER TABLE api_keys
+            ADD CONSTRAINT api_keys_apiid_name_gateway_id_key
+            UNIQUE (apiId, name, gateway_id);
+    END IF;
+END $$;
+
+CREATE INDEX IF NOT EXISTS idx_deployments_gateway_id ON deployments(gateway_id);
+CREATE INDEX IF NOT EXISTS idx_certificates_gateway_id ON certificates(gateway_id);
+CREATE INDEX IF NOT EXISTS idx_llm_provider_templates_gateway_id ON llm_provider_templates(gateway_id);
+CREATE INDEX IF NOT EXISTS idx_api_keys_gateway_id ON api_keys(gateway_id);
+
 -- Schema migration metadata
 CREATE TABLE IF NOT EXISTS schema_migrations (
     id INTEGER PRIMARY KEY,