v1alpha1

Documentation

Index

• Constants
• func GetConfigByKind(kind string) (types.Config, error)
• type Config
  • func (c Config) GetAPIVersion() string
  • func (c Config) GetKind() string
• type WireGuardPeerConfig

Constants

const ApiVersion = "noisysockets.github.com/v1alpha1"

Functions

func GetConfigByKind

func GetConfigByKind(kind string) (types.Config, error)

Types

type Config

type Config struct {
	types.TypeMeta `yaml:",inline" mapstructure:",squash"`
	// Name is the hostname of this socket.
	Name string `yaml:"name" mapstructure:"name"`
	// ListenPort is an optional port on which to listen for incoming packets.
	ListenPort uint16 `yaml:"listenPort" mapstructure:"listenPort"`
	// PrivateKey is the private key for this socket.
	PrivateKey string `yaml:"privateKey" mapstructure:"privateKey"`
	// IPs is a list of IP addresses assigned to this socket.
	IPs []string `yaml:"ips" mapstructure:"ips"`
	// DefaultGatewayPeerName is the optional hostname of the peer to use as the default gateway for traffic.
	DefaultGatewayPeerName string `yaml:"defaultGatewayPeerName" mapstructure:"defaultGatewayPeerName"`
	// DNSServers is an optional list of DNS servers to use for host resolution.
	DNSServers []string `yaml:"dnsServers" mapstructure:"dnsServers"`
	// Peers is a list of known peers to which this socket can send and receive packets.
	Peers []WireGuardPeerConfig `yaml:"peers" mapstructure:"peers"`
}

Config is the configuration for a NoisySocket. It is analogous to the configuration for a WireGuard interface.

func (Config) GetAPIVersion

func (c Config) GetAPIVersion() string

func (Config) GetKind

func (c Config) GetKind() string

type WireGuardPeerConfig

type WireGuardPeerConfig struct {
	// Name is the hostname of the peer.
	Name string `yaml:"name" mapstructure:"name"`
	// PublicKey is the public key of the peer.
	PublicKey string `yaml:"publicKey" mapstructure:"publicKey"`
	// Endpoint is an optional endpoint to which the peer's packets should be sent.
	// If not specified, we will attempt to discover the peer's endpoint from its packets.
	Endpoint string `yaml:"endpoint" mapstructure:"endpoint"`
	// IPs is a list of IP addresses assigned to the peer.
	IPs []string `yaml:"ips" mapstructure:"ips"`
}

WireGuardPeerConfig is the configuration for a known peer.