Skip to Content
Engineering11 Documentation 🔥
BackendServer API PackagesControl Plane

Control Plane API

URL construction utilities for Control Plane infrastructure deployments.

What It Does

The Control Plane API provides helper methods for building service URLs in Control Plane deployments. It enables microservices to construct correct URLs for both external HTTPS and internal HTTP service-to-service communication.

Key Capabilities

  • External URL Building: HTTPS URLs for public service access
  • Internal URL Building: HTTP URLs for VCG-internal communication
  • Configuration Integration: GVC alias retrieval from config service
  • Environment Detection: Automatic Control Plane vs GCP detection

Main Component

Workflow Class

Static utility class with two methods:

static async buildUrl(serviceId: string): Promise<string>
// Returns: https://{serviceId}-{gvc-alias}.cpln.app
 
static buildInternalUrl(serviceId: string): string
// Returns: http://{serviceId}-{gvcName}.cpln.local:8080

Environment Variables

  • CPLN_GVC_ALIAS: External GVC alias for public URLs (or from config service GVC_ALIAS)
  • CPLN_GVC: Internal GVC name for internal URLs

URL Formats

External URLs

  • Format: https://{serviceId}-{gvc-alias}.cpln.app
  • Used for: Public API access, external service communication
  • Example: https://auth-rest-prod-alias.cpln.app

Internal URLs

  • Format: http://{serviceId}-{gvcName}.cpln.local:8080
  • Used for: VCG-internal service-to-service calls
  • Example: http://auth-rest-prod.cpln.local:8080

Common Use Cases

  • Inter-service communication in Control Plane
  • Task routing to microservices
  • IPC client URL construction
  • Service discovery in Control Plane environments

What Customers Don’t Have to Build

  • Control Plane URL formatting logic
  • GVC configuration management
  • Internal vs external URL distinction
  • Environment-aware service routing
  • Configuration service integration
Last updated on
ConfigurationDependency Injection