Make services advertise themselves01

FARP only registers an instance — and generates routes for it — when its discovery metadata advertises farp.enabled = true. The OpenAPI document is then fetched from farp.openapi.path (default /openapi.json). How you set that metadata depends on the backend:

• Kubernetes — carried on the Service/Pod metadata; filter with a label_selector.

• Consul — service Meta.

• mDNS — TXT records.

Instances without farp.enabled are discovered but skipped. See what a backend reports.

Enable FARP and pick a backend02

Set farp.enabled: true and list one or more backends under farp.discovery.backends. Each entry is tagged by type (mdns | dns | consul | kubernetes), has an enabled flag, and a backend-specific config.

farp:
  enabled: true
  watch_interval: 5s
  schema_cache_ttl: 5m
  discovery:
    backends:
      - type: kubernetes
        enabled: true
        config:
          namespace: default
          label_selector: "app.kubernetes.io/part-of=myapp"
          watch_interval: 10s
          use_endpoint_slices: true
          include_not_ready: false

farp:
  enabled: true
  watch_interval: 5s
  schema_cache_ttl: 5m
  discovery:
    backends:
      - type: mdns
        enabled: true
        config:
          service_type: _octopus._tcp
          domain: local.
          watch_interval: 30s
          query_timeout: 5s
          enable_ipv6: false

Validate and run03

octopus validate -c gateway.yaml
octopus serve -c gateway.yaml

A complete, validated configuration (Kubernetes backend):

gateway:
  listen: "0.0.0.0:8080"

farp:
  enabled: true
  watch_interval: 5s
  schema_cache_ttl: 5m
  discovery:
    backends:
      - type: kubernetes
        enabled: true
        config:
          namespace: default
          label_selector: "app.kubernetes.io/part-of=myapp"
          watch_interval: 10s
          use_endpoint_slices: true
          include_not_ready: false

Watch routes appear04

On each tick of watch_interval, Octopus polls every enabled backend, fetches the OpenAPI document of any newly advertised instance, and generates routes from it. Inspect the live route table through the admin dashboard (/admin/routes) or the Admin API. Scale a discovered Deployment up or down and the routes reconcile to match.