Types Reference

This document describes the core types in aegis.

Node

type Node struct {
    ID          string
    Name        string
    Type        NodeType
    Address     string
    Services    []ServiceInfo
    Health      *HealthInfo
    PeerManager *PeerManager
    MeshServer  *MeshServer
    Topology    *Topology
    TLSConfig   *TLSConfig
}

NodeType

type NodeType string

const (
    NodeTypeGeneric NodeType = "generic"
)

Node classification. Applications can define custom types.

NodeInfo

type NodeInfo struct {
    ID        string
    Name      string
    Type      NodeType
    Address   string
    Services  []ServiceInfo
    JoinedAt  time.Time
    UpdatedAt time.Time
}

ServiceInfo

type ServiceInfo struct {
    Name    string
    Version string
}

PeerInfo

type PeerInfo struct {
    ID      string
    Type    NodeType
    Address string
}

Peer

type Peer struct {
    Info   PeerInfo
    Client MeshServiceClient
    Conn   *grpc.ClientConn
}

Topology

type Topology struct {
    Nodes     map[string]NodeInfo
    Version   int64
    UpdatedAt time.Time
}

Caller

type Caller struct {
    NodeID      string
    Certificate *x509.Certificate
}

HealthInfo

type HealthInfo struct {
    Status      HealthStatus
    LastChecked time.Time
    Message     string
    Error       string
}

HealthStatus

type HealthStatus string

const (
    HealthStatusHealthy   HealthStatus = "healthy"
    HealthStatusUnhealthy HealthStatus = "unhealthy"
    HealthStatusUnknown   HealthStatus = "unknown"
)

HealthChecker

type HealthChecker interface {
    Check(ctx context.Context) error
    Name() string
}

Interface for health check implementations.

TLSOptions

type TLSOptions struct {
    Source       CertificateSource
    CertFile     string
    KeyFile      string
    CAFile       string
    CertEnvVar   string
    KeyEnvVar    string
    CAEnvVar     string
    VaultPath    string
    VaultRole    string
    VerifyChain  bool
    AllowExpired bool
    RequiredSANs []string
}

CertificateSource

type CertificateSource string

const (
    CertSourceFile  CertificateSource = "file"
    CertSourceEnv   CertificateSource = "env"
    CertSourceVault CertificateSource = "vault"
)

TLSConfig

type TLSConfig struct {
    Certificate tls.Certificate
    CertPool    *x509.CertPool
    // internal fields
}

Methods:

• GetServerTLSConfig() *tls.Config — Returns server TLS config
• GetClientTLSConfig(serverName string) *tls.Config — Returns client TLS config

ServiceRegistrar

type ServiceRegistrar func(*grpc.Server)

Callback to register gRPC services on the server.

Error Sentinels

var (
    ErrNoProviders   = errors.New("no providers available for service")
    ErrNoTLSConfig   = errors.New("node has no TLS configuration")
    ErrNoPeerInfo    = errors.New("no peer info in context")
    ErrNoTLSInfo     = errors.New("no TLS info in peer")
    ErrNoCertificate = errors.New("no client certificate")
)

Next Steps

• API Reference — Function signatures
• Concepts — Mental models