domain

package
v0.115.1 Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BinaryConfig added in v0.115.1

type BinaryConfig struct {
	Provider BinaryProvider `mapstructure:"provider" yaml:"provider,omitempty"`
	Version  string         `mapstructure:"version" yaml:"version,omitempty"`
}

BinaryConfig represents the optional domain binary configuration. When provider is "s3", bucket, prefix, auth, and object paths are managed internally by CLD and are not configurable per domain. The binary name is derived from the domain key. When omitted from domain.yaml, defaults are applied during Load.

func DefaultBinaryConfig added in v0.115.1

func DefaultBinaryConfig() *BinaryConfig

DefaultBinaryConfig returns the default binary configuration used when the binary section is omitted from domain.yaml.

type BinaryProvider added in v0.115.1

type BinaryProvider string

BinaryProvider identifies how a domain binary should be resolved.

const (
	// BinaryProviderSource builds the domain binary from source.
	BinaryProviderSource BinaryProvider = "source"
	// BinaryProviderS3 downloads the domain binary from the CLD-managed S3 bucket.
	BinaryProviderS3 BinaryProvider = "s3"

	// DefaultBinaryVersion is used when binary.version is not specified.
	DefaultBinaryVersion = "latest"
)

func (BinaryProvider) IsValid added in v0.115.1

func (p BinaryProvider) IsValid() bool

IsValid reports whether the binary provider is supported.

type CREConfig added in v0.88.0

type CREConfig struct {
	Enabled           bool                       `mapstructure:"enabled" yaml:"enabled"`
	DefaultRegistries []cre.ContextRegistryEntry `mapstructure:"default_registries" yaml:"default_registries,omitempty"`
}

CREConfig represents the CRE (Chainlink Runtime Environment) configuration for a domain.

type DatastoreType added in v0.60.0

type DatastoreType string

DatastoreType represents the type of datastore to use for persisting deployment data.

const (
	// DatastoreTypeFile indicates data should be persisted to local JSON files (default behavior).
	DatastoreTypeFile DatastoreType = "file"
	// DatastoreTypeCatalog indicates data should be persisted to the remote catalog service.
	DatastoreTypeCatalog DatastoreType = "catalog"
	// DatastoreTypeAll indicates data should be persisted to both local JSON files and the remote catalog service.
	// This is useful to keep backward compatibility during the transition period from file-based to remote catalog.
	DatastoreTypeAll DatastoreType = "all"
)

func (DatastoreType) IsValid added in v0.60.0

func (d DatastoreType) IsValid() bool

IsValid checks if the DatastoreType is a valid value.

func (DatastoreType) String added in v0.60.0

func (d DatastoreType) String() string

String returns the string representation of the DatastoreType.

type DomainConfig

type DomainConfig struct {
	Environments map[string]Environment `mapstructure:"environments" yaml:"environments"`
	Jira         *jira.Config           `mapstructure:"jira" yaml:"jira"`
	Binary       *BinaryConfig          `mapstructure:"binary" yaml:"binary,omitempty"`
}

DomainConfig represents the parsed and validated domain configuration.

func Load

func Load(filePath string) (*DomainConfig, error)

Load loads domain configuration from a YAML file.

type Environment

type Environment struct {
	NetworkTypes []string      `mapstructure:"network_types" yaml:"network_types"`
	Datastore    DatastoreType `mapstructure:"datastore" yaml:"datastore"`
	CRE          *CREConfig    `mapstructure:"cre" yaml:"cre,omitempty"`
}

Environment represents a single environment configuration.

Jump to

Keyboard shortcuts

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