config

Documentation

Index

• Constants
• Variables
• type Values
  • func NewValuesFromContext(context *cli.Context) *Values

Constants

const (
	LogLevelFlag  = "log_level"
	LogFormatFlag = "log_format"

	AuthModeFlag     = "auth_mode"
	JWTSecretFlag    = "jwt_secret"
	RequireHTTPSFlag = "require_https"

	RestAPIPortFlag     = "api_port"
	ReplicationPortFlag = "replication_port"

	ReplicationFlag = "replication"
	SyncTimeoutFlag = "sync_timeout"

	ClusterDirectoryFlag = "cluster_dir"
	ClusterSizeFlag      = "cluster_size"

	NamespaceCapacityFlag = "namespace_capacity"
	DefaultTTLFlag        = "default_ttl"
	MaxTTLFlag            = "max_ttl"
	MinTTLFlag            = "min_ttl"

	K8sURLFlag   = "k8s_url"
	K8sTokenFlag = "k8s_token"

	EurekaURLsFlag = "eureka_url"

	FSCatalogFlag = "fs_catalog"

	StoreFlag         = "store"
	StoreAddrFlag     = "store_address"
	StorePasswordFlag = "store_password"
)

Flag names

Variables

var Flags = []cli.Flag{

	cli.StringFlag{
		Name:   LogLevelFlag,
		EnvVar: envVarFromFlag(LogLevelFlag),
		Value:  "info",
		Usage:  "Logging level. Supported values are: 'debug', 'info', 'warn', 'error', 'fatal', 'panic'",
	},

	cli.StringFlag{
		Name:   LogFormatFlag,
		EnvVar: envVarFromFlag(LogFormatFlag),
		Value:  "text",
		Usage:  "Logging format. Supported values are: 'text', 'json', 'logstash'",
	},

	cli.StringSliceFlag{
		Name:   AuthModeFlag,
		EnvVar: envVarFromFlag(AuthModeFlag),
		Usage:  "Authentication modes. Supported values are: 'trusted', 'jwt'",
	},

	cli.StringFlag{
		Name:   JWTSecretFlag,
		EnvVar: envVarFromFlag(JWTSecretFlag),
		Usage:  "Secret key for JWT authentication",
	},

	cli.BoolFlag{
		Name:   RequireHTTPSFlag,
		EnvVar: envVarFromFlag(RequireHTTPSFlag),
		Usage:  "Require clients to use HTTPS for API calls",
	},

	cli.IntFlag{
		Name:   RestAPIPortFlag,
		EnvVar: envVarFromFlag(RestAPIPortFlag),
		Value:  8080,
		Usage:  "REST API port number",
	},

	cli.IntFlag{
		Name:   ReplicationPortFlag,
		EnvVar: envVarFromFlag(ReplicationPortFlag),
		Value:  6100,
		Usage:  "Replication port number",
	},

	cli.BoolFlag{
		Name:   ReplicationFlag,
		EnvVar: envVarFromFlag(ReplicationFlag),
		Usage:  "Enable replication",
	},

	cli.DurationFlag{
		Name:   SyncTimeoutFlag,
		EnvVar: envVarFromFlag(SyncTimeoutFlag),
		Value:  30 * time.Second,
		Usage:  "Registry timeout for establishing peer synchronization connection",
	},

	cli.StringFlag{
		Name:   ClusterDirectoryFlag,
		EnvVar: envVarFromFlag(ClusterDirectoryFlag),
		Value:  cluster.DefaultDirectory,
		Usage:  "Filesystem directory for cluster membership",
	},

	cli.IntFlag{
		Name:   ClusterSizeFlag,
		EnvVar: envVarFromFlag(ClusterSizeFlag),
		Value:  0,
		Usage:  "Cluster minimal healthy size",
	},

	cli.DurationFlag{
		Name:   DefaultTTLFlag,
		EnvVar: envVarFromFlag(DefaultTTLFlag),
		Value:  30 * time.Second,
		Usage:  "Registry default TTL",
	},

	cli.DurationFlag{
		Name:   MaxTTLFlag,
		EnvVar: envVarFromFlag(MaxTTLFlag),
		Value:  10 * time.Minute,
		Usage:  "Registry maximum TTL",
	},

	cli.DurationFlag{
		Name:   MinTTLFlag,
		EnvVar: envVarFromFlag(MinTTLFlag),
		Value:  10 * time.Second,
		Usage:  "Registry minimum TTL",
	},

	cli.IntFlag{
		Name:   NamespaceCapacityFlag,
		EnvVar: envVarFromFlag(NamespaceCapacityFlag),
		Value:  -1,
		Usage:  "Registry namespace capacity, value of -1 indicates no capacity limit",
	},

	cli.StringFlag{
		Name:   K8sURLFlag,
		EnvVar: envVarFromFlag(K8sURLFlag),
		Usage:  "Enable kubernetes catalog and specify the kubernetes API server URL",
	},

	cli.StringFlag{
		Name:   K8sTokenFlag,
		EnvVar: envVarFromFlag(K8sTokenFlag),
		Usage:  "Kubernetes token API",
	},

	cli.StringSliceFlag{
		Name:   EurekaURLsFlag,
		EnvVar: envVarFromFlag(EurekaURLsFlag),
		Usage:  "Enable eureka catalog and specify the eureka API server URLs",
	},

	cli.StringFlag{
		Name:   FSCatalogFlag,
		EnvVar: envVarFromFlag(FSCatalogFlag),
		Usage:  "Enable FileSystem catalog and specify the name of the data file",
	},

	cli.StringFlag{
		Name:   StoreFlag,
		EnvVar: envVarFromFlag(StoreFlag),
		Value:  "inmem",
		Usage:  "Backing store. Supported values are: 'inmem', 'redis'",
	},

	cli.StringFlag{
		Name:   StoreAddrFlag,
		EnvVar: envVarFromFlag(StoreAddrFlag),
		Value:  "",
		Usage:  "Store address",
	},
	cli.StringFlag{
		Name:   StorePasswordFlag,
		EnvVar: envVarFromFlag(StorePasswordFlag),
		Value:  "",
		Usage:  "Store password",
	},
}

Flags represents the set of supported flags

Types

type Values

type Values struct {
	LogLevel  string
	LogFormat string

	AuthModes    []string
	JWTSecret    string
	RequireHTTPS bool

	APIPort         uint16
	ReplicationPort uint16

	Replication bool
	SyncTimeout time.Duration

	ClusterDirectory string
	ClusterSize      int

	NamespaceCapacity int
	DefaultTTL        time.Duration
	MaxTTL            time.Duration
	MinTTL            time.Duration

	K8sURL   string
	K8sToken string

	EurekaURLs []string

	FSCatalog string

	Store         string
	StoreAddr     string
	StorePassword string
}

Values holds the actual configuration values used for the registry server

func NewValuesFromContext

func NewValuesFromContext(context *cli.Context) *Values

NewValuesFromContext creates a Config instance from the given CLI context