config

Documentation

Index

• func ClientAPIHost() string
• func ClientAPIPort() uint16
• func DevstackEnvFile() string
• func DevstackGetShouldPrintInfo() bool
• func DevstackSetShouldPrintInfo()
• func ForEnvironment() types.BacalhauConfig
• func ForKey(key string, cfg interface{}) error
• func Get[T any](key string) (T, error)
• func GetAutoCertCachePath() string
• func GetBootstrapPeers() ([]multiaddr.Multiaddr, error)
• func GetClientID() (string, error)
• func GetClientPrivateKey() (*rsa.PrivateKey, error)
• func GetClientPublicKey() (*rsa.PublicKey, error)
• func GetClientPublicKeyString() (string, error)
• func GetDownloadURLRequestRetries() int
• func GetDownloadURLRequestTimeout() time.Duration
• func GetEventTracerPath() string
• func GetExecutorPluginsPath() string
• func GetLibp2pConfig() (types.Libp2pConfig, error)
• func GetLibp2pPrivKey() (libp2p_crypto.PrivKey, error)
• func GetLibp2pTracerPath() string
• func GetLogMode() logger.LogMode
• func GetRequesterCertificateSettings() (string, string)
• func GetStoragePath() string
• func GetStringMapString(key string) map[string]string
• func GetUpdateCheckFrequency() time.Duration
• func GetVolumeSizeRequestTimeout() time.Duration
• func Getenv(key string) string
• func Init(defaultConfig types.BacalhauConfig, path string, fileName, fileType string) (types.BacalhauConfig, error)
• func KeyAsEnvVar(key string) string
• func Load(path string, fileName, fileType string) (types.BacalhauConfig, error)
• func PreferredAddress() string
• func ReadConfig(fileName string) error
• func Reset()
• func ServerAPIHost() string
• func ServerAPIPort() uint16
• func ServerAutoCertDomain() string
• func Set(config types.BacalhauConfig) error
• func SetAutoCertCachePath(path string)
• func SetComputeStoragesPath(path string)
• func SetDefault(config types.BacalhauConfig) error
• func SetExecutorPluginPath(path string)
• func SetLibp2pKey(path string)
• func SetUpdateCheckStatePath(path string)
• func SetUserKey(path string)
• func SetVolumeSizeRequestTimeout(value time.Duration)
• func ShouldKeepStack() bool
• func WriteConfig(fileName string) error
• type DockerCredentials
  • func GetDockerCredentials() DockerCredentials
  • func (d *DockerCredentials) IsValid() bool
• type Environment
  • func GetConfigEnvironment() Environment
  • func (e Environment) IsKnown() bool
  • func (e Environment) String() string

Functions

func ClientAPIHost

func ClientAPIHost() string

func ClientAPIPort

func ClientAPIPort() uint16

func DevstackEnvFile

func DevstackEnvFile() string

func DevstackGetShouldPrintInfo

func DevstackGetShouldPrintInfo() bool

func DevstackSetShouldPrintInfo

func DevstackSetShouldPrintInfo()

func ForEnvironment

func ForEnvironment() types.BacalhauConfig

func ForKey

func ForKey(key string, cfg interface{}) error

ForKey unmarshals configuration values associated with a given key into the provided cfg structure. It uses unmarshalCompositeKey internally to handle composite keys, ensuring values spread across nested sub-keys are correctly populated into the cfg structure.

Parameters:

• key: The configuration key to retrieve values for.
• cfg: The structure into which the configuration values will be unmarshaled.

Returns:

• An error if any occurred during unmarshaling; otherwise, nil.

func Get

func Get[T any](key string) (T, error)

func GetAutoCertCachePath

func GetAutoCertCachePath() string

func GetBootstrapPeers

func GetBootstrapPeers() ([]multiaddr.Multiaddr, error)

func GetClientID

func GetClientID() (string, error)

func GetClientPrivateKey

func GetClientPrivateKey() (*rsa.PrivateKey, error)

func GetClientPublicKey

func GetClientPublicKey() (*rsa.PublicKey, error)

func GetClientPublicKeyString

