bootstrap

Documentation

Overview

Package bootstrap implements the functions, types, and interfaces for the module.

Package bootstrap implements the functions, types, and interfaces for the module.

Index

• func LoadBootstrapConfig(bootstrapPath string) (*bootstrapv1.Bootstrap, error)
• func LoadConfig(bootstrapPath string, opts ...Option) (interfaces.StructuredConfig, error)
• func New(bootstrapPath string, opts ...Option) (interfaces.Bootstrapper, error)
• type ComponentFactory
• type ConfigLoadOptions
  • func FromConfigLoadOptions(opts ...Option) *ConfigLoadOptions
• type ConfigTransformFunc
  • func (f ConfigTransformFunc) Transform(config kratosconfig.Config) (interfaces.Config, error)
• type ConfigTransformer
• type Option
  • func WithAppInfo(info *interfaces.AppInfo) Option
  • func WithComponent(key string, factory ComponentFactory) Option
  • func WithConfig(cfg interfaces.Config) Option
  • func WithConfigTransformer(transformer ConfigTransformer) Option
  • func WithDefaultPaths(paths map[string]string) Option
• type Options
  • func FromOptions(opts ...Option) *Options

Functions

func LoadBootstrapConfig

func LoadBootstrapConfig(bootstrapPath string) (*bootstrapv1.Bootstrap, error)

LoadBootstrapConfig loads the bootstrapv1.Bootstrap definition from a local bootstrap configuration file. This function is the first step in the configuration process. The temporary config used to load the sources is closed internally.

func LoadConfig

func LoadConfig(bootstrapPath string, opts ...Option) (interfaces.StructuredConfig, error)

LoadConfig creates a new configuration decoder instance. It orchestrates the entire configuration decoding process, following a clear, layered approach.

func New

func New(bootstrapPath string, opts ...Option) (interfaces.Bootstrapper, error)

New creates a new component provider, which is the main entry point for application startup. It orchestrates the entire process of configuration loading and component initialization. It now returns the interfaces.Bootstrapper interface.

Types

type ComponentFactory

type ComponentFactory = interfaces.ComponentFactory

ComponentFactory is a function that creates a component instance. It receives the configuration decoder and the component provider, allowing for configuration-driven instantiation and dependency resolution. This is an alias for interfaces.ComponentFactoryFunc for consistency.

type ConfigLoadOptions

type ConfigLoadOptions struct {
	// contains filtered or unexported fields
}

ConfigLoadOptions holds configuration for the LoadConfig function.

func FromConfigLoadOptions

func FromConfigLoadOptions(opts ...Option) *ConfigLoadOptions

type ConfigTransformFunc

type ConfigTransformFunc func(kratosconfig.Config) (interfaces.Config, error)

ConfigTransformFunc is a function type that implements the ConfigTransformer interface.

func (ConfigTransformFunc) Transform

func (f ConfigTransformFunc) Transform(config kratosconfig.Config) (interfaces.Config, error)

Transform implements the ConfigTransformer interface for ConfigTransformFunc.

type ConfigTransformer

type ConfigTransformer interface {
	Transform(interfaces.Config) (interfaces.StructuredConfig, error)
}

ConfigTransformer defines an interface for custom transformation of kratosconfig.Config to interfaces.Config.

type Option

type Option = options.Option

Option configures the New function.

func WithAppInfo

func WithAppInfo(info *interfaces.AppInfo) Option

WithAppInfo provides the application's metadata to the provider. This is a required option for New.

func WithComponent

func WithComponent(key string, factory ComponentFactory) Option

WithComponent registers a component factory to be used during bootstrap.

func WithConfig

func WithConfig(cfg interfaces.Config) Option

WithConfig allows providing a custom interfaces.Config implementation. WithCond this option is used, LoadConfig will return the provided config directly, bypassing the default Kratos config creation and file loading.

func WithConfigTransformer

func WithConfigTransformer(transformer ConfigTransformer) Option

WithConfigTransformer allows providing an object that implements the ConfigTransformer interface, or a function of type ConfigTransformFunc. This provides a flexible way to customize the creation of interfaces.Config from kratosconfig.Config.

func WithDefaultPaths

func WithDefaultPaths(paths map[string]string) Option

WithDefaultPaths provides a default path map for components. This map is used as a base and can be overridden by paths defined in the bootstrap file.

type Options

type Options struct {
	// contains filtered or unexported fields
}

Options holds configuration for the New function.

func FromOptions

func FromOptions(opts ...Option) *Options