config

package
v0.12.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 9, 2026 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package config constructs, loads, and redacts Funnel application configuration.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultConfig

func DefaultConfig() *schema.Config

DefaultConfig returns configuration with simple defaults.

func EmptyConfig

func EmptyConfig() *schema.Config

EmptyConfig allocates configuration sections without application defaults.

func Examples

func Examples() map[string]string

Examples returns the bundled configurations and scheduler templates by CLI name.

func HTTPAddress

func HTTPAddress(c *schema.Server) string

HTTPAddress returns the HTTP address based on HostName and HTTPPort

func Parse

func Parse(raw []byte, conf *schema.Config) error

Parse parses a YAML doc into the given Config instance.

func ParseFile

func ParseFile(relpath string, conf *schema.Config) error

ParseFile parses a Funnel config file, which is formatted in YAML, and returns a Config struct.

func RPCAddress

func RPCAddress(c *schema.Server) string

RPCAddress returns the RPC address based on HostName and RPCPort

func ResponseBytes

func ResponseBytes(s *schema.Server) int

ResponseBytes resolves the server's bounded gRPC response limit.

func Safe

func Safe(c *schema.Config) *schema.Config

Safe returns a copy of the config with sensitive fields redacted

func ToYaml

func ToYaml(c *schema.Config) ([]byte, error)

ToYaml formats the configuration into YAML and returns the bytes.

func ToYamlFile

func ToYamlFile(c *schema.Config, path string) error

ToYamlFile writes the configuration to a YAML file.

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL