config

Nov 4, 2023

Changes in this version

type APIOptions

+ AllowedOrigins []string

+ CORSEnabled bool

Oct 29, 2023

Changes in this version

type APIOptions

+ LibP2P LibP2PAPIOptions

+ type LibP2PAPIOptions struct

+ Announce bool

+ BootstrapServers []string

+ ConnectTimeout time.Duration

+ Enabled bool

+ LocalAddrs []string

+ Rendezvous string

+ func (l *LibP2PAPIOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (l LibP2PAPIOptions) Validate() error

type MeshOptions

+ JoinAddresses []string

+ JoinMultiaddrs []string

type ServiceOptions

+ func (o *ServiceOptions) NewServerOptions(ctx context.Context) (grpc.ServerOption, error)

Oct 13, 2023

Changes in this version

type BootstrapOptions

+ IPv6Network string

Oct 12, 2023

Changes in this version

type MeshDNSOptions

+ IncludeSystemResolvers bool

Oct 12, 2023

Changes in this version

type WireGuardOptions

+ func (o *WireGuardOptions) SetKey(key crypto.PrivateKey)

Oct 12, 2023

Changes in this version

type WireGuardOptions

+ DisableFullTunnel bool

Oct 11, 2023

Changes in this version

+ type APIRegistrationOptions struct

+ BuildInfo version.BuildInfo

+ Description string

+ Features []*v1.FeaturePort

+ Node meshnode.Node

+ Server *services.Server

+ type IDAuthOptions struct

+ Alias string

+ Enabled bool

+ Registrar string

+ func (o *IDAuthOptions) IsEmpty() bool

+ type RegistrarOptions struct

+ Enabled bool

+ IDAuth idauth.Config

+ Private bool

+ func NewRegistrarOptions() RegistrarOptions

+ func (r *RegistrarOptions) BindFlags(prefix string, fl *pflag.FlagSet)

type ServiceOptions

+ Registrar RegistrarOptions

Oct 10, 2023

Changes in this version

type Config

+ func (o *Config) NewClientCredentials(ctx context.Context, key crypto.PrivateKey) ([]grpc.DialOption, error)

type PluginOptions

+ func (o *PluginOptions) NewPluginSet(ctx context.Context) (map[string]plugins.Plugin, error)

Oct 9, 2023

Changes in this version

type APIOptions

+ MTLS bool

+ MTLSClientCAFile string

+ func (a APIOptions) ListenPort() int

type AuthOptions

+ IDAuth bool

+ func (o *AuthOptions) MTLSEnabled() bool

type Config

+ func (o *Config) MTLSEnabled() bool

type MTLSOptions

+ func (o *MTLSOptions) Enabled() bool

type PluginOptions

+ func (o *PluginOptions) MTLSEnabled() bool

type ServiceOptions

+ func (o *ServiceOptions) NewFeatureSet(storage meshstorage.Provider, grpcPort int) []*v1.FeaturePort

+ func (o *ServiceOptions) NewServerTLSOptions(ctx context.Context) (grpc.ServerOption, error)

+ func (o *ServiceOptions) NewServiceOptions(ctx context.Context, conn meshnode.Node) (conf services.Options, err error)

+ func (o *ServiceOptions) RegisterAPIs(ctx context.Context, conn meshnode.Node, srv *services.Server, ...) error

type WireGuardOptions

+ func (o *WireGuardOptions) LoadKey(ctx context.Context) (crypto.PrivateKey, error)

Oct 8, 2023

Changes in this version

type APIOptions

+ func NewInsecureAPIOptions() APIOptions

type AuthOptions

+ func NewAuthOptions() AuthOptions

+ func (o *AuthOptions) IsEmpty() bool

type BasicAuthOptions

+ func (o *BasicAuthOptions) IsEmpty() bool

type BridgeMeshDNSOptions

+ func NewBridgeMeshDNSOptions() BridgeMeshDNSOptions

type BridgeOptions

+ func NewBridgeOptions() BridgeOptions

type GlobalOptions

+ func NewGlobalOptions() GlobalOptions

type LDAPAuthOptions

+ func (o *LDAPAuthOptions) IsEmpty() bool

type MTLSOptions

+ func (o *MTLSOptions) IsEmpty() bool

type MeshDNSOptions

+ func (m MeshDNSOptions) Validate() error

type PluginOptions

+ func NewPluginOptions() PluginOptions

type ServiceOptions

+ func NewInsecureServiceOptions() ServiceOptions

type TLSOptions

+ func NewTLSOptions() TLSOptions

Oct 6, 2023

Changes in this version

type Config

+ func (o *Config) NewLeaveTransport(ctx context.Context, conn meshnode.Node) transport.LeaveRoundTripper

Oct 5, 2023

Changes in this version

type MeshOptions

+ DefaultIPAMStaticIPv4 map[string]string

+ DisableDefaultIPAM bool

Oct 2, 2023

Changes in this version

type GlobalOptions

+ LogFormat string

type StorageOptions

+ LogFormat string

type WireGuardOptions

+ Modprobe bool

Sep 26, 2023

Changes in this version

type Config

+ Storage StorageOptions

+ func (o *Config) IsStorageMember() bool

+ func (o *Config) NewStorageProvider(ctx context.Context, node meshnode.Node, force bool) (storage.Provider, error)

+ type ExternalStorageOptions struct

+ Config PluginMapConfig

+ Insecure bool

+ Server string

+ TLSCAData string

+ TLSCAFile string

+ TLSCertData string

+ TLSCertFile string

+ TLSKeyData string

+ TLSKeyFile string

+ TLSSkipVerify bool

+ func NewExternalStorageOptions() ExternalStorageOptions

+ func (o *ExternalStorageOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *ExternalStorageOptions) NewTLSConfig(ctx context.Context) (*tls.Config, error)

+ func (o *ExternalStorageOptions) Validate() error

type MeshOptions

+ RequestObserver bool

+ RequestVote bool

+ StoragePreferIPv6 bool

type RaftOptions

+ func (o *RaftOptions) ListenPort() int

+ func (o *RaftOptions) NewTransport(conn meshnode.Node) (transport.RaftTransport, error)

+ type StorageOptions struct

+ External ExternalStorageOptions

+ InMemory bool

+ LogLevel string

+ Path string

+ Provider string

+ Raft RaftOptions

+ func NewStorageOptions() StorageOptions

+ func (o *StorageOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *StorageOptions) ListenPort() int

+ func (o *StorageOptions) NewExternalStorageOptions(ctx context.Context, nodeID string) (extstorage.Options, error)

+ func (o *StorageOptions) NewExternalStorageProvider(ctx context.Context, nodeID string) (storage.Provider, error)

+ func (o *StorageOptions) NewPassthroughOptions(ctx context.Context, node meshnode.Node) passthroughstorage.Options

+ func (o *StorageOptions) NewRaftOptions(ctx context.Context, node meshnode.Node, force bool) (raftstorage.Options, error)

+ func (o *StorageOptions) NewRaftStorageProvider(ctx context.Context, node meshnode.Node, force bool) (storage.Provider, error)

+ func (o *StorageOptions) Validate(isMember bool) error

+ type StorageProvider string

+ const StorageProviderExternal

+ const StorageProviderPassThrough

+ const StorageProviderRaft

+ func (s StorageProvider) IsValid() bool

Sep 11, 2023

Changes in this version

+ var DefaultNodeID = func() string { ... }()

+ var ErrNoMesh = fmt.Errorf("no mesh configured")

+ func InterceptorLogger() logging.Logger

+ type APIOptions struct

+ AdminEnabled bool

+ DisableLeaderProxy bool

+ Disabled bool

+ Insecure bool

+ ListenAddress string

+ MeshEnabled bool

+ TLSCertData string

+ TLSCertFile string

+ TLSKeyData string

+ TLSKeyFile string

+ WebEnabled bool

+ func NewAPIOptions() APIOptions

+ func (a *APIOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (a *APIOptions) Validate() error

+ type AuthOptions struct

+ Basic BasicAuthOptions

+ LDAP LDAPAuthOptions

+ MTLS MTLSOptions

+ func (o *AuthOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (o *AuthOptions) Validate() error

+ type BasicAuthOptions struct

+ Password string

+ Username string

+ type BootstrapOptions struct

+ Admin string

+ DefaultNetworkPolicy string

+ DisableRBAC bool

+ ElectionTimeout time.Duration

+ Enabled bool

+ Force bool

+ IPv4Network string

+ MeshDomain string

+ Transport BootstrapTransportOptions

+ Voters []string

+ func NewBootstrapOptions() BootstrapOptions

+ func (o *BootstrapOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *BootstrapOptions) Validate() error

+ type BootstrapTransportOptions struct

+ PSK string

+ Rendezvous string

+ RendezvousLinger time.Duration

+ RendezvousNodes []string

+ ServerGRPCPorts map[string]int

+ TCPAdvertiseAddress string

+ TCPConnectTimeout time.Duration

+ TCPConnectionPool int

+ TCPListenAddress string

+ TCPServers map[string]string

+ func NewBootstrapTransportOptions() BootstrapTransportOptions

+ func (o *BootstrapTransportOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *BootstrapTransportOptions) Validate() error

+ type BridgeMeshDNSOptions struct

+ CacheSize int

+ DisableForwarding bool

+ EnableCompression bool

+ Enabled bool

+ Forwarders []string

+ ListenTCP string

+ ListenUDP string

+ RequestTimeout time.Duration

+ ReusePort int

+ SubscribeForwarders bool

+ func (m *BridgeMeshDNSOptions) BindFlags(fl *pflag.FlagSet)

+ func (m *BridgeMeshDNSOptions) Validate() error

+ type BridgeOptions struct

+ MeshDNS BridgeMeshDNSOptions

+ Meshes map[string]*Config

+ UseMeshDNS bool

+ func (b *BridgeOptions) BindFlags(fs *pflag.FlagSet)

+ func (b *BridgeOptions) Validate() error

+ type Config struct

+ Auth AuthOptions

+ Bootstrap BootstrapOptions

+ Bridge BridgeOptions

+ Discovery DiscoveryOptions

+ Global GlobalOptions

+ Mesh MeshOptions

+ Plugins PluginOptions

+ Raft RaftOptions

+ Services ServiceOptions

+ TLS TLSOptions

+ WireGuard WireGuardOptions

+ func NewDefaultConfig(nodeID string) Config

+ func NewInsecureConfig(nodeID string) *Config

+ func (c *Config) LoadFrom(fs *pflag.FlagSet, confFiles []string) error

+ func (c *Config) UnmarshalJSON(b []byte) error

+ func (c *Config) UnmarshalTOML(b []byte) error

+ func (c *Config) UnmarshalYAML(b []byte) error

+ func (c Config) MarshalJSON() ([]byte, error)

+ func (c Config) MarshalTOML() ([]byte, error)

+ func (c Config) MarshalYAML() ([]byte, error)

+ func (c Config) ToMapStructure() map[string]interface{}

+ func (o *Config) BindFlags(prefix string, fs *pflag.FlagSet) *Config

+ func (o *Config) IsRaftMember() bool

+ func (o *Config) LoadKey(ctx context.Context) (crypto.PrivateKey, error)

+ func (o *Config) NewBootstrapTransport(ctx context.Context, nodeID string, conn mesh.Node, host host.Host) (transport.BootstrapTransport, error)

+ func (o *Config) NewConnectOptions(ctx context.Context, conn mesh.Node, raft raft.Raft, host host.Host) (opts mesh.ConnectOptions, err error)

+ func (o *Config) NewDualStorage() (storage.DualStorage, error)

+ func (o *Config) NewFeatureSet() []*v1.FeaturePort

+ func (o *Config) NewJoinTransport(ctx context.Context, nodeID string, conn mesh.Node, host host.Host) (transport.JoinRoundTripper, error)

+ func (o *Config) NewMeshConfig(ctx context.Context, key crypto.PrivateKey) (conf mesh.Config, err error)

+ func (o *Config) NewPluginSet(ctx context.Context) (map[string]plugins.Plugin, error)

+ func (o *Config) NewRaftNode(ctx context.Context, conn mesh.Node) (raft.Raft, error)

+ func (o *Config) NewRaftStartOptions(conn mesh.Node) (opts raft.StartOptions, err error)

+ func (o *Config) NewRaftTransport(conn mesh.Node) (transport.RaftTransport, error)

+ func (o *Config) NewServerTLSOptions() (grpc.ServerOption, error)

+ func (o *Config) NewServiceOptions(ctx context.Context, conn mesh.Node) (conf services.Options, err error)

+ func (o *Config) NodeID() (string, error)

+ func (o *Config) RaftListenPort() int

+ func (o *Config) RegisterAPIs(ctx context.Context, conn mesh.Node, srv *services.Server) error

+ func (o *Config) ShallowCopy() *Config

+ func (o *Config) Validate() error

+ type DiscoveryOptions struct

+ Announce bool

+ AnnounceTTL time.Duration

+ BootstrapServers []string

+ ConnectTimeout time.Duration

+ Discover bool

+ LocalAddrs []string

+ Rendezvous string

+ func NewDiscoveryOptions(psk string, announce bool) DiscoveryOptions

+ func (o *DiscoveryOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *DiscoveryOptions) HostOptions(ctx context.Context, key crypto.PrivateKey) libp2p.HostOptions

+ func (o *DiscoveryOptions) Validate() error

+ type ExecutablePluginConfig struct

+ Path string

+ func (o *ExecutablePluginConfig) BindFlags(prefix string, fs *pflag.FlagSet)

+ type GlobalOptions struct

+ AllowRemoteDetection bool

+ DetectEndpoints bool

+ DetectIPv6 bool

+ DetectPrivateEndpoints bool

+ DisableIPv4 bool

+ DisableIPv6 bool

+ Endpoints []string

+ Insecure bool

+ InsecureSkipVerify bool

+ LogLevel string

+ MTLS bool

+ PrimaryEndpoint string

+ TLSCAFile string

+ TLSCertFile string

+ TLSClientCAFile string

+ TLSKeyFile string

+ VerifyChainOnly bool

+ func (global *GlobalOptions) ApplyGlobals(o *Config) (*Config, error)

+ func (o *GlobalOptions) BindFlags(fs *pflag.FlagSet)

+ func (o *GlobalOptions) Validate() error

+ type LDAPAuthOptions struct

+ Password string

+ Username string

+ type MTLSOptions struct

+ CertData string

+ CertFile string

+ KeyData string

+ KeyFile string

+ type MeshDNSOptions struct

+ CacheSize int

+ DisableForwarding bool

+ EnableCompression bool

+ Enabled bool

+ Forwarders []string

+ IPv6Only bool

+ ListenTCP string

+ ListenUDP string

+ RequestTimeout time.Duration

+ ReusePort int

+ SubscribeForwarders bool

+ func NewMeshDNSOptions() MeshDNSOptions

+ func (m *MeshDNSOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (m *MeshDNSOptions) ListenPort() uint16

+ type MeshOptions struct

+ DisableFeatureAdvertisement bool

+ DisableIPv4 bool

+ DisableIPv6 bool

+ GRPCAdvertisePort int

+ ICEPeers []string

+ JoinAddress string

+ LibP2PPeers []string

+ MaxJoinRetries int

+ MeshDNSAdvertisePort int

+ NodeID string

+ PrimaryEndpoint string

+ Routes []string

+ UseMeshDNS bool

+ ZoneAwarenessID string

+ func NewMeshOptions(nodeID string) MeshOptions

+ func (o *MeshOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *MeshOptions) Validate() error

+ type MetricsOptions struct

+ Enabled bool

+ ListenAddress string

+ Path string

+ func NewMetricsOptions() MetricsOptions

+ func (m *MetricsOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (m *MetricsOptions) ListenPort() uint16

+ func (m *MetricsOptions) Validate() error

+ type PluginConfig struct

+ Config PluginMapConfig

+ Exec ExecutablePluginConfig

+ Remote RemotePluginConfig

+ func (o *PluginConfig) BindFlags(prefix string, fs *pflag.FlagSet)

+ type PluginMapConfig map[string]any

+ func (p PluginMapConfig) Set(s string) error

+ func (p PluginMapConfig) String() string

+ func (p PluginMapConfig) Type() string

+ type PluginOptions struct

+ Configs map[string]PluginConfig

+ func (o *PluginOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ type RaftOptions struct

+ ApplyTimeout time.Duration

+ CommitTimeout time.Duration

+ ConnectionPoolCount int

+ ConnectionTimeout time.Duration

+ DataDir string

+ ElectionTimeout time.Duration

+ HeartbeatPurgeThreshold int

+ HeartbeatTimeout time.Duration

+ InMemory bool

+ LeaderLeaseTimeout time.Duration

+ ListenAddress string

+ LogLevel string

+ MaxAppendEntries int

+ ObserverChanBuffer int

+ PreferIPv6 bool

+ RequestObserver bool

+ RequestVote bool

+ SnapshotInterval time.Duration

+ SnapshotRetention uint64

+ SnapshotThreshold uint64

+ func NewRaftOptions() RaftOptions

+ func (o *RaftOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *RaftOptions) Validate() error

+ type RemotePluginConfig struct

+ Insecure bool

+ Server string

+ TLSCAFile string

+ TLSCertFile string

+ TLSKeyFile string

+ TLSSkipVerify bool

+ func (o *RemotePluginConfig) BindFlags(prefix string, fs *pflag.FlagSet)

+ type ServiceOptions struct

+ API APIOptions

+ MeshDNS MeshDNSOptions

+ Metrics MetricsOptions

+ TURN TURNOptions

+ WebRTC WebRTCOptions

+ func NewServiceOptions() ServiceOptions

+ func (s *ServiceOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (s *ServiceOptions) Validate() error

+ type TLSOptions struct

+ CAData string

+ CAFile string

+ Insecure bool

+ InsecureSkipVerify bool

+ VerifyChainOnly bool

+ func (o *TLSOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ type TURNOptions struct

+ Enabled bool

+ Endpoint string

+ ListenAddress string

+ PublicIP string

+ Realm string

+ TURNPortRange string

+ func NewTURNOptions() TURNOptions

+ func (t *TURNOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (t *TURNOptions) ListenPort() uint16

+ func (t *TURNOptions) Validate() error

+ type WebRTCOptions struct

+ Enabled bool

+ STUNServers []string

+ func NewWebRTCOptions() WebRTCOptions

+ func (w *WebRTCOptions) BindFlags(prefix string, fl *pflag.FlagSet)

+ func (w *WebRTCOptions) Validate() error

+ type WireGuardOptions struct

+ Endpoints []string

+ ForceInterfaceName bool

+ ForceTUN bool

+ InterfaceName string

+ KeyFile string

+ KeyRotationInterval time.Duration

+ ListenPort int

+ MTU int

+ Masquerade bool

+ PersistentKeepAlive time.Duration

+ RecordMetrics bool

+ RecordMetricsInterval time.Duration

+ func NewWireGuardOptions() WireGuardOptions

+ func (o *WireGuardOptions) BindFlags(prefix string, fs *pflag.FlagSet)

+ func (o *WireGuardOptions) Validate() error