DigitalOcean Load Balancer

Deploys a managed regional load balancer on DigitalOcean with configurable forwarding rules, health checks, sticky sessions, and backend targeting via Droplet IDs or tags. The component provisions the load balancer inside a VPC for private-network communication with backend Droplets.

What Gets Created

When you deploy a DigitalOceanLoadBalancer resource, OpenMCF provisions:

• Load Balancer -- a digitalocean_loadbalancer resource in the specified region and VPC, with one or more forwarding rules that define how traffic is routed from the load balancer to backend Droplets
• Forwarding Rules -- each rule maps an entry port/protocol on the load balancer to a target port/protocol on the backend, with optional TLS certificate for HTTPS termination
• Health Check -- created only when healthCheck is specified, probes backend Droplets at a configurable interval to determine availability
• Sticky Sessions -- created only when enableStickySessions is true, configures cookie-based session affinity so repeated requests from the same client reach the same Droplet

Prerequisites

• DigitalOcean credentials configured via environment variables or OpenMCF provider config
• A DigitalOcean VPC in the target region (can reference a DigitalOceanVpc resource via valueFrom)
• At least one backend target -- either a list of Droplet IDs or a Droplet tag that matches running Droplets

Quick Start

Create a file lb.yaml:

apiVersion: digital-ocean.openmcf.org/v1
kind: DigitalOceanLoadBalancer
metadata:
  name: my-lb
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.DigitalOceanLoadBalancer.my-lb
spec:
  loadBalancerName: my-lb
  region: nyc3
  vpc:
    value: "vpc-uuid-here"
  forwardingRules:
    - entryPort: 80
      entryProtocol: http
      targetPort: 80
      targetProtocol: http
  dropletTag: web-dev

Deploy:

openmcf apply -f lb.yaml

This creates an HTTP load balancer in the NYC3 region that routes port 80 traffic to all Droplets tagged web-dev within the specified VPC.

Configuration Reference

Required Fields

Forwarding Rule Fields

Each entry in forwardingRules contains:

Optional Fields

Health Check Fields

When healthCheck is specified:

Examples

HTTP Load Balancer

A basic HTTP load balancer for development or testing, using tag-based backend targeting:

apiVersion: digital-ocean.openmcf.org/v1
kind: DigitalOceanLoadBalancer
metadata:
  name: dev-lb
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: dev.DigitalOceanLoadBalancer.dev-lb
spec:
  loadBalancerName: dev-lb
  region: nyc3
  vpc:
    value: "vpc-dev-uuid"
  forwardingRules:
    - entryPort: 80
      entryProtocol: http
      targetPort: 80
      targetProtocol: http
  dropletTag: web-dev

HTTPS with TLS Certificate

A production load balancer that terminates TLS at the load balancer and forwards HTTP to backend Droplets. The certificateName field references a TLS certificate already uploaded to DigitalOcean (use the certificate name, not its ID):

apiVersion: digital-ocean.openmcf.org/v1
kind: DigitalOceanLoadBalancer
metadata:
  name: prod-web-lb
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: prod.DigitalOceanLoadBalancer.prod-web-lb
spec:
  loadBalancerName: prod-web-lb
  region: sfo3
  vpc:
    value: "vpc-prod-uuid"
  forwardingRules:
    - entryPort: 443
      entryProtocol: https
      targetPort: 80
      targetProtocol: http
      certificateName: my-le-cert
  dropletTag: web-prod
  healthCheck:
    port: 80
    protocol: http
    path: "/healthz"

Full-Featured with Health Check, Sticky Sessions, and VPC Reference

Production configuration using a VPC foreign key reference, explicit health check tuning, sticky sessions, and multiple forwarding rules:

apiVersion: digital-ocean.openmcf.org/v1
kind: DigitalOceanLoadBalancer
metadata:
  name: full-lb
  labels:
    openmcf.org/provisioner: pulumi
    pulumi.openmcf.org/organization: my-org
    pulumi.openmcf.org/project: my-project
    pulumi.openmcf.org/stack.name: prod.DigitalOceanLoadBalancer.full-lb
spec:
  loadBalancerName: full-lb
  region: fra1
  vpc:
    valueFrom:
      kind: DigitalOceanVpc
      name: prod-vpc
      field: status.outputs.vpc_id
  forwardingRules:
    - entryPort: 443
      entryProtocol: https
      targetPort: 8080
      targetProtocol: http
      certificateName: prod-cert
    - entryPort: 80
      entryProtocol: http
      targetPort: 8080
      targetProtocol: http
  healthCheck:
    port: 8080
    protocol: http
    path: "/health"
    checkIntervalSec: 15
  dropletTag: app-prod
  enableStickySessions: true

Stack Outputs

After deployment, the following outputs are available in status.outputs:

Related Components

• DigitalOceanVpc -- provides the VPC for load balancer placement
• DigitalOceanDroplet -- backend compute instances that receive traffic from the load balancer
• DigitalOceanKubernetesCluster -- managed Kubernetes cluster whose services can be exposed through load balancers
• DigitalOceanFirewall -- controls network access to backend Droplets