Skip to content
SHC Docs

Nebula module

Source: modules/nebula/.

At a glance

Section titled “At a glance”
CLI—
Subcommands0
HTTP endpointssee the route reference
Events emitted—
Error codessee the error code reference
Service classesNebulaService
Cross-module depscluster

Source layout

Section titled “Source layout”
modules/nebula/
├── ca.go
├── errors.go
├── rotation.go
├── service.go
├── templates.go
├── types.go

Errors

Section titled “Errors”

Typed errors are catalogued in the error code reference with HTTP statuses and message templates.

Responsibilities

Section titled “Responsibilities”

The nebula module integrates Slack’s Nebula overlay mesh for cluster traffic. NebulaService manages the local nebula process (install, start, stop, reload), generates signed certificates using the cluster CA (see cluster/ca.go), and rotates them on schedule.

It is paired with cluster for mesh join tokens and with node for per-node enrollment. All cluster traffic that isn’t raft replication flows through Nebula.