bootstrap

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.

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

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 ...SaveOption) error
• type Bootstrap
  • func DefaultBootstrap() *Bootstrap
  • func New(dir, path string) *Bootstrap
  • func WithFlags(name string, version string) *Bootstrap
  • func (b *Bootstrap) ID() string
  • func (b *Bootstrap) Metadata() map[string]string
  • func (b *Bootstrap) ServiceID() string
  • func (b *Bootstrap) ServiceName() string
  • func (b *Bootstrap) SetFlags(name, version string)
  • func (b *Bootstrap) StartTime() time.Time
  • func (b *Bootstrap) Version() string
  • func (b *Bootstrap) WorkPath() string
• type Flags
  • func DefaultFlags() Flags
  • func NewFlags(name string, version string) Flags
  • func (f Flags) ServiceID() string
• type Option
  • func WithEnvPrefix(prefix string) Option
• type Options
• type SaveOption

Constants

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

Constants for default paths and environment

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

Variables

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

func RandomID() string

func SaveConfig

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

SaveConfig saves the configuration data to the specified file path.

Types

type Bootstrap

type Bootstrap struct {
	Flags      Flags
	WorkDir    string
	ConfigPath string
	Env        string
	Daemon     bool
}

Bootstrap struct to hold bootstrap information

func DefaultBootstrap

func DefaultBootstrap() *Bootstrap

DefaultBootstrap returns a default bootstrap

func New

func New(dir, path string) *Bootstrap

New returns a new bootstrap

func WithFlags

func WithFlags(name string, version string) *Bootstrap

func (*Bootstrap) ID

func (b *Bootstrap) ID() string

ID returns the ID

func (*Bootstrap) Metadata

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

Metadata returns the metadata

func (*Bootstrap) ServiceID

func (b *Bootstrap) ServiceID() string

ServiceID returns the service ID

func (*Bootstrap) ServiceName

func (b *Bootstrap) ServiceName() string

ServiceName returns the service name

func (*Bootstrap) SetFlags

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

SetFlags sets the flags for the bootstrap

func (*Bootstrap) StartTime

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

StartTime returns the start time

func (*Bootstrap) Version

func (b *Bootstrap) Version() string

Version returns the version

func (*Bootstrap) WorkPath

func (b *Bootstrap) WorkPath() string

WorkPath returns the work path

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 Option

type Option = func(option *Options)

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

func WithEnvPrefix

func WithEnvPrefix(prefix string) Option

type Options

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

type SaveOption

type SaveOption = func(*protojson.MarshalOptions)

SaveOption represents an option for saving configuration data.