api

Documentation

Overview

Package api defines RPC messages used to communicate with the runner module.

Index

• type Config
• type Notification
• type Server
• type Service

Types

type Config

type Config struct {
	LogLevel  *slog.Level `json:"log_level,omitempty"`
	AddSource *bool       `json:"log_add_source,omitempty"`
	Options   struct {
		Heartbeat *rpc.Duration `json:"heartbeat,omitempty"`
		// Module-level server definitions.
		Servers map[string]Server `json:"server,omitempty"`
	} `json:"options,omitempty"`
}

Config defines configuration options.

type Notification

type Notification struct {
	// UID is the destination UID.
	// If UID is set, the notify is forwarded.
	UID rpc.UID `json:"uid"`
	// Method is the JSON RPC method to call.
	Method string `json:"method"`
	// Params is the JSON RPC parameters for the call.
	Params map[string]any `json:"params,omitempty"`
	// From is the sender UID if not nil.
	// Otherwise the sender is the service's
	// UID.
	From *rpc.UID `json:"from,omitempty"`
}

Notification is the RPC parameter for a change call.

type Server

type Server struct {
	// Addr is the dashboard and dump server address.
	Addr string `json:"addr"`
	// Request is the CEL source for the REST end point.
	Request string `json:"request"`
	// Response is the CEL source to transform the response.
	Response string `json:"response"`

	// CertPEMBlock and KeyPEMBlock are the PEM-encoded
	// certificate and private key for the server. If
	// present the server will use TLS.
	CertPEMBlock *string `json:"cert_pem,omitempty"`
	KeyPEMBlock  *string `json:"key_pem,omitempty" private:""`
	// RootCA is the root certificate to use for mTLS
	// connections. If present the service will enforce
	// mTLS using this certificate authority to verify
	// client certificates. If set, CertPEMBlock and
	// KeyPEMBlock must also be set.
	RootCA *string `json:"ca_pem,omitempty"`
	// Insecure allows configuration of non-loopback
	// servers without mTLS.
	Insecure bool `json:"insecure"`
	// Private is the list of server configuration
	// fields to omit from system configuration state
	// requests. This should include "key_pem".
	Private []string `json:"private,omitempty"`
}

type Service

type Service struct {
	Name    string  `json:"name,omitempty"`
	Active  *bool   `json:"active,omitempty"`
	Serial  *string `json:"serial,omitempty"`
	Options struct {
		// Service-level server definition.
		Server Server `json:"server,omitempty"`
	} `json:"options,omitempty"`
}

Service defines service configuration options.