func GetClientPublicKeyString() (string, error)

GetClientPublicKeyString returns a base64-encoding of the user's public ID key: NOTE: must be called after InitConfig() or system will panic.

func GetDownloadURLRequestRetries

func GetDownloadURLRequestRetries() int

func GetDownloadURLRequestTimeout

func GetDownloadURLRequestTimeout() time.Duration

func GetEventTracerPath

func GetEventTracerPath() string

func GetExecutorPluginsPath

func GetExecutorPluginsPath() string

func GetLibp2pConfig

func GetLibp2pConfig() (types.Libp2pConfig, error)

func GetLibp2pPrivKey

func GetLibp2pPrivKey() (libp2p_crypto.PrivKey, error)

func GetLibp2pTracerPath

func GetLibp2pTracerPath() string

func GetLogMode

func GetLogMode() logger.LogMode

func GetRequesterCertificateSettings

func GetRequesterCertificateSettings() (string, string)

func GetStoragePath

func GetStoragePath() string

func GetStringMapString

func GetStringMapString(key string) map[string]string

func GetUpdateCheckFrequency

func GetUpdateCheckFrequency() time.Duration

func GetVolumeSizeRequestTimeout

func GetVolumeSizeRequestTimeout() time.Duration

func Getenv

func Getenv(key string) string

Getenv wraps os.Getenv and retrieves the value of the environment variable named by the config key. It returns the value, which will be empty if the variable is not present.

func Init

func Init(defaultConfig types.BacalhauConfig, path string, fileName, fileType string) (types.BacalhauConfig, error)

func KeyAsEnvVar

func KeyAsEnvVar(key string) string

KeyAsEnvVar returns the environment variable corresponding to a config key

func Load

func Load(path string, fileName, fileType string) (types.BacalhauConfig, error)

func PreferredAddress

func PreferredAddress() string

PreferredAddress will allow for the specifying of the preferred address to listen on for cases where it is not clear, or where the address does not appear when using 0.0.0.0

func ReadConfig

func ReadConfig(fileName string) error

func Reset

func Reset()

Reset clears all configuration, useful for testing.

func ServerAPIHost

func ServerAPIHost() string

func ServerAPIPort

func ServerAPIPort() uint16

func ServerAutoCertDomain

func ServerAutoCertDomain() string

func Set

func Set(config types.BacalhauConfig) error

Set sets the configuration value. Will be used instead of values obtained via flags, config file, ENV, default. Useful for testing.

func SetAutoCertCachePath

func SetAutoCertCachePath(path string)

func SetComputeStoragesPath

func SetComputeStoragesPath(path string)

func SetDefault

func SetDefault(config types.BacalhauConfig) error

SetDefault sets the default value for the configuration. Default only used when no value is provided by the user via an explicit call to Set, flag, config file or ENV.

func SetExecutorPluginPath

func SetExecutorPluginPath(path string)

func SetLibp2pKey

func SetLibp2pKey(path string)

func SetUpdateCheckStatePath

func SetUpdateCheckStatePath(path string)

func SetUserKey

func SetUserKey(path string)

func SetVolumeSizeRequestTimeout

func SetVolumeSizeRequestTimeout(value time.Duration)

func ShouldKeepStack

func ShouldKeepStack() bool

func WriteConfig

func WriteConfig(fileName string) error

Types

type DockerCredentials

type DockerCredentials struct {
	Username string
	Password string
}

func GetDockerCredentials

func GetDockerCredentials() DockerCredentials

func (*DockerCredentials) IsValid

func (d *DockerCredentials) IsValid() bool

type Environment

type Environment string

const (
	// Known environments that are configured in ops/terraform:
	EnvironmentStaging Environment = "staging"
	EnvironmentProd    Environment = "production"
	EnvironmentDev     Environment = "development"
	EnvironmentTest    Environment = "test"
	EnvironmentLocal   Environment = "local"
)

func GetConfigEnvironment

func GetConfigEnvironment() Environment

func (Environment) IsKnown

func (e Environment) IsKnown() bool

func (Environment) String

func (e Environment) String() string