config

package
v1.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 10, 2021 License: Apache-2.0 Imports: 2 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetEnv added in v1.16.0

func GetEnv() []string

GetEnv fetches a list of known env variables for this extension. It is to be used by gookit, as it provides a list with all the environment variables an extension supports.

func StructMappings added in v1.16.0

func StructMappings(cfg *Config) []shared.EnvBinding

StructMappings binds a set of environment variables to a destination on cfg. Iterating over this set and editing the Destination value of a binding will alter the original value, as it is a pointer to its memory address. This lets us propagate changes easier.

Types

type Config

type Config struct {
	File          string        `ocisConfig:"file"`
	Log           shared.Log    `ocisConfig:"log"`
	Debug         Debug         `ocisConfig:"debug"`
	HTTP          HTTP          `ocisConfig:"http"`
	Server        Server        `ocisConfig:"server"`
	Tracing       Tracing       `ocisConfig:"tracing"`
	GraphExplorer GraphExplorer `ocisConfig:"graph_explorer"`

	Context    context.Context
	Supervised bool
}

Config combines all available configuration parts.

func DefaultConfig added in v1.16.0

func DefaultConfig() *Config

DefaultConfig provides with a working version of a config.

func New

func New() *Config

New initializes a new configuration with or without defaults.

type Debug

type Debug struct {
	Addr   string `ocisConfig:"addr"`
	Token  string `ocisConfig:"token"`
	Pprof  bool   `ocisConfig:"pprof"`
	Zpages bool   `ocisConfig:"zpages"`
}

Debug defines the available debug configuration.

type GraphExplorer

type GraphExplorer struct {
	ClientID     string `ocisConfig:"client_id"`
	Issuer       string `ocisConfig:"issuer"`
	GraphURLBase string `ocisConfig:"graph_url_base"`
	GraphURLPath string `ocisConfig:"graph_url_path"`
}

GraphExplorer defines the available graph-explorer configuration.

type HTTP

type HTTP struct {
	Addr      string `ocisConfig:"addr"`
	Root      string `ocisConfig:"root"`
	Namespace string `ocisConfig:"namespace"`
}

HTTP defines the available http configuration.

type Server

type Server struct {
	Version string `ocisConfig:"version"`
	Name    string `ocisConfig:"name"`
}

Server configures a server.

type Tracing

type Tracing struct {
	Enabled   bool   `ocisConfig:"enabled"`
	Type      string `ocisConfig:"type"`
	Endpoint  string `ocisConfig:"endpoint"`
	Collector string `ocisConfig:"collector"`
	Service   string `ocisConfig:"service"`
}

Tracing defines the available tracing configuration.

Jump to

Keyboard shortcuts

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