bootstrap

package

v0.1.58 Latest Latest Go to latest Published: Apr 29, 2025 License: MIT Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/origadmin/runtime

Links

Open Source Insights

Documentation ¶

Overview ¶

Package bootstrap is a package that provides the bootstrap information for the service.

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

Index ¶

Constants
Variables
func LoadLocalConfig(bs *Bootstrap, v any) error
func LoadSourceConfig(bootstrap *Bootstrap) (*configv1.SourceConfig, error)
func LoadSourceConfigFromPath(path string) (*configv1.SourceConfig, error)
func RandomID() string
func SaveConfig(path string, data any, opts ...MarshalOption) error
type Bootstrap
- func New() *Bootstrap
- func WithFlags(name string, version string) *Bootstrap
type Flags
- func DefaultFlags() Flags
- func NewFlags(name string, version string) Flags
- func (f Flags) ServiceID() string
type Loader
type MarshalOption
type Option
- func WithEnvPrefix(prefix string) Option
type Options

Constants ¶

View Source

const (
	DefaultConfigPath = "configs/config.toml"
	DefaultEnv        = "release"
	DefaultWorkDir    = "."
)

Constants for default paths and environment

View Source

const (
	DefaultServiceName = "origadmin.service.v1"
	DefaultVersion     = "v1.0.0"
)

Variables ¶

View Source

var (
	RandomSuffix = fmt.Sprintf("%08d", time.Now().UnixNano()%(1<<32))
)

Functions ¶

func LoadLocalConfig ¶

func LoadLocalConfig(bs *Bootstrap, v any) error

LoadLocalConfig loads the config file from the given path

func LoadSourceConfig ¶

func LoadSourceConfig(bootstrap *Bootstrap) (*configv1.SourceConfig, error)

LoadSourceConfig loads the config file from the given path

func LoadSourceConfigFromPath ¶

func LoadSourceConfigFromPath(path string) (*configv1.SourceConfig, error)

LoadSourceConfigFromPath loads the config file from the given path

func RandomID ¶ added in v0.0.8

func RandomID() string

func SaveConfig ¶ added in v0.0.2

func SaveConfig(path string, data any, opts ...MarshalOption) error

SaveConfig saves the configuration data to the specified file path.

Types ¶

type Bootstrap ¶

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

Bootstrap struct to hold bootstrap information

func New ¶

func New() *Bootstrap

New returns a new bootstrap

func WithFlags ¶ added in v0.0.2

func WithFlags(name string, version string) *Bootstrap

func (*Bootstrap) ConfigFilePath ¶ added in v0.1.57

func (b *Bootstrap) ConfigFilePath() string

func (*Bootstrap) ConfigPath ¶

func (b *Bootstrap) ConfigPath() string

func (*Bootstrap) Daemon ¶

func (b *Bootstrap) Daemon() bool

func (*Bootstrap) Env ¶

func (b *Bootstrap) Env() string

func (*Bootstrap) Metadata ¶

func (b *Bootstrap) Metadata() map[string]string

func (*Bootstrap) ServiceID ¶

func (b *Bootstrap) ServiceID() string

func (*Bootstrap) ServiceName ¶

func (b *Bootstrap) ServiceName() string

func (*Bootstrap) SetConfigPath ¶ added in v0.1.57

func (b *Bootstrap) SetConfigPath(configPath string)

func (*Bootstrap) SetDaemon ¶ added in v0.1.57

func (b *Bootstrap) SetDaemon(daemon bool)

func (*Bootstrap) SetEnv ¶ added in v0.1.57

func (b *Bootstrap) SetEnv(env string) error

func (*Bootstrap) SetMetadata ¶ added in v0.1.57

func (b *Bootstrap) SetMetadata(metadata map[string]string)

func (*Bootstrap) SetServiceID ¶ added in v0.1.57

func (b *Bootstrap) SetServiceID(serviceID string)

func (*Bootstrap) SetServiceInfo ¶ added in v0.1.57

func (b *Bootstrap) SetServiceInfo(name, version string)

func (*Bootstrap) SetServiceName ¶ added in v0.1.57

func (b *Bootstrap) SetServiceName(serviceName string)

func (*Bootstrap) SetStartTime ¶ added in v0.1.57

func (b *Bootstrap) SetStartTime(startTime time.Time)

func (*Bootstrap) SetVersion ¶ added in v0.1.57

func (b *Bootstrap) SetVersion(version string)

func (*Bootstrap) SetWorkDir ¶ added in v0.1.57

func (b *Bootstrap) SetWorkDir(workDir string)

func (*Bootstrap) StartTime ¶

func (b *Bootstrap) StartTime() time.Time

func (*Bootstrap) Version ¶

func (b *Bootstrap) Version() string

func (*Bootstrap) WorkDir ¶

func (b *Bootstrap) WorkDir() string

type Flags ¶

type Flags struct {
	ID          string
	Version     string
	ServiceName string
	StartTime   time.Time
	Metadata    map[string]string
}

Flags is a struct that holds the flags for the service

func DefaultFlags ¶

func DefaultFlags() Flags

DefaultFlags returns the default flags for the service

func NewFlags ¶

func NewFlags(name string, version string) Flags

NewFlags returns a new set of flags for the service

func (Flags) ServiceID ¶

func (f Flags) ServiceID() string

ServiceID returns the ID of the service

type Loader ¶ added in v0.1.57

type Loader interface {
	Load() (*configv1.SourceConfig, error)
	Reload() error
}

type MarshalOption ¶ added in v0.1.57

type MarshalOption = func(*protojson.MarshalOptions)

MarshalOption represents an option for saving configuration data.

type Option ¶ added in v0.1.0

type Option = func(option *Options)

Option is a function that takes a pointer to a Options struct and modifies it.

func WithEnvPrefix ¶ added in v0.1.0

func WithEnvPrefix(prefix string) Option

type Options ¶ added in v0.1.56

type Options struct {
	EnvPrefix string
	Selector  *selector.Options
	Customize *customize.Options
	Source    config.KOption
}

Source Files ¶

View all Source files

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