config

Documentation

Index

• Constants
• func AddDevConfigPath(v *viper.Viper) error
• func GetDevConfigDir() (string, error)
• func GetDevMspDir() (string, error)
• func GetPath(key string) string
• func InitViper(v *viper.Viper, configName string) error
• func TranslatePath(base, p string) string
• func TranslatePathInPlace(base string, p *string)

Constants

const OfficialPath = "/etc/hyperledger/fabric"

Functions

func AddDevConfigPath

func AddDevConfigPath(v *viper.Viper) error

---------------------------------------------------------------------------------- AddDevConfigPath() ---------------------------------------------------------------------------------- Helper utility that automatically adds our DevConfigDir to the viper path ----------------------------------------------------------------------------------

func GetDevConfigDir

func GetDevConfigDir() (string, error)

---------------------------------------------------------------------------------- GetDevConfigDir() ---------------------------------------------------------------------------------- Returns the path to the default configuration that is maintained with the source tree. Only valid to call from a test/development context. ----------------------------------------------------------------------------------

func GetDevMspDir

func GetDevMspDir() (string, error)

---------------------------------------------------------------------------------- GetDevMspDir() ---------------------------------------------------------------------------------- Builds upon GetDevConfigDir to return the path to our sampleconfig/msp that is maintained with the source tree. Only valid to call from a test/development context. Runtime environment should use configuration elements such as

GetPath("peer.mspConfigDir")

----------------------------------------------------------------------------------

func GetPath

func GetPath(key string) string

---------------------------------------------------------------------------------- GetPath() ---------------------------------------------------------------------------------- GetPath allows configuration strings that specify a (config-file) relative path

For example: Assume our config is located in /etc/hyperledger/fabric/core.yaml with a key "msp.configPath" = "msp/config.yaml".

This function will return:

GetPath("msp.configPath") -> /etc/hyperledger/fabric/msp/config.yaml

----------------------------------------------------------------------------------

func InitViper

func InitViper(v *viper.Viper, configName string) error

---------------------------------------------------------------------------------- InitViper() ---------------------------------------------------------------------------------- Performs basic initialization of our viper-based configuration layer. Primary thrust is to establish the paths that should be consulted to find the configuration we need. If v == nil, we will initialize the global Viper instance ----------------------------------------------------------------------------------

func TranslatePath

func TranslatePath(base, p string) string

---------------------------------------------------------------------------------- TranslatePath() ---------------------------------------------------------------------------------- Translates a relative path into a fully qualified path relative to the config file that specified it. Absolute paths are passed unscathed. ----------------------------------------------------------------------------------

func TranslatePathInPlace

func TranslatePathInPlace(base string, p *string)

---------------------------------------------------------------------------------- TranslatePathInPlace() ---------------------------------------------------------------------------------- Translates a relative path into a fully qualified path in-place (updating the pointer) relative to the config file that specified it. Absolute paths are passed unscathed. ----------------------------------------------------------------------------------