config

package

v0.62.0 Latest Latest Go to latest Published: Nov 3, 2025 License: MIT Imports: 10 Imported by: 0

Documentation ¶

Index ¶

Variables
func LoadDatastoreType(dom fdomain.Domain, env string) (cfgdomain.DatastoreType, error)
func LoadEnvConfig(dom fdomain.Domain, env string) (*cfgenv.Config, error)
func LoadJiraConfig(dom fdomain.Domain) (*cfgjira.Config, error)
func LoadNetworks(env string, dom fdomain.Domain, lggr logger.Logger) (*cfgnet.Config, error)
type Config
- func Load(dom fdomain.Domain, env string, lggr logger.Logger) (*Config, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrJiraConfigNotFound = errors.New("no Jira configuration found in domain config")

ErrJiraConfigNotFound is returned when no JIRA configuration is found in the domain config.

Functions ¶

func LoadDatastoreType ¶ added in v0.61.0

func LoadDatastoreType(dom fdomain.Domain, env string) (cfgdomain.DatastoreType, error)

LoadDatastoreType retrieves the datastore type configuration for a given domain and environment. It loads the domain configuration file and extracts the datastore setting for the specified environment.

func LoadEnvConfig ¶

func LoadEnvConfig(dom fdomain.Domain, env string) (*cfgenv.Config, error)

LoadEnvConfig retrieves the environment configuration for a given domain and environment.

Loading strategy:

In CI environments: Loads configuration exclusively from environment variables set by the CI pipeline.
In local development: Loads configuration from a local config file specific to the domain and environment.

func LoadJiraConfig ¶ added in v0.51.0

func LoadJiraConfig(dom fdomain.Domain) (*cfgjira.Config, error)

LoadJiraConfig retrieves the JIRA configuration for a given domain.

func LoadNetworks ¶

func LoadNetworks(
	env string, dom fdomain.Domain, lggr logger.Logger,
) (*cfgnet.Config, error)

LoadNetworks retrieves the network configuration for the given domain and filters the networks according to the specified environment. This ensures that only networks relevant to the selected environment are accessible, minimizing the risk of accidental operations on unintended networks.

Types ¶

type Config ¶

type Config struct {
	// Networks contains blockchain network configurations loaded from YAML manifest files.
	// This includes chain selectors, RPC endpoints, and network-specific parameters
	// for all supported blockchain networks.
	Networks *cfgnet.Config

	// Env contains environment-specific configuration including credentials, API keys,
	// and deployment settings. This configuration varies between environments
	// (development, staging, production) and contains sensitive data.
	Env *cfgenv.Config

	// Jira contains JIRA integration configuration including connection details
	// and field mappings for using JIRA in resolvers.
	Jira *cfgjira.Config

	// DatastoreType specifies the type of datastore to use (either "file" or "catalog").
	DatastoreType cfgdomain.DatastoreType
}

Config aggregates all configuration required by the Chainlink Deployments (CLD) engine. It combines network-specific settings and environment-specific configuration to provide a complete runtime configuration for deployment operations.

func Load ¶

func Load(dom fdomain.Domain, env string, lggr logger.Logger) (*Config, error)

Load loads and consolidates all configuration required for a domain environment, including network configuration and environment-specific settings.n.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
domain
env
jira
network

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